CVAT Documentation

• 1: Getting Started
• 1.1: CVAT Overview
• 1.2: Vocabulary
• 1.3: Shortcuts
• 2: Products
• 2.1: CVAT Online
• 2.2: CVAT Enterprise
• 2.3: CVAT Community
• 3: Workspace
• 3.1: Projects
• 3.2: Tasks
• 3.3: Jobs
• 3.4: Cloud storages
• 3.5: Attach cloud storage
• 3.6: Requests
• 3.7: Models
• 3.8: Bulk actions
• 3.9: Search
• 4: Account Management
• 4.1: Registration & account access
• 4.2: User roles
• 4.3: Organization
• 4.4: Subscription management
• 4.5: SSO configuration
• 4.6: Social auth configuration
• 5: Dataset Management
• 5.1: Dataset formats
• 5.1.1: CVAT for image
• 5.1.2: Datumaro
• 5.1.3: LabelMe
• 5.1.4: MOT
• 5.1.5: MOTS
• 5.1.6: COCO
• 5.1.7: COCO Keypoints
• 5.1.8: Pascal VOC
• 5.1.9: Segmentation Mask
• 5.1.10: Ultralytics YOLO
• 5.1.11: Ultralytics-YOLO-Classification
• 5.1.12: YOLO
• 5.1.13: ImageNet
• 5.1.14: Wider Face
• 5.1.15: CamVid
• 5.1.16: VGGFace2
• 5.1.17: Market-1501
• 5.1.18: ICDAR13/15
• 5.1.19: Open Images
• 5.1.20: Cityscapes
• 5.1.21: KITTI
• 5.1.22: LFW
• 5.2: Import annotations and data to CVAT
• 5.3: Export annotations and data from CVAT
• 5.4: Backup Task and Project
• 5.5: Dataset Manifest
• 5.6: Data preparation on the fly
• 6: Annotation
• 6.1: Editor
• 6.1.1: Menu and Navigation Bar
• 6.1.2: Workspace
• 6.1.3: Objects sidebar
• 6.1.4: Controls sidebar
• 6.1.5: Settings
• 6.1.6: 3D task workspace
• 6.2: Manual Annotation
• 6.2.1: Annotation modes
• 6.2.1.1: Single shape
• 6.2.1.2: Track mode
• 6.2.1.3: Attribute annotation mode
• 6.2.1.4: 3D object annotation
• 6.2.1.5: Annotation with tags
• 6.2.2: Annotation with shapes
• 6.2.2.1: Annotation with rectangles
• 6.2.2.2: Shape mode
• 6.2.2.3: Annotation with polygons
• 6.2.2.3.1: Manual drawing
• 6.2.2.3.2: Drawing using automatic borders
• 6.2.2.3.3: Edit polygon
• 6.2.2.3.4: Track mode with polygons
• 6.2.2.3.5: Creating masks
• 6.2.2.4: Annotation with polylines
• 6.2.2.5: Track mode
• 6.2.2.6: Annotation with points
• 6.2.2.6.1: Points in shape mode
• 6.2.2.6.2: Linear interpolation with one point
• 6.2.2.7: Annotation with ellipses
• 6.2.2.8: Annotation with cuboids
• 6.2.2.8.1: Creating the cuboid
• 6.2.2.8.2: Editing the cuboid
• 6.2.2.9: Annotation with skeletons
• 6.2.2.10: Annotation with brush tool
• 6.2.2.11: Types of shapes
• 6.2.2.12: Shape grouping
• 6.2.3: Editing & Utility Tools
• 6.2.3.1: Join and slice tools
• 6.2.3.2: Shapes converter
• 6.2.3.3: Contextual images
• 6.2.3.4: Filter
• 6.3: Specification for annotators
• 6.4: Automated Annotation
• 6.4.1: Overview
• 6.4.2: Segment Anything 2 Tracker
• 6.4.3: AI Tools
• 7: Guides
• 7.1: Complete workflow guide for organizations
• 7.2: Serverless tutorial
• 8: QA & Analytics
• 8.1: Quality control
• 8.2: Manual QA and Review
• 8.3: Automated QA, Review & Honeypots
• 8.4: Consensus-based annotation
• 8.5: Immediate job feedback
• 8.6: Analytics
• 9: Integrations
• 9.1: FiftyOne
• 9.2: CVAT and Human Protocol
• 10: System Administration
• 10.1: Community Deployment
• 10.1.1: Basics
• 10.1.1.1: Installation Guide
• 10.1.1.2: Superuser registration
• 10.1.1.3: AWS-Deployment Guide
• 10.1.2: Advanced
• 10.1.2.1: CVAT Architecture
• 10.1.2.2: CVAT deployment on Kubernetes with Helm
• 10.1.2.3: Semi-automatic and Automatic Annotation
• 10.1.2.4: CVAT Analytics and monitoring
• 10.1.2.5: Mounting cloud storage
• 10.1.2.6: LDAP Backed Authentication
• 10.1.2.7: Backup guide
• 10.1.2.8: Upgrade guide
• 10.1.2.9: Webhooks
• 10.1.2.10: Custom Certificates
• 10.2: Enterprise Deployment
• 10.2.1: Deployment with Docker Compose
• 10.2.2: Deployment on Kubernetes
• 11: Developer Documentation
• 11.1: Server API
• 11.2: CVAT Python SDK
• 11.2.1: SDK API Reference
• 11.2.1.1: APIs
• 11.2.1.1.1: AssetsApi class reference
• 11.2.1.1.2: AuthApi class reference
• 11.2.1.1.3: CloudstoragesApi class reference
• 11.2.1.1.4: CommentsApi class reference
• 11.2.1.1.5: ConsensusApi class reference
• 11.2.1.1.6: EventsApi class reference
• 11.2.1.1.7: GuidesApi class reference
• 11.2.1.1.8: InvitationsApi class reference
• 11.2.1.1.9: IssuesApi class reference
• 11.2.1.1.10: JobsApi class reference
• 11.2.1.1.11: LabelsApi class reference
• 11.2.1.1.12: LambdaApi class reference
• 11.2.1.1.13: MembershipsApi class reference
• 11.2.1.1.14: OrganizationsApi class reference
• 11.2.1.1.15: ProjectsApi class reference
• 11.2.1.1.16: QualityApi class reference
• 11.2.1.1.17: RequestsApi class reference
• 11.2.1.1.18: SchemaApi class reference
• 11.2.1.1.19: ServerApi class reference
• 11.2.1.1.20: TasksApi class reference
• 11.2.1.1.21: UsersApi class reference
• 11.2.1.1.22: WebhooksApi class reference
• 11.2.1.2: Models
• 11.2.1.2.1: About class reference
• 11.2.1.2.2: AcceptInvitationRead class reference
• 11.2.1.2.3: AccessTokenRead class reference
• 11.2.1.2.4: AccessTokenWriteRequest class reference
• 11.2.1.2.5: AnnotationConflict class reference
• 11.2.1.2.6: AnnotationConflictAnnotationType class reference
• 11.2.1.2.7: AnnotationConflictSeverity class reference
• 11.2.1.2.8: AnnotationConflictType class reference
• 11.2.1.2.9: AnnotationFileRequest class reference
• 11.2.1.2.10: AnnotationGuideRead class reference
• 11.2.1.2.11: AnnotationGuideWriteRequest class reference
• 11.2.1.2.12: AnnotationId class reference
• 11.2.1.2.13: AnnotationIdShapeType class reference
• 11.2.1.2.14: AssetRead class reference
• 11.2.1.2.15: Attribute class reference
• 11.2.1.2.16: AttributeRequest class reference
• 11.2.1.2.17: AttributeVal class reference
• 11.2.1.2.18: AttributeValRequest class reference
• 11.2.1.2.19: BasicOrganization class reference
• 11.2.1.2.20: BasicUser class reference
• 11.2.1.2.21: BasicUserRequest class reference
• 11.2.1.2.22: Chapter class reference
• 11.2.1.2.23: ChapterMetadata class reference
• 11.2.1.2.24: ChunkType class reference
• 11.2.1.2.25: ClientEvents class reference
• 11.2.1.2.26: ClientEventsRequest class reference
• 11.2.1.2.27: ClientEventsRequestPreviousEvent class reference
• 11.2.1.2.28: CloudStorageContent class reference
• 11.2.1.2.29: CloudStorageRead class reference
• 11.2.1.2.30: CloudStorageReadOwner class reference
• 11.2.1.2.31: CloudStorageWriteRequest class reference
• 11.2.1.2.32: CommentRead class reference
• 11.2.1.2.33: CommentsSummary class reference
• 11.2.1.2.34: CommentWriteRequest class reference
• 11.2.1.2.35: ConsensusMergeCreateRequest class reference
• 11.2.1.2.36: ConsensusSettings class reference
• 11.2.1.2.37: CredentialsTypeEnum class reference
• 11.2.1.2.38: DataMetaRead class reference
• 11.2.1.2.39: DataRequest class reference
• 11.2.1.2.40: DataRequestValidationParams class reference
• 11.2.1.2.41: DataResponse class reference
• 11.2.1.2.42: DatasetFileRequest class reference
• 11.2.1.2.43: DatasetFormat class reference
• 11.2.1.2.44: DatasetFormats class reference
• 11.2.1.2.45: Event class reference
• 11.2.1.2.46: EventRequest class reference
• 11.2.1.2.47: Events class reference
• 11.2.1.2.48: EventsEnum class reference
• 11.2.1.2.49: FileInfo class reference
• 11.2.1.2.50: FileInfoTypeEnum class reference
• 11.2.1.2.51: FrameMeta class reference
• 11.2.1.2.52: FrameSelectionMethod class reference
• 11.2.1.2.53: FunctionCall class reference
• 11.2.1.2.54: FunctionCallParams class reference
• 11.2.1.2.55: FunctionCallRequest class reference
• 11.2.1.2.56: InputTypeEnum class reference
• 11.2.1.2.57: InvitationRead class reference
• 11.2.1.2.58: InvitationWriteRequest class reference
• 11.2.1.2.59: IssueRead class reference
• 11.2.1.2.60: IssuesSummary class reference
• 11.2.1.2.61: IssueWriteRequest class reference
• 11.2.1.2.62: JobRead class reference
• 11.2.1.2.63: JobReadAssignee class reference
• 11.2.1.2.64: JobReadTargetStorage class reference
• 11.2.1.2.65: JobsSummary class reference
• 11.2.1.2.66: JobStage class reference
• 11.2.1.2.67: JobStatus class reference
• 11.2.1.2.68: JobType class reference
• 11.2.1.2.69: JobValidationLayoutRead class reference
• 11.2.1.2.70: JobWriteRequest class reference
• 11.2.1.2.71: Label class reference
• 11.2.1.2.72: LabeledData class reference
• 11.2.1.2.73: LabeledDataRequest class reference
• 11.2.1.2.74: LabeledImage class reference
• 11.2.1.2.75: LabeledImageRequest class reference
• 11.2.1.2.76: LabeledShape class reference
• 11.2.1.2.77: LabeledShapeRequest class reference
• 11.2.1.2.78: LabeledTrack class reference
• 11.2.1.2.79: LabeledTrackRequest class reference
• 11.2.1.2.80: LabelMappingEntryRequest class reference
• 11.2.1.2.81: LabelsSummary class reference
• 11.2.1.2.82: LabelType class reference
• 11.2.1.2.83: LocationEnum class reference
• 11.2.1.2.84: LoginSerializerExRequest class reference
• 11.2.1.2.85: MembershipRead class reference
• 11.2.1.2.86: MetaUser class reference
• 11.2.1.2.87: NullEnum class reference
• 11.2.1.2.88: OnlineFunctionCallRequest class reference
• 11.2.1.2.89: OperationStatus class reference
• 11.2.1.2.90: OrganizationRead class reference
• 11.2.1.2.91: OrganizationWriteRequest class reference
• 11.2.1.2.92: PaginatedAccessTokenReadList class reference
• 11.2.1.2.93: PaginatedAnnotationConflictList class reference
• 11.2.1.2.94: PaginatedCloudStorageReadList class reference
• 11.2.1.2.95: PaginatedCommentReadList class reference
• 11.2.1.2.96: PaginatedConsensusSettingsList class reference
• 11.2.1.2.97: PaginatedInvitationReadList class reference
• 11.2.1.2.98: PaginatedIssueReadList class reference
• 11.2.1.2.99: PaginatedJobReadList class reference
• 11.2.1.2.100: PaginatedLabelList class reference
• 11.2.1.2.101: PaginatedMembershipReadList class reference
• 11.2.1.2.102: PaginatedMetaUserList class reference
• 11.2.1.2.103: PaginatedOrganizationReadList class reference
• 11.2.1.2.104: PaginatedProjectReadList class reference
• 11.2.1.2.105: PaginatedQualityReportList class reference
• 11.2.1.2.106: PaginatedQualitySettingsList class reference
• 11.2.1.2.107: PaginatedRequestList class reference
• 11.2.1.2.108: PaginatedTaskReadList class reference
• 11.2.1.2.109: PaginatedWebhookDeliveryReadList class reference
• 11.2.1.2.110: PaginatedWebhookReadList class reference
• 11.2.1.2.111: PasswordChangeRequest class reference
• 11.2.1.2.112: PasswordResetConfirmRequest class reference
• 11.2.1.2.113: PasswordResetSerializerExRequest class reference
• 11.2.1.2.114: PatchedAccessTokenWriteRequest class reference
• 11.2.1.2.115: PatchedAnnotationGuideWriteRequest class reference
• 11.2.1.2.116: PatchedCloudStorageWriteRequest class reference
• 11.2.1.2.117: PatchedCommentWriteRequest class reference
• 11.2.1.2.118: PatchedConsensusSettingsRequest class reference
• 11.2.1.2.119: PatchedDataMetaWriteRequest class reference
• 11.2.1.2.120: PatchedInvitationWriteRequest class reference
• 11.2.1.2.121: PatchedIssueWriteRequest class reference
• 11.2.1.2.122: PatchedJobDataMetaWriteRequest class reference
• 11.2.1.2.123: PatchedJobValidationLayoutWriteRequest class reference
• 11.2.1.2.124: PatchedJobWriteRequest class reference
• 11.2.1.2.125: PatchedLabeledDataRequest class reference
• 11.2.1.2.126: PatchedLabelRequest class reference
• 11.2.1.2.127: PatchedMembershipWriteRequest class reference
• 11.2.1.2.128: PatchedOrganizationWriteRequest class reference
• 11.2.1.2.129: PatchedProjectWriteRequest class reference
• 11.2.1.2.130: PatchedProjectWriteRequestTargetStorage class reference
• 11.2.1.2.131: PatchedQualitySettingsRequest class reference
• 11.2.1.2.132: PatchedTaskValidationLayoutWriteRequest class reference
• 11.2.1.2.133: PatchedTaskWriteRequest class reference
• 11.2.1.2.134: PatchedUserRequest class reference
• 11.2.1.2.135: PatchedWebhookWriteRequest class reference
• 11.2.1.2.136: Plugins class reference
• 11.2.1.2.137: ProjectFileRequest class reference
• 11.2.1.2.138: ProjectRead class reference
• 11.2.1.2.139: ProjectReadTargetStorage class reference
• 11.2.1.2.140: ProjectWriteRequest class reference
• 11.2.1.2.141: ProviderTypeEnum class reference
• 11.2.1.2.142: QualityPointSizeBase class reference
• 11.2.1.2.143: QualityReport class reference
• 11.2.1.2.144: QualityReportCreateRequest class reference
• 11.2.1.2.145: QualityReportJobsSummary class reference
• 11.2.1.2.146: QualityReportSummary class reference
• 11.2.1.2.147: QualityReportSummaryJobs class reference
• 11.2.1.2.148: QualityReportSummaryTasks class reference
• 11.2.1.2.149: QualityReportTarget class reference
• 11.2.1.2.150: QualityReportTasksSummary class reference
• 11.2.1.2.151: QualitySettings class reference
• 11.2.1.2.152: QualityTargetMetric class reference
• 11.2.1.2.153: RegisterSerializerEx class reference
• 11.2.1.2.154: RegisterSerializerExRequest class reference
• 11.2.1.2.155: Request class reference
• 11.2.1.2.156: RequestDataOperation class reference
• 11.2.1.2.157: RequestOwner class reference
• 11.2.1.2.158: RequestStatus class reference
• 11.2.1.2.159: RestAuthDetail class reference
• 11.2.1.2.160: RoleEnum class reference
• 11.2.1.2.161: RqId class reference
• 11.2.1.2.162: RqStatus class reference
• 11.2.1.2.163: RqStatusStateEnum class reference
• 11.2.1.2.164: ShapeType class reference
• 11.2.1.2.165: SortingMethod class reference
• 11.2.1.2.166: Storage class reference
• 11.2.1.2.167: StorageMethod class reference
• 11.2.1.2.168: StorageRequest class reference
• 11.2.1.2.169: StorageType class reference
• 11.2.1.2.170: Sublabel class reference
• 11.2.1.2.171: SubLabeledShape class reference
• 11.2.1.2.172: SubLabeledShapeRequest class reference
• 11.2.1.2.173: SubLabeledTrack class reference
• 11.2.1.2.174: SubLabeledTrackRequest class reference
• 11.2.1.2.175: SublabelMappingEntryRequest class reference
• 11.2.1.2.176: SublabelRequest class reference
• 11.2.1.2.177: TaskFileRequest class reference
• 11.2.1.2.178: TaskRead class reference
• 11.2.1.2.179: TasksSummary class reference
• 11.2.1.2.180: TaskValidationLayoutRead class reference
• 11.2.1.2.181: TaskValidationLayoutReadMode class reference
• 11.2.1.2.182: TaskWriteRequest class reference
• 11.2.1.2.183: Token class reference
• 11.2.1.2.184: TrackedShape class reference
• 11.2.1.2.185: TrackedShapeRequest class reference
• 11.2.1.2.186: User class reference
• 11.2.1.2.187: UserIdentifiers class reference
• 11.2.1.2.188: ValidationMode class reference
• 11.2.1.2.189: ValidationParamsRequest class reference
• 11.2.1.2.190: WebhookContentType class reference
• 11.2.1.2.191: WebhookDeliveryRead class reference
• 11.2.1.2.192: WebhookRead class reference
• 11.2.1.2.193: WebhookType class reference
• 11.2.1.2.194: WebhookWriteRequest class reference
• 11.2.2: Low-level API
• 11.2.3: High-level API
• 11.2.4: PyTorch adapter
• 11.2.5: Auto-annotation API
• 11.2.6: Developer guide
• 11.3: Command line interface (CLI)
• 11.4: Access Tokens
• 12: Frequently asked questions
• 13: Contributing to CVAT Community
• 13.1: Development environment
• 13.2: Setup additional components in development environment
• 13.3: Coding style
• 13.4: Branching model
• 13.5: Using the issue tracker
• 13.6: Bug reports
• 13.7: Feature requests
• 13.8: Pull requests
• 13.9: How to add a new annotation format support
• 13.10: Server Profiling
• 13.11: Running tests
• 13.12: Repository structure

1 - Getting Started

1.1 - CVAT Overview

CVAT is an enterprise-grade platform for managing high-quality visual datasets for computer vision applications. It offers advanced tools for image, video, and 3D annotation, built-in quality assurance (QA), automation, and secure team collaboration.

Backed by an active open-source community and trusted by thousands of organizations worldwide, CVAT helps organizations streamline data labeling for faster, more accurate model development.

Products and services

CVAT comes in three editions: CVAT Community, CVAT Online, and CVAT Enterprise.

CVAT Community

• Free edition you can deploy on-premises or in your own cloud
• Full annotation toolset, import/export formats, and core workflow
• Ideal for technical teams comfortable managing infrastructure
• Installation & Setup Guide →
• GitHub repository

CVAT Online

• Hosted cloud edition with automatic updates, maintenance, and managed infrastructure.
• Available under multiple subscription tiers (Free, Solo, Team) for individual and collaborative work.
• Designed for fast onboarding, built-in collaboration and flexible storage
• Pricing & Plans →
• Try for free: app.cvat.ai

CVAT Enterprise

• For large organisations and regulated environments.
• Includes advanced features such as SSO/LDAP, audit logs, dedicated support, and custom SLAs.
• Managed deployment options, on-premises or private cloud.
• Pricing & Plans →

Labeling as a Service

• If you prefer not to build your own annotation team, we offer expert annotation services using CVAT.
• Scalable annotation across projects, with QA built-in and reporting dashboards.
• Ideal for one-time annotation projects and recurring workflows alike.

Learn more about CVAT Labeling Services →

Supported data & formats

CVAT supports a wide range of file formats and includes comprehensive built-in annotation tools for various computer vision tasks.

Input:

• Image: All formats supported by the Python Pillow library, including JPEG, PNG, BMP, GIF, PPMand TIFF
• Video: all formats, supported by ffmpeg, including MP4, AVI, and MOV
• 3D: .pcd, .bin

For more information about dataset formats, see Dataset Management.

Manual annotation

CVAT supports several tools and modes for manually labeling images, videos, and 3D data.

These tools define how the editor behaves, how shapes are created, and what geometric types you can use during annotation.

Annotation modes

Annotation modes control how the annotation workspace behaves and which actions are available:

• Standard mode – full access to all annotation tools and object editing.
• Attribute annotation mode – focus on editing object attributes, such as color, size, etc. without changing shapes.
• Single shape mode – create one shape and automatically exit drawing.
• Tag annotation mode – add frame-level tags without drawing shapes.
• Review mode – review and validate existing annotations.

Creating shapes

When drawing objects on frames, you can choose how shapes behave over time:

Shape – creates a single shape on the current frame.

Track – creates a sequence of shapes linked as the same object across multiple frames.

CVAT also supports different drawing methods, such as defining shapes by two opposite points or by placing four corner points for extra control.

Shape tools

Shapes represent the geometry used to annotate objects. CVAT supports multiple shape types for different tasks:

Automated annotation

CVAT provides a set of AI-powered tools that speed up annotation by automatically detecting, segmenting, or tracking objects on images and videos. These tools work with built-in models (such as SAM/SAM2), pre-trained models from native integrations like Hugging Face and Roboflow, as well as custom or third-party models you deploy through CVAT AI Agents (including YOLO and other frameworks).

Below is a detailed table of the supported models and the platforms they operate on:

Useful links

Integrations

CVAT is a global tool, trusted and utilized by teams worldwide. Below is a list of key companies that contribute significantly to our product support or are an integral part of our ecosystem.

License information

CVAT includes the following licenses:

Get in touch

To get in touch, use one of the following channels:

1.2 - Vocabulary

Label

Label is a type of an annotated object (e.g. person, car, vehicle, etc.)

Attribute

Attribute is a property of an annotated object (e.g. color, model, quality, etc.). There are two types of attributes:

Unique

Unique immutable and can’t be changed from frame to frame (e.g. age, gender, color, etc.)

Temporary

Temporary mutable and can be changed on any frame (e.g. quality, pose, truncated, etc.)

Track

Track is a set of shapes on different frames which corresponds to one object. Tracks are created in Track mode

Annotation

Annotation is a set of shapes and tracks. There are several types of annotations:

• Manual which is created by a person
• Semi-automatic which is created mainly automatically, but the user provides some data (e.g. interpolation)
• Automatic which is created automatically without a person in the loop

Approximation

Approximation allows you to reduce the number of points in the polygon. Can be used to reduce the annotation file and to facilitate editing polygons.

Trackable

Trackable object will be tracked automatically if the previous frame was a latest keyframe for the object. More details in the section trackers.

Mode

Interpolation

Mode for video annotation, which uses track objects. Only objects on keyframes are manually annotation, and intermediate frames are linearly interpolated.

Related sections:

• Track mode

Annotation

Mode for images annotation, which uses shape objects.

Related sections:

• Shape mode

Dimension

Depends on the task data type that is defined when the task is created.

2D

The data format of 2d tasks are images and videos. Related sections:

• Creating an annotation task

3D

The data format of 3d tasks is a cloud of points. Data formats for a 3D task

Related sections:

• 3D task workspace
• 3D Object annotation

State

State of the job. The state can be changed by an assigned user in the menu inside the job. There are several possible states: new, in progress, rejected, completed.

Stage

Stage of the job. The stage is specified with the drop-down list on the task page. There are three stages: annotation, validation or acceptance. This value affects the task progress bar.

Subset

A project can have subsets. Subsets are groups for tasks that make it easier to work with the dataset. It could be test, train, validation or custom subset.

Credentials

Under credentials is understood Key & secret key, Account name and token, Anonymous access, Key file. Used to attach cloud storage.

Resource

Under resource is understood bucket name or container name. Used to attach cloud storage.

1.3 - Shortcuts

CVAT provides a wide range of customizable shortcuts, with many UI elements offering shortcut hints when hovered over with the mouse.

These shortcuts are organized by scopes. Some are global, meaning they work across the entire application, while others are specific to certain sections or workspaces. This approach allows reusing the same shortcuts in different scopes, depending on whether they might conflict. For example, global shortcuts must be unique since they apply across all pages and workspaces. However, similar shortcuts can be used in different workspaces, like having the same shortcuts in both the Standard Workspace and the Standard 3D Workspace, as these two do not coexist.

Shortcuts Customization

You can customize shortcuts in CVAT settings.

• Open Settings:
  

• Go to the Shortcuts tab:
  

• You’ll see the shortcuts customization menu:
  

• As it can be seen there is a warning, that some shortcuts are reserved by a browser and cannot be overridden in CVAT, there isn’t a specific list available for such combinations, but shortcuts such as ctrl + tab (switching tabs) or ctrl + w (closing tabs) etc, are reserved by the browser and shortcuts such as alt + f4 (closing the window) are usually reserved by your operating system.

• All sections collapsible, so you can easily navigate through the list of shortcuts. Here is the Global scope expanded:
  

• To add a custom shortcut all you have to do is to click the input field and start pressing the sequence you want to assign to the action. As an example f3 has been set here for Show Shortcuts along with f1:
  

• Shortcuts can be any combination of modifiers (ctrl, shift or alt) and up to one non-modifier key e.g. ctrl+shift+f1 etc.
  

• If you try to add a shortcut that is already in use, you will get a warning message:
  

• If pressed cancel it will remain the same otherwise the conflicting shortcut will be unset.
  

• If you want to reset all the shortcuts to default, you can do so by clicking the Restore Defaults button at the top of the shortcut settings.
  

2 - Products

2.1 - CVAT Online

CVAT Online is the cloud edition of CVAT with managed infrastructure.

Below you can find all documentation relevant to CVAT Online:

2.2 - CVAT Enterprise

CVAT Enterprise is designed for large organizations and regulated environments. It offers SSO/LDAP, audit logs, enterprise-grade security, and custom deployment options.

Below are the documents relevant specifically to the CVAT Enterprise edition:

• Deployment with Docker Compose
• Deployment on Kubernetes
• SSO configuration

2.3 - CVAT Community

CVAT Community is the free, self-hosted open-source edition of CVAT, suitable for technical teams that prefer full control over their infrastructure and custom deployments.

Below are the documents relevant specifically to the CVAT Community edition:

3 - Workspace

3.1 - Projects

Projects page

On this page, you can create a new project, create a project from a backup, and also see the created projects.

In the upper left corner there is a search bar, using which you can find the project by project name, assignee etc. In the upper right corner there are sorting, quick filters and filter.

Filter

The filter works similarly to the filters for annotation, you can create rules from properties, operators and values and group rules into groups. For more details, see the filter section. Learn more about date and time selection.

To clear all filters, press Clear filters.

Supported properties for projects list

Create a project

In CVAT, you can create a project containing tasks of the same type. All tasks related to the project will inherit a list of labels.

To create a project, go to the projects section by clicking on the Projects item in the top menu. On the projects page, you can see a list of projects, use a search, or create a new project by clicking on the + button and select Create New Project.

You can change: the name of the project, the list of labels (which will be used for tasks created as parts of this project) and a skeleton if it’s necessary. In advanced configuration also you can specify: a link to the issue, source and target storages. Learn more about creating a label list, creating the skeleton and attach cloud storage.

To save and open a project, click on Submit & Open button. Also, you can click on Submit & Continue button to create several projects in sequence.

Once created, the project will appear on the projects page. To open a project, just click on it.

Here you can do the following:

1. Change the project’s title.

2. Open the Actions menu. Each button is responsible for a specific function in the Actions menu:

   • Export dataset/Import dataset - download/upload annotations or annotations and images in a specific format. See more information at export/import datasets.
   • Backup project - make a backup of the project read more in the backup section.
   • Organization - move the project between your personal workspace or organizations. Please, refer to the Transfer between organizations section for details.
   • Delete - remove the project and all related tasks.

3. Change issue tracker or open issue tracker if it is specified.

4. Change labels and skeleton. You can add new labels or add attributes for the existing labels in the Raw mode or the Constructor mode. You can also change the color for different labels. By clicking Setup skeleton you can create a skeleton for this project.

5. Assigned to — is used to assign a project to a person. Start typing an assignee’s name and/or choose the right person out of the dropdown list.

6. Tasks — is a list of all tasks for a particular project, with the ability to search, sort and filter for tasks in the project. Read more about search. Read more about sorting and filter It is possible to choose a subset for tasks in the project. You can use the available options (Train, Test, Validation) or set your own.

3.2 - Tasks

Overview

The Tasks page contains elements and each of them relates to a separate task. They are sorted in creation order. Each element contains: the task name, preview, progress bar, button Open, and menu Actions. Each button is responsible for a menu Actions specific function:

• Export task dataset — download annotations or annotations and images in a specific format. More information is available in the export/import datasets section.
• Upload annotation upload annotations in a specific format. More information is available in the export/import datasets section.
• Automatic Annotation — automatic annotation with OpenVINO toolkit. Presence depends on how you build the CVAT instance.
• Backup task — make a backup of this task into a zip archive. Read more in the backup section.
• Move to project — Moving a task to a project (you can move only a task that does not belong to any project). In case of a label mismatch, you can create or delete necessary labels in the project/task. Some task labels can be matched with the target project labels.
• Organization - moving a task between your personal workspace or organizations. Only available for individual tasks (not tasks in a project). Please, refer to the Transfer between organizations section for details.
• Delete — delete task.

In the upper left corner, there is a search bar, using which you can find the task by assignee, task name etc. In the upper right corner, there are sorting, quick filters, and filter.

Filter

The filter works similarly to the filters for annotation, you can create rules from properties, operators, and values and group rules into groups. For more details, consult the filter section. Learn more about date and time selection.

For clear all filters press Clear filters.

Supported properties for tasks list

Select Open to go to task details.

Task details page

Task details is a task page that contains a preview, a progress bar, the details of the task (specified when the task was created), and the Jobs section.

The next actions are available on this page:

1. Change the task’s title.

2. Open Actions menu.

3. Change the issue tracker or open it if specified.

4. Change labels (available only if the task is not related to the project).

   You can add new labels or add attributes for the existing labels in the Raw mode or the Constructor mode. By selecting Copy you will copy the labels to the clipboard.

5. Assigned to — is used to assign a task to a person. Start typing an assignee’s name and/or choose the right person out of the dropdown list. In the list of users, you will only see the users of the organization where the task is created.

6. Cloud storage — view the cloud storage attached to the task and change it to another attached storage if needed.

Jobs is a list of all jobs for a particular task. Here you can find the next data:

• Jobs name with a hyperlink to it.
• Frame range — the frame interval.
• A stage of the job. The stage is specified by a drop-down list. There are three stages: annotation, validation, or acceptance. This value affects the task progress bar.
• A state of the job. The state can be changed by an assigned user in the menu inside the job. There are several possible states: new, in progress, rejected, completed.
• Duration — is the amount of time the job is being worked.
• Assignee is the user who is working on the job (annotator, reviewer, or corrector). You can start typing an assignee’s name and/or choose the right person out of the dropdown list.

You can filter or sort jobs by status, assignee, and updated date using the filters panel.

Follow a link inside Jobs section to start the annotation process. In some cases, you can have several links. It depends on the size of your task and Overlap Size and Segment Size parameters. To improve UX, only the first chunk of several frames will be loaded and you will be able to annotate the first images. Other frames will be loaded in the background.

How to create and configure an annotation task

To start annotating in CVAT, you must create an annotation task and specify its parameters.

Create a task

To create a task:

1. On the Tasks page, select +
2. Select Create new task.

Next, specify the task parameters in the configurator:

1. In the Name field, enter the name of the new task.

   

2. (Optional) From the Projects drop-down, select a project for the new task.
   Leave this field empty if you do not want to assign the task to any project.

   

   Note

   Following steps are valid if the task does not belong to a project.
   If the task has been assigned to a project, the project’s labels will be applied to the task.

3. On the Constructor tab, select Add label.
   The label constructor menu will open:

   

4. In the Label name field, enter the name of the label.

5. (Optional) To limit the use of the label to a certain shape tool, from the Label shape drop-down select the shape.

6. (Optional) Select the color for the label.

   

7. (Optional) Select Add an attribute and set up its properties.

8. Select Select files to upload files for annotation.

9. Select Continue to submit the label and start adding a new one
   or Cancel to terminate the current label and return you to the labels list.

10. Select Submit and open to submit the configuration and open the created task,
    or Submit and continue, to submit the configuration and start a new task.

Label shape

Labels (or classes) are categories of objects that you can annotate.

Label shape limits the use of the label to certain shape tool.

Any is the default setting that does not limit the use of the label to any particular shape tool.

For example, if you added:

• Label sun with the Label shape type ellipse
• Label car with the Label shape type any

As a result:

• The sun label will be available only for ellipse shape.

• The car label will be available for all shapes.

  

The tools on the Controls sidebar will be limited to the selected types of shapes.

For example, if you select Any, all tools will be available, but if you select Rectangle for all labels, only the Rectangle tool will be visible on the sidebar.

You can change the shape of the label as needed. This change will not affect the existing annotation.

For example, if you created objects using polygons and then changed the label shape to polylines, all previously created objects will remain polygons. However, you will not be able to add new polygon objects with the same label.

Add an attribute

Attribute is a property of an annotated object, such as color, model, or other quality.

For example, you have a label for face and want to specify the type of face. Instead of creating additional labels for male and female, you can use attributes to add this information.

There are two types of attributes:

• Immutable attributes are unique and do not change from frame to frame. For example, age, gender, and color.
• Mutable attributes are temporary and can change from frame to frame. For example, pose, quality, and truncated.

Added attributes will be available from the Objects menu:

To add an attribute:

1. Go to the Constructor tab and select Add attribute.

   

2. In the Name field, enter the attribute name.

3. In the drop-down menu, select the way to display the attribute in the Objects menu:

   • Select enables a drop-down list, from which you can select an attribute.
     If in the Attribute value field you add __undefined__, the drop-down list will have a blank value.
     This is useful for cases where the attribute of the object cannot be clarified:

     

   • Radio enables the selection of one option from several options.

   • Checkbox enables the selection of multiple options.

   • Text sets the attribute to a text field.

   • Number sets the attribute to numerical field in the following format: min;max;step.

4. In the Attribute values field, add attribute values.
   To separate values use Enter.
   To delete value, use Backspace or click x next to the value name.

5. (Optional) For mutable attributes, select Mutable.

6. (Optional) To set an attribute value as default, select it. The default value will change color to blue.

To delete an attribute, select Delete attribute.

Select files

There are several ways to upload files:

Data source	Description
My computer	Use this option to select files from your laptop or PC. To select file: 1. Select Select files field: . 2. Select files to upload.
Connected file share	Advanced option. Upload files from a local or cloud shared folder. Note, that you need to mount a fileshare first. For more information, consult Share path
Remote source	Enter a list of URLs (one per line) in the field.
Cloud Storage	Advanced option. To upload files from cloud storage, type the cloud storage name, (optional) choose the manifest file, and select the required files. For more information, consult Attach cloud storage. Use the search feature to find a file (by file name) from the connected cloud storage.

Editing labels in RAW format

The Raw is a way of working with labels for an advanced user.

It is useful when you need to copy labels from one independent task to another.

Raw presents label data in .json format with an option of editing and copying labels as text. The Done button applies the changes and the Reset button cancels the changes.

Data formats for a 3D task

To create a 3D task, you must prepare an archive with one of the following directory structures.

• Velodyne
• 3D pointcloud
• 3D Option 1
• 3D Option 2

  VELODYNE FORMAT
    Structure:
      velodyne_points/
        data/
          image_01.bin
          IMAGE_00 # unknown dirname,
                   # generally image_01.png can be under IMAGE_00, IMAGE_01, IMAGE_02, IMAGE_03, etc
      data/
        image_01.png

   3D POINTCLOUD DATA FORMAT
    Structure:
      pointcloud/
        00001.pcd
      related_images/
        00001_pcd/
          image_01.png # or any other image

    3D, DEFAULT DATAFORMAT Option 1
    Structure:
      data/
        image.pcd
        image.png

    3D, DEFAULT DATAFORMAT Option 2
    Structure:
      data/
        image_1/
            image_1.pcd
            context_1.png # or any other name
            context_2.jpg

Advanced configuration

Use advanced configuration to set additional parameters for the task and customize it to meet specific needs or requirements.

The following parameters are available:

To save and open the task, select Submit & Open .

To create several tasks in sequence, select Submit & Continue.

Created tasks will be displayed on the tasks page.

How to create and set up multiple tasks

Use Create multi tasks to create multiple video annotation tasks with the same configuration.

Check out:

• Create multi tasks
• Example
• Errors
• Advanced configuration

Create multi tasks

To create the multi tasks:

1. On the Tasks page select +.
2. Select Create multi tasks.

Next, specify the parameters in the task configurator:

1. In the Name field, enter the name of the new task:

   • Enter the name of the task
   • (Optional) {{index}} adds an index to the file in the set (starting from 0).
   • (Optional) {{file_name}} adds the file’s name to the task’s name.

2. (Optional) From the Projects drop-down, select a project for the tasks.
   Leave this field empty if you do not want to assign tasks to any project.

   

   Note

   Following steps are valid if the tasks do not belong to a project.
   If the tasks have been assigned to a project, the project’s labels will be applied to the tasks.

3. On the Constructor tab, select Add label.

4. In the Label name field, enter the name of the label.

5. (Optional) Select the color for the label.

6. (Optional) Select Add an attribute and set up its properties.

7. Select Select files to upload files for annotation.

   Note

   You cannot upload multiple tasks from the cloud storage.

8. Select Submit N tasks

Example

A step-by-step example for creating the multiple tasks:

1. In the Name field, enter the Create_multitask-{{index}}-{{file_name}}.

2. Add labels.

3. Select files.
   In case there are more than four files, only the total number of selected files will be displayed:

4. Select Submit N tasks

   

5. You will see a progress bar that shows the progress of the tasks being created:

   

6. Select Ok.

   

The result will look like the following:

Errors

During the process of adding multiple tasks, the following errors may occur:

Error	Description
	Wrong file format. You can add only video files.
	In the process of creating a task, CVAT was not able to process the video file. The name of the failed file will be displayed on the progress bar. To fix this issue: If you want to try again, click Retry failed tasks. If you want to skip the file, click OK.

Advanced configuration

Use advanced configuration to set additional parameters for the task and customize it to meet specific needs or requirements.

For more information, consult Advanced configuration

How to delete a frame from a task

You can delete the current frame from a task. This frame will not be presented either in the UI or in the exported annotation. Thus, it is possible to mark corrupted frames that are not subject to annotation.

1. Go to the Job annotation view and click on the Delete frame button (Alt+Del).

   Note

   When you delete with the shortcut, the frame will be deleted immediately without additional confirmation.

   

2. After that you will be asked to confirm frame deleting.

   Note

   all annotations from that frame will be deleted, unsaved annotations will be saved and the frame will be invisible in the annotation view (Until you make it visible in the settings). If there is some overlap in the task and the deleted frame falls within this interval, then this will cause this frame to become unavailable in another job as well.

3. When you delete a frame in a job with tracks, you may need to adjust some tracks manually. Common adjustments are:

   • Add keyframes at the edges of the deleted interval for the interpolation to look correct;
   • Move the keyframe start or end keyframe to the correct side of the deleted interval.

Configure deleted frames visibility and navigation

If you need to enable showing the deleted frames, you can do it in the settings.

1. Go to the settings and chose Player settings.

   

2. Click on the Show deleted frames checkbox. And close the settings dialog.

   

3. Then you will be able to navigate through deleted frames. But annotation tools will be unavailable. Deleted frames differ in the corresponding overlay.

4. There are ways to navigate through deleted frames without enabling this option:

   • Go to the frame via direct navigation methods: navigation slider or frame input field,
   • Go to the frame via the direct link, for example: /api/tasks/{id}/jobs/{id}?frame={frame_id}.

5. Navigation with step will not count deleted frames.

Restore deleted frame

You can also restore deleted frames in the task.

1. Turn on deleted frames visibility, as it was told in the previous part, and go to the deleted frame you want to restore.

   

2. Click on the Restore icon. The frame will be restored immediately.

3.3 - Jobs

On the Jobs page, users (for example, with the worker role) can see the jobs that are assigned to them without having access to the task page, as well as track progress, sort, and apply filters to the job list.

On the page, there is a list of jobs presented in the form of tiles, where each tile is one job. Each element contains:

• job ID
• dimension 2D or 3D
• preview
• stage and state
• when hovering over an element, you can see:
  • size
  • assignee
• menu to navigate to a task, project, or bug tracker.

In the upper left corner, there is a search bar, using which you can find the job by assignee, stage, state, etc. In the upper right corner, there are sorting, quick filters, and filter.

Filter

The filter works similarly to the filters for annotation, you can create rules from properties, operators, and values and group rules into groups. For more details, consult the filter section. Learn more about date and time selection.

To clear all filters, select Clear filters.

Supported properties for jobs list

3.4 - Cloud storages

CVAT supports Amazon S3, Azure Blob Storage, Backblaze B2 (S3-compatible) and Google Cloud Storage for importing and exporting annotation datasets.

The cloud storages page contains elements, each of them relating to a separate cloud storage.  Each element contains: preview, cloud storage name, provider, creation and update info, status, ? button for displaying the description and the actions menu.

Each button in the action menu is responsible for a specific function:

• Update — update this cloud storage
• Delete — delete cloud storage.

This preview will appear when it is impossible to get a real preview (e.g. storage is empty or invalid credentials were used).

In the upper left corner, there is a search bar, using which you can find the cloud storage by display name, provider, etc. In the upper right corner, there are sorting, quick filters, and filter.

Filter

The filter works similarly to the filters for annotation, you can create rules from properties, operators, and values and group rules into groups. For more details, consult the filter section. Learn more about date and time selection.

To clear all filters, select Clear filters.

Supported properties for cloud storages list

Note: Backblaze B2 uses the Amazon S3 provider type (S3-compatible).

Select the + button to attach a new cloud storage.

3.5 - Attach cloud storage

In CVAT, you can use Amazon S3, Azure Blob Storage, Backblaze B2, and Google Cloud Storage storages to import and export image datasets for your tasks.

Check out:

• Amazon S3
  • Create a bucket
  • Upload data
  • Access permissions
    • Authenticated access
    • Anonymous access
  • Attach Amazon S3 storage
  • Amazon S3 manifest file
  • Video tutorial: Add Amazon S3 as Cloud Storage in CVAT
• Backblaze B2
  • Create a bucket
  • Upload data
  • Access permissions
  • Attach Backblaze B2 storage
• Google Cloud Storage
  • Create a bucket
  • Upload data
  • Access permissions
    • Authenticated access
    • Anonymous access
  • Attach Google Cloud Storage
  • Video tutorial: Add Google Cloud Storage as Cloud Storage in CVAT
• Microsoft Azure Blob Storage
  • Create a bucket
  • Create a container
  • Upload data
  • SAS token and connection string
  • Personal use
  • Attach Azure Blob Storage
  • Video tutorial: Add Microsoft Azure Blob Storage as Cloud Storage in CVAT
• Prepare the dataset

Amazon S3

Create a bucket

To create bucket, do the following:

1. Create an AWS account.

2. Go to the Amazon S3 console, and select Create bucket.

   

3. Specify the name and region of the bucket. You can also copy the settings of another bucket by selecting Choose bucket.

4. Enable Block all public access. For access, you will use access key ID and secret access key.

5. Select Create bucket.

A new bucket will appear on the list of buckets.

Upload data

You need to upload data for annotation and the manifest.jsonl file.

1. Prepare data. For more information, refer on how to prepare the dataset.

2. Open the bucket and select Upload.

   

3. Drag the manifest file and image folder on the page and select Upload:

Access permissions

Authenticated access

To add access permissions, do the following:

1. Go to IAM and select Add users.

2. Set User name and enable Access key - programmatic access.

   

3. Select Next: Permissions.

4. Select Create group, enter the group name.

5. Use search to find and select:

   • For read-only access: AmazonS3ReadOnlyAccess.
   • For full access: AmazonS3FullAccess.

   

6. (Optional) Add tags for the user and go to the next page.

7. Save Access key ID and Secret access key.

For more information, consult Creating an IAM user in your AWS account

Anonymous access

On how to grant public access to the bucket, consult Configuring block public access settings for your S3 buckets

Attach Amazon S3 storage

To attach storage, do the following:

1. Log into CVAT and in the separate tab open your bucket page.
2. In the CVAT, on the top menu select Cloud storages > on the opened page select +.

Fill in the following fields:

After filling in all the fields, select Submit.

Amazon S3 manifest file

To prepare the manifest file, do the following:

1. Go to AWS CLI and run script for prepare manifest file.

2. Perform the installation, following the aws-shell manual,
   You can configure credentials by running aws configure.
   You will need to enter Access Key ID and Secret Access Key as well as the region.

   aws configure
   Access Key ID: <your Access Key ID>
   Secret Access Key: <your Secret Access Key>
   

3. Copy the content of the bucket to a folder on your computer:

   aws s3 cp <s3://bucket-name> <yourfolder> --recursive
   

4. After copying the files, you can create a manifest file as described in prepare manifest file section:

   python <cvat repository>/utils/dataset_manifest/create.py --output-dir <yourfolder> <yourfolder>
   

5. When the manifest file is ready, upload it to the S3 bucket:

   • For read and write permissions when you created the user, run:

     aws s3 cp <yourfolder>/manifest.jsonl <s3://bucket-name>
     

   • For read-only permissions, use the download through the browser, select upload, drag the manifest file to the page and select upload.

     

Video tutorial: Add Amazon S3 as Cloud Storage in CVAT

Backblaze B2

Backblaze B2 is an S3-compatible cloud storage service. It can be used in CVAT by selecting Amazon S3 as the provider and specifying the Backblaze B2 endpoint (for example, https://s3.us-west-004.backblazeb2.com).

Create a bucket

To create a B2 bucket, do the following:

1. Create a Backblaze account or log into an existing one.
2. In the Backblaze console, go to B2 Cloud Storage > Buckets.
3. Select Create a Bucket.
4. Configure your bucket:
   • Bucket Unique Name: Enter a globally unique name for your bucket.
   • Files in Bucket: Select Private for secure access or Public for anonymous access.
   • Default Encryption: (Optional) Enable server-side encryption for added security.
   • Object Lock: (Optional) Enable if you need compliance features.
5. Select Create a Bucket.

The new bucket will appear in your buckets list.

Upload data

You need to upload data for annotation and optionally the manifest.jsonl file.

1. Prepare data. For more information, refer on how to prepare the dataset.
2. Open the bucket and select Upload/Download.
3. Drag and drop files or folders, or select Browse files to upload your data.

Alternatively, you can use the Backblaze CLI or any S3-compatible tool like the AWS CLI with B2 endpoints.

Access permissions

To access your B2 bucket from CVAT, you need to create Application Keys:

1. In the Backblaze console, go to App Keys.
2. Select Add a New Application Key.
3. Configure the key:
   • Name of Key: Enter a descriptive name (e.g., “CVAT Access”).
   • Allow access to Bucket(s): Select the specific bucket you created, or choose All for access to all buckets.
   • Type of Access: Select Read and Write for full access, or Read Only if you only need to import data.
   • Allow List All Bucket Names: Enable if you want to list all buckets.
   • File name prefix: (Optional) Restrict access to specific file prefixes.
   • Duration: (Optional) Set an expiration time for the key.
4. Select Create New Key.
5. Important: Save the keyID and applicationKey immediately. The applicationKey is only shown once and cannot be retrieved later.

For more information, consult B2 Application Keys.

Attach Backblaze B2 storage

To attach B2 storage to CVAT, do the following:

1. Log into CVAT.
2. In CVAT, on the top menu select Cloud storages > on the opened page select +.

Fill in the following fields:

After filling in all the fields, select Submit.

Google Cloud Storage

Create a bucket

To create bucket, do the following:

1. Create Google account and log into it.

2. On the Google Cloud page, select Start Free, then enter the required data and accept the terms of service.

   Note

   Google requires to add payment, you will need a bank card to accomplish step 2.

3. Create a Bucket with the following parameters:

   • Name your bucket: Unique name.
   • Choose where to store your data: Set up a location nearest to you.
   • Choose a storage class for your data: Set a default class > Standard.
   • Choose how to control access to objects: Enforce public access prevention on this bucket > Uniform (default).
   • How to protect data: None

You will be forwarded to the bucket.

Upload data

You need to upload data for annotation and the manifest.jsonl file.

1. Prepare data. For more information, consult prepare the dataset.
2. Open the bucket and from the top menu select Upload files or Upload folder (depends on how your files are organized).

Access permissions

To access Google Cloud Storage get a Project ID from cloud resource manager page

And follow instructions below based on the preferable type of access.

Authenticated access

For authenticated access you need to create a service account and key file.

To create a service account:

1. On the Google Cloud platform, go to IAM & Admin > Service Accounts and select +Create Service Account.
2. Enter your account name and select Create And Continue.
3. Select a role, for example Basic > Viewer, and select Continue.
4. (Optional) Give access rights to the service account.
5. Select Done.

To create a key:

1. Go to IAM & Admin > Service Accounts > select on account name > Keys.
2. Select Add key and select Create new key > JSON
3. Select Create. The key file will be downloaded automatically.

For more information about keys, consult Learn more about creating keys.

Anonymous access

To configure anonymous access:

1. Open the bucket and go to the Permissions tab.
2. Click + Grant access to add new principals.
3. In the New principals field specify allUsers, select roles: Cloud Storage Legacy > Storage Legacy Bucket Reader.
4. Select Save.

Now you can attach the Google Cloud Storage bucket to CVAT.

Attach Google Cloud Storage

To attach storage, do the following:

1. Log into CVAT and in the separate tab open your bucket page.
2. In the CVAT, on the top menu select Cloud storages > on the opened page select +.

Fill in the following fields:

After filling in all the fields, select Submit.

Video tutorial: Add Google Cloud Storage as Cloud Storage in CVAT

Microsoft Azure Blob Storage

Create a bucket

To create bucket, do the following:

1. Create an Microsoft Azure account and log into it.

2. Go to Azure portal, hover over the resource , and in the pop-up window select Create.

   

3. Enter a name for the group and select Review + create, check the entered data and select Create.

4. Go to the resource groups page, navigate to the group that you created and select Create resources.

5. On the marketplace page, use search to find Storage account.

   

6. Select on Storage account and on the next page select Create.

7. On the Basics tab, fill in the following fields:

   • Storage account name: to access container from CVAT.
   • Select a region closest to you.
   • Select Performance > Standard.
   • Select Local-redundancy storage (LRS).
   • Select next: Advanced>.

   

8. On the Advanced page, fill in the following fields:

   • (Optional) Disable Allow enabling public access on containers to prohibit anonymous access to the container.
   • Select Next > Networking.

   

9. On the Networking tab, fill in the following fields:

   • If you want to change public access, enable Public access from all networks.

   • Select Next>Data protection.

     You do not need to change anything in other tabs until you need some specific setup.

10. Select Review and wait for the data to load.

11. Select Create. Deployment will start.

12. After deployment is over, select Go to resource.

Create a container

To create container, do the following:

1. Go to the containers section and on the top menu select +Container

   

2. Enter the name of the container.

3. (Optional) In the Public access level drop-down, select type of the access.
   Note: this field will inactive if you disabled Allow enabling public access on containers.

4. Select Create.

Upload data

You need to upload data for annotation and the manifest.jsonl file.

1. Prepare data. For more information, refer on how to prepare the dataset.

2. Go to container and select Upload.

3. Select Browse for files and select images.

   Note

   If images are in folder, specify folder in the Advanced settings > Upload to folder.

4. Select Upload.

SAS token and connection string

Use the SAS token or connection string to grant secure access to the container.

To configure the credentials:

1. Go to Home > Resource groups > You resource name > Your storage account.
2. On the left menu, select Shared access signature.
3. Change the following fields:
   • Allowed services: Enable Blob . Disable all other fields.
   • Allowed resource types: Enable Container and Object. Disable all other fields.
   • Allowed permissions: Enable Read, Write, and List. Disable all other fields.
   • Start and expiry date: Set up start and expiry dates.
   • Allowed protocols: Select HTTPS and HTTP
   • Leave all other fields with default parameters.
4. Select Generate SAS and connection string and copy SAS token or Connection string.

Personal use

For personal use, you can use the Access Key from your storage account in the CVAT SAS Token field.

To get the Access Key:

1. In the Azure Portal, go to the Security + networking > Access Keys
2. Select Show and copy the key.

Attach Azure Blob Storage

To attach storage, do the following:

1. Log into CVAT and in the separate tab open your bucket page.
2. In the CVAT, on the top menu select Cloud storages > on the opened page select +.

Fill in the following fields:

After filling in all the fields, select Submit.

Video tutorial: Add Microsoft Azure Blob Storage as Cloud Storage in CVAT

Prepare the dataset

For example, the dataset is The Oxford-IIIT Pet Dataset:

1. Download the archive with images.
2. Unpack the archive into the prepared folder.
3. Create a manifest. For more information, consult Dataset manifest:

python <cvat repository>/utils/dataset_manifest/create.py --output-dir <your_folder> <your_folder>

3.6 - Requests

The Requests page allows users to track the status of data processing jobs (such as exporting annotations or importing datasets) and most of the background processes (such as task creation, quality calculation, report preparation with analytics, merge consensus jobs). Users can monitor progress, download results, and check for errors if they occur.

Requests List

On the Requests page, requests are displayed as cards. Each card contains the following details (if applicable):

• Operation Name
• Resource Link
• Status of the Request
• Timestamps:
  • Enqueued Date
  • Started Date
  • Finished Date
  • Result Expiration Date
• Annotations Format
• Lightweight backup (shown for backup requests created with the lightweight option)
• Menu to download the result or cancel a Queued job

Statuses for Requests List

The following statuses are used to indicate the state of each request:

3.7 - Models

To deploy the models, you will need to install the necessary components using Semi-automatic and Automatic Annotation guide. To learn how to deploy the model, read Serverless tutorial.

The Models page contains a list of deep learning (DL) models deployed for semi-automatic and automatic annotation. To open the Models page, click the Models button on the navigation bar. The list of models is presented in the form of a table. The parameters indicated for each model are the following:

• Framework the model is based on
• model Name
• model Type:
  • detector - used for automatic annotation (available in detectors and automatic annotation)
  • interactor - used for semi-automatic shape annotation (available in interactors)
  • tracker - used for semi-automatic track annotation (available in trackers)
  • reid - used to combine individual objects into a track (available in automatic annotation)
• Description - brief description of the model
• Labels - list of the supported labels (only for the models of the detectors type)

3.8 - Bulk actions

Overview

Bulk Actions allow you to select multiple resources (such as jobs, tasks, projects and more) and perform actions on all of them at once. This streamlines workflows by enabling mass updates, such as changing an assignee or state for a group of jobs, without needing to update each resource individually.

Supported Resources

• Jobs
• Tasks
• Projects
• Cloud storages
• Requests
• Models
• Webhooks
• Organization members

Typical Bulk Actions

• Update Assignee: Assign a new user to multiple jobs, tasks, or projects.
• Update State/Stage: Change the status or stage for a group of jobs.
• Delete: Remove multiple resources in one operation.
• Other field updates: Depending on resource type, other fields may be updated in bulk.

How It Works

1. Selection: Select multiple resources using selection tools in the UI.
   • Ctrl (Cmd for Mac) + Click: Select or deselect individual resources by holding the Ctrl key and clicking on them.
   • Shift + Click: Select a range of resources by clicking the first item, holding Shift, and clicking the last item in the range.
   • Select All Button: Use the “Select All” button in the top bar to select all resources on the current page.
   • Click: Click anywhere outside the selected resources to reset the selection.

     Note

     Selection is limited to visible resources according to the current page size, filtering, and sorting options. It’s important to adjust filters or sorting before selection to bring them into view. Changing the page clears all selected resources.
2. Action Menu: Once resources are selected, you can either right-click on any of them or left-click the actions menu of a selected resource. An actions appears, offering bulk operations relevant to that resource type.
3. Execution: The chosen action is applied to all selected resources. Progress and status messages are shown for each item.
4. Error Handling: If an operation fails for some items, the system provides feedback and allows retrying the failed items.

3.9 - Search

Search

Search within all fields (owner, assignee, task name, task status, task mode). To execute enter a search string in search field.

The search is case insensitive.

4 - Account Management

4.1 - Registration & account access

To start annotating in CVAT, you must create an account or log in to the existing one.

Check out:

• User registration
• User registration with social accounts
• Account access
• Password reset
• Change password

To create an account or log in, go to the CVAT Online login page:

User registration

To register:

1. Select Create an account.

   

2. Fill in all blank fields, accept terms of use, and select Create an account.

A username generates from the email automatically. You can edit it if needed.

User registration with social accounts

To register with Google or GitHub, select the button with the service name and follow the instructions.

Account access

To access your account:

1. Go to the login page.
2. Enter username or email. The password field will appear.
3. Enter the password and click Next.

To log in with Google or GitHub, select the button with the service name.

Password reset

To reset password:

1. Go to the CVAT Online page and select Forgot password?

   

2. Enter email you used for registration and select Send.

3. Open email and select on the link from CVAT.

4. Enter new password in both fields and select Change password.

   

Change password

To change password:

1. Log in to your CVAT account.

2. In the top right corner, select the username.

3. Select Change password.

4. Follow the instructions on the screen.

   

4.2 - User roles

CVAT offers two distinct types of roles:

• Global Roles: These are universal roles that apply to the entire system. Anyone who logs into the CVAT platform is automatically assigned a global role. It sets the basic permissions that every registered user has across CVAT, regardless of their specific tasks or responsibilities.
• Organization Roles: These roles determine what a user can do within the Organization, allowing for more tailored access based on the user’s specific duties and responsibilities.

Organization roles complement global roles by determining the visibility of different resources for example, tasks or jobs.

Limits: Limits are applicable to all users of CVAT Online using the Free plan and can be lifted upon choosing a subscription.

All roles are predefined and cannot be modified through the user interface. However, within the self-hosted solution, roles can be adjusted using .rego files stored in cvat/apps/*/rules/. Rego is a declarative language employed for defining OPA (Open Policy Agent) policies, and its syntax is detailed in the OPA documentation.

See:

• Global roles in CVAT
• Organization roles in CVAT
• Job Stage

Global roles in CVAT

CVAT has implemented three Global roles, categorized as user Groups. These roles are:

Organization roles in CVAT

Organization Roles are available only within the CVAT Organization.

Organization roles are assigned when users are invited to the Organization.

There are the following roles available in CVAT:

Job Stage

Job Stage can be assigned to any team member.

Stages are not roles.

Jobs can have an assigned user (with any role) and that Assignee will perform a Stage specific work which is to annotate, validate, or accept the job.

Job Stage can be:

Any Assignee can modify their assigned Stage specific functions via the annotation interface toolbar:

• Standard: switches interface to Annotation mode.
• Review: switches interface to the Validation mode.

4.3 - Organization

Organization is a feature for teams of several users who work together on projects and share tasks.

Create an Organization, invite your team members, and assign roles to make the team work better on shared tasks.

See:

• Personal workspace
• Create new organization
  • Switching between organizations
• Organization page
• Invite members into organization: menu and roles
  • Inviting members to Organization
  • Invitations list
  • Resending and removing invitations
• Delete organization

Personal workspace

The account’s default state is activated when no Organization is selected.

If you do not select an Organization, the system links all new resources directly to your personal account, that inhibits resource sharing with others.

When Personal workspace is selected, it will be marked with a tick in the menu.

Create new organization

To create an organization, do the following:

1. Log in to the CVAT.

2. On the top menu, click your Username > Organization > + Create.

   

3. Fill in the following fields and click Submit.

   

Upon creation, the organization page will open automatically.

For future access to your organization, navigate to Username > Organization

Switching between organizations

If you have more than one Organization, it is possible to switch between these Organizations at any given time.

Follow these steps:

1. In the top menu, select your Username > Organization.
2. From the drop-down menu, under the Personal space section, choose the desired Organization.

Click on it to see the Select organization dialog, and select organization from drop-down list.

Transfer tasks and projects between organizations

You can move high-level resources (projects and individual tasks) between organizations and the personal workspace.

To transfer a resource:

1. Open the Actions menu of the corresponding task or project.
2. In the Actions menu, select Organization (only visible if the resource can be transferred).
3. Choose the destination workspace in the selector.
4. A dialog will open. Confirm the transfer.
5. If the resource has attached to a cloud storage, choose how CVAT should handle it:
   • The current cloud storages will be detached anyway as they are not available in another workspace.
   • Move & Detach: After transferring, you can set a new cloud storage manually (only applicable for data source cloud storage in a task). Source and target cloud storages cannot be setup this way.
   • Move & Auto Match: During the transfer, CVAT will try finding a cloud storage, matching similar parameters in the target workspace. This option is only available if the resource has source or target cloud storage configured.

Organization page

Organization page is a place, where you can edit the Organization information and manage Organization members.

To go to the Organization page, do the following:

1. On the top menu, click your Username > Organization.
2. In the drop-down menu, select Organization.
3. In the drop-down menu, click Settings.

Invite members into organization: menu and roles

Invite members form is available from Organization page.

It has the following fields:

Members of Organization will appear on the Organization page:

The member of the organization can leave the organization by going to Organization page > Leave organization.

The organization owner can remove members, by clicking on the Bin icon.

Inviting members to Organization

To invite members to Organization do the following:

1. Go to the Organization page, and click Invite members.

2. Fill in the form (see below).

   

3. Click OK.

4. The person being invited will receive an email with the link.

   

5. Person must click the link and:

   1. If the invitee does not have the CVAT account, then set up an account.
   2. If the invitee has a CVAT account, then log in to the account.

Invitations list

User can see the list of active invitations.

To see the list, Go to Username > Organization > Invitations.

You will see the page with the list of invitations.

You will also see pop-up notification the link to the page with invitations list.

Resending and removing invitations

The organization owner and maintainers can remove members, by clicking on the three dots, and selecting Remove invitation

Delete organization

You can remove an organization that you created.

To remove an organization, do the following:

1. Go to the Organization page.
2. In the top-right corner click Actions > Remove organization.
3. Enter the short name of the organization in the dialog field.
4. Click Remove.

4.4 - Subscription management

This article provides tips on how to effectively manage your CVAT Online subscriptions, including tracking expenses and canceling unnecessary subscriptions, to optimize your finances and save time.

Whether you’re a business owner or an individual, you’ll learn how to take control of your subscriptions and manage them.

See:

• Available paid plans
  • Monthly plans
  • Annual plans
• Billing
  • How to add VAT/tax and other information to the CVAT Online invoice before the first payment?
  • How to update VAT/tax information and other details for upcoming invoices from CVAT Online?
  • Can a paid invoice be modified?
  • How can I get a quote before I subscribe? How to add a PO number to my invoices?
  • Can you sign an agreement before I subscribe?
  • Can you handle a bank transfer with 30-day payment terms?
  • Where can I find my invoices?
  • I am a student, can I have a discount or free access?
• Payment methods
  • Paying with bank transfer
  • How to change the payment method?
• Adding and removing team members
• Change plan
  • How to change the plan from Solo to Team?
  • How to switch from a monthly subscription to an annual one?
• Can I subscribe to several plans?
• Cancel plan
  • What will happen to my data?
  • How to cancel any plan?
  • How can I get a refund?
• Plan renewal
• Subscription management video tutorial

Available paid plans

This section outlines the paid plans available on CVAT Online.

Monthly plans

Annual plans

Whether you’re a new user, or have a subscription to Team or Solo plan, you can subscribe to our annual plan and save up to 30% on CVAT Online usage costs.

The annual subscription offers all the benefits of our paid plans but at a more affordable monthly rate.

For more information, see How to switch from monthly subscription to annual?

Billing

This section describes the billing model and gives short a description of limitations for each plan.

There are two types of subscriptions available for both the Solo and Team plans: monthly and annual.

For more information, see: Pricing Plans

How to add VAT/tax and other information to the CVAT Online invoice before the first payment?

To ensure VAT (tax) information and other relevant details are included on your CVAT Online invoices, it’s important to add this information before making the first payment.

Here’s how you can do it:

1. Sign up for a CVAT Online account and log in.
2. (Optional) If you add the VAT/tax number to the organization, first create an organization and switch to an Organization account.
3. Navigate to the top right corner, next to the nickname, click on the arrow > upgrade to the plan.
4. Switch on the I would like the invoice to include additional data (address, phone number, VAT information) toggle, select the best payment period for you, and click Get Started.

5. You will see the billing page:

• Phone number (1).
• Billing Address: Enter the billing address you want to appear on the invoice    in the address field (2).
• VAT Information and Business Name: Select the checkbox I am purchasing as a business and enter your VAT and business name information (3).

6. Select checkbox I agree to refund policy (4).

   Note

   Please read the Refund policy before selecting the checkbox.

7. Click Pay & Subscribe.

All information you’ve added will appear on the billing page and in the invoice.

By following these steps, you can seamlessly add VAT and other crucial information to your invoices, making your financial transactions with CVAT Online transparent and compliant.

How to update VAT/tax information and other details for upcoming invoices from CVAT Online?

In the top right corner, near the nickname, click on the arrow > manage plan.

You will see the Stripe page. Go to the Billing Information > Update Information.

Can a paid invoice be modified?

Once an invoice has been paid, it is not possible to modify it. This restriction is due to the limitations of the payment processing platform used, which in the case of CVAT Online, is Stripe.

Stripe’s policy dictates that revisions to an invoice can only be made before payment. For more comprehensive information on this policy, please refer to Stripe’s official documentation on invoice edits at their website.

How can I get a quote before I subscribe? How to add a PO number to my invoices?

If you require a quote from CVAT Online for payment via bank transfer, certain criteria must be met:

• The total subscription cost must be $396 and up per year.
• Quotes are available exclusively for annual subscriptions.

Should you meet these requirements, please write to support@cvat.ai

Can you sign an agreement before I subscribe?

Sign of specific agreements and approvals are available if you meet specific criteria (the total subscription cost must be $10,000 and up per year), for more details contact support@cvat.ai

Can you handle a bank transfer with 30-day payment terms?

Yes, it is available if you fit the quota criteria, for details contact support@cvat.ai.

Where can I find my invoices?

In the top right corner, near the nickname, click on the arrow > manage plan.

You will see the Stripe page. At the bottom of the page, you will see the Invoice History section with all invoices.

Invoices are automatically sent to the account owner’s address used for the registration.

To see the invoice click on the Show Invoice Icon icon.

I am a student, can I have a discount or free access?

To consider your request for a discount, we’d need a few details from you:

• A copy of your valid student ID or any document confirming your university affiliation.
• Your university advisor’s contact details.
• The name and contact information of the dean of your faculty.
• A brief outline of your project plan. This helps us understand how we might collaborate  on a joint marketing statement highlighting your use of CVAT Online, and how it can benefit your project.
• We’d also appreciate a positive LinkedIn post about your experience using CVAT Online, making sure to tag @CVAT.ai.

All these details must be sent to support@cvat.ai. Once we have this information, we’ll gladly offer you a 50% discount for one year.

Payment methods

This section describes how to change or add payment methods.

Paying with bank transfer

To pay with a bank transfer:

1. Go to the Upgrade to Solo/Team plan> Get started.
2. Click US Bank Transfer.
3. Upon successful completion of the payment, you will receive a receipt via email.

How to change the payment method?

In the top right corner, near the nickname, click on the arrow > manage plan > +Add Payment Method

Adding and removing team members

Team plan is for collaboration. To add members to your Organization, go to the Manage Team plan > Update quantity.

If you’ve added a user before the current billing period ends, the payment will be prorated for the remaining time until the next billing cycle begins. From the following month onward, the full payment will be charged.

In case you removed the user before the current billing period ends, funds will not be returned to your account, but next month you will pay less by the amount of unused funds.

Change plan

How to change the plan from Solo to Team?

The procedure is the same for both Solo and Team plans.

If for some reason you want to change your plan, you need to:

1. Unsubscribe from the previous plan.
2. If you need a refund, contact us at support@cvat.ai.
3. Subscribe to a new plan.

How to switch from a monthly subscription to an annual one?

If you have monthly subscription, and wish to switch to the Annual plan, please follow these steps:

1. In the top-right corner, near the nickname, click on the arrow.
2. Select Manage Solo/Team Plan.
3. On the Stripe page that appears, click Update Plan.

4. Choose Yearly and then click Continue.

The price will be adjusted according to the number of members, selected in the Quantity field (if updated), taking into account the amount of money that was not spent in the current period.

Upon payment, your subscription will be renewed and the start date will be reset to the day you switch to the new plan.

Can I subscribe to several plans?

Paid plans are not mutually exclusive. You can have several active subscriptions, for example, the Solo plan and several Team plans for different organizations.

Cancel plan

This section describes how to cancel your CVAT subscription and what will happen to your data.

What will happen to my data?

Once you have terminated your subscription, your data will remain accessible within the system for a month. During this period, you will be unable to add new tasks and free plan limits will be applied.

In case you possess a substantial amount of data, it will be switched to read-only mode. It means you will not be able to save annotations, add any resources, and so on.

Following the one month, you will receive a notification requesting you to either remove the excess data or it will be deleted automatically.

How to cancel any plan?

To cancel the plan, in the top right corner, near the nickname, click on the arrow> manage plan > Cancel plan

Please, fill out the feedback form, to help us improve our platform.

How can I get a refund?

To understand if you are eligible for a refund, see Refund policy.

1. Cancel the subscription before asking for a refund.
2. Contact our support team at support@cvat.ai or use the “Support” option in the app.cvat.ai interface.
3. Provide your account details and a brief explanation of the reason for the refund:
   • Send us your last invoice.
   • Send us the username and e-mail address you’ve used to register in CVAT Online.

Our team will review your request. We may request additional information if needed. Once approved, the refund will be processed to your original payment method within 5-10 business days.

Plan renewal

To renew your CVAT Online subscription, in the top right corner, near the nickname, click on the arrow> manage plan > Renew plan.

Subscription management video tutorial

4.5 - SSO configuration

CVAT supports Single Sign-On (SSO) using both OpenID Connect (OIDC) and Security Assertion Markup Language (SAML) protocols.

To configure SSO, complete the following 2 main steps:

1. Configure the Identity Provider (IdP) — set up an application on your IdP platform.
2. Update the CVAT configuration — provide the necessary identity provider settings in the CVAT configuration file.

If the application is already configured, refer to the Configuring SSO in CVAT section. Otherwise, you may follow one of the detailed platform-specific guides to set up such an application:

• Microsoft Azure
• Okta
• Auth0
• keycloak

Platform specific IdP configuration

Microsoft Azure

OpenID Connect

Follow these steps to configure an application on the Microsoft Azure platform and integrate it with CVAT:

Step 1: Register an OIDC-based application

To start, log into your Microsoft Azure Portal. Once you’re in:

1. Navigate to the Microsoft Entra ID service -> App registrations section in the menu on the left.

2. Click on the + New registration button.

3. Enter application name.

4. Select Supported account types based on your needs.

5. Add Redirect URI: choose Web platform and set <scheme:cvat_domain>/api/auth/oidc/<idp-id:azure-oidc>/login/callback/ to the value field.

   

6. Click on the Register button.

You’ve created an app, now you should configure the credentials for it.

Step 2: Configure credentials

1. Navigate to the Overview tab of your newly created application.
2. In the Client credentials section, click the Add a certificate or secret link. This will take you to the Certificates & secrets page.
3. Click + New client secret.
4. In the popup form, enter a description and select an expiration period, then click Add.

The newly created secret will appear in the list. Make sure to copy the value now — you won’t be able to see it again later.

Step 3: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:azure-oidc>
      protocol: OIDC
      name: Azure OIDC-based IdP
      server_url: https://<Directory (tenant) ID>/v2.0/
      client_id: <Secret ID>
      client_secret: <Secret Value>
      email_domain: <company_email_domain>

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

SAML

Follow these steps to configure an application on the Microsoft Azure platform and integrate it with CVAT:

Step 1: Register an SAML-based application

To start, log into your Microsoft Azure Portal. Once you’re in:

1. Navigate to the Microsoft Entra ID service -> Enterprise applications section in the menu on the left.
2. Click + New application and enter a name for the application in the popup window, then click Create.

You’ve created an app, now you should finalize its configuration and assign users or groups.

Step 2: Configure a created application

1. Navigate to the Single sign-on section in the menu on the left.
2. Choose the SAML protocol as the single sign-on method.
3. Edit Basic SAML Configuration:
   • Identifier (Entity ID): <scheme:cvat_domain>/api/auth/saml/<idp-id:azure-saml>/metadata/
   • Reply URL (Assertion Consumer Service URL): <scheme:cvat_domain>/api/auth/saml/<idp-id:azure-saml>/acs/
   • Save changes
4. Edit Attributes & Claims by adding a new uid claim:
   • Name: uid
   • Namespace: http://schemas.xmlsoap.org/ws/2005/05/identity/claims
   • Source: attribute
   • Source attribute: user.objectid

Step 3: Assign users and groups

At this point, no users or groups have been assigned to the application. To grant access:

1. Navigate to the Users and groups section of the application.
2. Click the + Add user/group button.
3. Select the users or groups you want to assign.
4. Confirm selection.

The selected users or groups will now appear in the assignment list.

That’s it, now we can move on to the configuration in CVAT.

Step 4: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:azure-saml>
      protocol: SAML
      name: Azure SAML-based IdP
      entity_id: <Microsoft Entra Identifier> (https://sts.windows.net/<tenantId>/)
      metadata_url: <App Federation Metadata Url>

      attribute_mapping:
        uid: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/uid
        username: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier
        email: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
        first_name: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname
        last_name: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname
        # email_verified: it is not possible to configure SAML-based application to send this claim to the SP

      email_domain: <company_email_domain>

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

Okta

OpenID Connect

Follow these steps to configure an application on the Okta platform and integrate it with CVAT:

Step 1: Register an OIDC-based application

To start, log into your Okta admin dashboard. Once you’re in:

1. Navigate to the Applications section in the menu on the left.

2. Click on the Create App integration button.

3. Select OIDC - OpenID Connect as a sign-in method and Web Application type.

4. Fill the form with the following content:

   • App integration name: enter a name for the application
   • Sign-in redirect URIs: <scheme:cvat_domain>/api/auth/oidc/<idp-id:okta-oidc>/login/callback/
   • Select option in the Controlled access to match your requirements. In this example, we’ll use Skip group assignment for now.

   

You’ve created and configured the app, now you should assign users or groups to the application.

Step 2: Assign users or groups

At this point, no users or groups have been assigned to the application. To grant access:

1. Navigate to the Assignments tab of the application.
2. Click the Assign button and select Assign to People or Assign to Groups based on your needs.
3. Identify the users or groups you want to assign, then click assign.

The selected users or groups will now appear in the assignment list.

Step 3: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:okta-oidc>
      protocol: OIDC
      name: Okta OIDC-based IdP
      server_url: https://<okta_domain>/
      client_id: <client_id>
      client_secret: <client_secret>
      email_domain: <company_email_domain>

Tip

Actual Client ID and Client secret key values may be found on the General tab of the created application

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

SAML

Follow these steps to configure an application on the Okta platform and integrate it with CVAT:

Step 1: Register an SAML-based application

To start, log into your Okta admin dashboard. Once you’re in:

1. Navigate to the Applications section in the menu on the left.

2. Click on the Create App integration button.

3. Select SAML 2.0 as a sign-in method, then click Next.

4. Fill the form with the general settings and go to the next configuration step.

5. On the Configure SAML form set the following fields:

   • Single sign-on URL: <scheme:cvat_domain>/api/auth/saml/<idp-id:okta-saml>/acs/
   • Audience URI (SP Entity ID: <scheme:cvat_domain>/api/auth/saml/<idp-id:okta-saml>/metadata/

6. Define attribute statements that will be shared with CVAT. In our example we will use the Basic attribute name format and set the mapping as shown below:

   • firstName: user.firstName
   • lastName: user.lastName
   • username: user.login
   • email: user.email
   • uid: user.getInternalProperty("id")

   

   Tip

   If attribute mapping needs to be adapted, follow the official documentation on how to configure Attribute Statements

7. Navigate to the next configuration step and fill the Feedback form.

You’ve created and configured the app. You can now either complete an optional step to simplify the login process in CVAT or proceed directly to the CVAT configuration step.

Step 2: Simplify login process

If CVAT is configured to require email verification, it expects the Identity Provider to include the email_verified claim. However, Okta does not send this claim by default. As a result, users will receive a confirmation email with a verification link.

There is an option to include email verification claim on the sign-in step:

1. Add one more mapping emailVerified -> user.emailVerified on SAML-based application configuration step:
   1. Navigate to the SAML Settings on the General tab and click Edit.
   2. Add one more attribute mapping as it was described in the app configuration step.
2. Add custom user attribute emailVerified:
   • Navigate to the Directory section in the menu on the left -> Profile Editor item
   • Select the default user profile from the list (User (default))
   • Click + Add Attribute
   • Fill out the form with your desired values, making sure to select the boolean data type
   • Click Save
3. Update user profiles:
   • Navigate to the People section in the menu on the left
   • Set the value for the recently created attribute for each person

Step 3: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:okta-saml>
      protocol: SAML
      name: Okta SAML-based Identity Provider
      entity_id: <Issuer>
      metadata_url: <Metadata URL>

      attribute_mapping:
        uid: uid
        username: username
        email: email
        first_name: firstName
        last_name: lastName
        email_verified: emailVerified # if configured

      email_domain: <company_email_domain>

Tip

Metadata URL and Issuer values may be found on the Sign On tab of the application setting

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

Auth0

OpenID Connect

Follow these steps to configure an application in the Auth0 platform and integrate it with CVAT:

Step 1: Register an OIDC-based application

To start, log into your Auth0 dashboard. Once you’re in:

1. Navigate to the Applications section in the menu on the left, click + Create Application.
2. Enter a name for the application and choose the Regular Web Applications type, then click Create.

You’ve created an app, now you should finalize its configuration.

Step 2: Configure a created application

1. In the Settings tab of your new application, scroll down to the Application URIs section.
2. Add <scheme:cvat_domain>/api/auth/oidc/<idp-id:auth0-oidc>/login/callback/ to the Allowed Callback URLs.
3. Save changes.

That’s it, now we can move on to the configuration in CVAT.

Step 3: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:auth0-oidc>
      protocol: OIDC
      name: Auth0 OIDC-based IdP
      server_url: https://<auth0_domain>/
      client_id: <client_id>
      client_secret: <client_secret>
      email_domain: <company_email_domain>

Tip

Client ID, Client Secret and Domain can be found in the Basic Information section of application settings

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

SAML

Follow these steps to configure an application in the Auth0 platform and integrate it with CVAT:

Step 1: Register an SAML-based application

To start, log into your Auth0 dashboard. Once you’re in:

1. Navigate to the Applications section in the menu on the left, click + Create Application.
2. Enter a name for the application and choose the Regular Web Applications type, then click Create.

You’ve created an app, now you should finalize its configuration.

Step 2: Configure a created application

1. Navigate to the Addons tab of the created application and click on the SAML2 WEB APP button.

2. Open the Settings tab in the popup window and set the following configuration:

   • Application Callback URL: <scheme:cvat_domain>/api/auth/saml/<idp-id:auth0-saml>/acs/
   • Settings: enter a JSON object like the following:

   {
     "audience": "<scheme:cvat_domain>/api/auth/saml/<idp-id:auth0-saml>/metadata/",
     "recipient": "<scheme:cvat_domain>/api/auth/saml/<idp-id:auth0-saml>/acs/",
     "destination": "<scheme:cvat_domain>/api/auth/saml/<idp-id:auth0-saml>/acs/",
     "mappings": {
       "user_id": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier",
       "email": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress",
       "nickname": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/username",
       "given_name": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname",
       "family_name": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname",
       "email_verified": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailverified"
     },
     "createUpnClaim": false,
     "passthroughClaimsWithNoMapping": false,
     "mapIdentities": false
   }
   

3. Scroll down and click Enable.

That’s it, now we can move on to the configuration in CVAT.

Step 3: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:auth0-saml>
      protocol: SAML
      name: Auth0 SAML-based IdP
      entity_id: <Issuer>
      metadata_url: <Metadata URL>

      attribute_mapping:
        uid: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier
        username: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/username
        email: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
        first_name: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname
        last_name: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname
        email_verified: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailverified

      email_domain: <company_email_domain>

Tip

Actual Metadata URL and Issuer values may be found on the Usage tab of the SAML2 Web App plugin

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

Keycloak

To configure SSO in terms of Keycloak we need to create a client.

OpenID Connect

Follow these steps to do that:

Step 1: Register an OIDC-based client

To start, go to the Keycloak service (by default it is listening for HTTP and HTTPS requests using the ports 8080 and 8443, respectively) and log into your admin account. Once you’re in:

1. Under the desired realm navigate to the Clients section and click create client.
2. Fill out the general client settings:
   • Client type: OpenID Connect
   • Client ID: enter client identifier
   • Enter a name for the client, e.g. OIDC-based client
3. In the next step, enable the Client authentication toggle.
4. In the Login settings section, provide the following values:
   • Home URL: <scheme:cvat_domain>
   • Valid redirect URIs: <scheme:cvat_domain>/api/auth/oidc/<idp-id:keycloak-oidc>/login/callback/
   • Web origins: <scheme:cvat_domain>

That’s it, now we can move on to the configuration in CVAT.

Step 2: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:keycloak-oidc>
      protocol: OIDC
      name: Keycloak OIDC-based Identity Provider
      server_url: <scheme:keycloak_domain>/realms/<custom_realm>/.well-known/openid-configuration
      client_id: <Client ID>
      client_secret: <Client Secret>
      email_domain: <company_email_domain>

Tip

Actual Client Secret value can be found on the Credentials tab of the created OIDC client

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

SAML

Follow these steps to configure a client:

Step 1: Register a SAML-based client

To start, go to the Keycloak service (by default it is listening for HTTP and HTTPS requests using the ports 8080 and 8443, respectively) and log into your admin account. Once you’re in:

1. Under the desired realm navigate to the Clients section and click create client.
2. Fill out the general client settings:
   • Client type: SAML
   • Set the Clint ID the URL: <scheme:cvat_domain>/api/auth/saml/<idp-id:keycloak-saml>/metadata/
   • Enter a name for the client, e.g. SAML client
3. In the Login settings section, provide the following values:
   • Home URL: <scheme:cvat_domain>
   • Valid redirect URIs: <scheme:cvat_domain>/api/auth/saml/<idp-id:keycloak-saml>/acs/

You’ve created a client, now you should finalize its configuration.

Step 2: Configure a created client

1. Navigate to the general settings of the created client, scroll down to the SAML capabilities section.
2. Update the following parameters:
   • Name ID format: email
   • Force name ID format: On
3. Navigate to the Keys tab and enable the Client signature required toggle.
4. Configure attributes & claims:

   1. Navigate to the Client scopes tab on the created client -> dedicated scopes for the client. You will see that there is no configured mappers.

   2. Set up mappers for the following attributes:

      • uid
      • first_name
      • last_name
      • username
      • email

      For attributes like email, first name, and last name, you can either

      • Use the predefined mappers
      • Or follow the manual configuration steps to create them yourself.

      To configure other mappers click Configure a new mapper if it is a first mapper or Add mapper -> By configuration and then select User Property.

      For instance, to configure a mapper for the username attribute, fill in the form as it is done below:

      • Name: username
      • Property: username
      • SAML Attribute Name: usernameAttribute

That’s it, now we can move on to the configuration in CVAT.

Step 3: Configure CVAT

Utilize the example below as a template for your configuration:

sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: <idp-id:keycloak-saml>
      protocol: SAML
      name: Keycloak SAML-based Identity Provider
      entity_id: <scheme:keycloak_domain>/realms/<custom_realm>
      metadata_url: <scheme:keycloak_domain>/realms/<custom_realm>/protocol/saml/descriptor

      attribute_mapping:
        uid: uidAttribute
        email_verified: emailVerifiedAttribute
        email: emailAttribute
        last_name: lastNameAttribute
        first_name: firstNameAttribute
        username: usernameAttribute

      email_domain: <company_email_domain>

Tip

Actual Metadata URL may be found in the Realm settings on the General tab

You can now proceed to start CVAT. For additional CVAT configuration details, refer to Configuring SSO in CVAT.

Configuring SSO in CVAT

CVAT provides a dedicated configuration file to customize the login and registration flow. The sso section of this file specifies which external Identity Provider (IdP) integrations are enabled. To set up SSO, you typically create a custom YAML configuration file (e.g., auth_config.yml) and supply its path when starting CVAT.

SSO settings

---
sso:
  enabled: true|false
  selection_mode: email_address|lowest_weight
  enable_pkce: true|false
  ...

IdP Configuration Structure

To integrate an Identity Provider, you must define its configuration block under the identity_providers section in the CVAT config file. Each provider’s configuration includes both general and protocol-specific settings.

Additionally, each IdP configuration must include several protocol-specific parameters:

• OpenID Connect
• SAML

Below are examples of SSO configuration file for both protocols:

• Integrate OIDC-based IdP
• Integrate SAML-based IdP

---
sso:
  enabled: true
  selection_mode: email_address
  identity_providers:
    - id: oidc-idp
      protocol: OIDC
      name: OIDC-based IdP
      server_url: https://example.com
      client_id: xxx
      client_secret: xxx
      email_domain: example.com

 ---
 sso:
   enabled: true
   selection_mode: lowest_weight
   identity_providers:
     - id: saml-idp
       protocol: SAML
       name: SAML-based IdP
       entity_id: <idp-entity-id>
       weight: 1
       # specify only metadata_url or sso_url and x509_cert
       metadata_url: http://example.com/path/to/saml/metadata/
       sso_url: <Login URL>
       x509_cert: |
         -----BEGIN CERTIFICATE-----
         certificate content
         -----END CERTIFICATE-----         

       attribute_mapping:
         uid: uidAttribute
         email_verified: emailVerifiedAttribute
         email: emailAttribute
         last_name: lastNameAttribute
         first_name: firstNameAttribute
         username: usernameAttribute

More information about OIDC-based and SAML-based IdP configuration expected by Django Allauth can be found here and here respectively.

Start CVAT

Once the configuration file is created, several environment variables must be exported before running CVAT:

export AUTH_CONFIG_PATH="<path_to_auth_config>"
export CVAT_HOST="<cvat_host>"
# cvat_port is optional
export CVAT_BASE_URL="<http|https>://${CVAT_HOST}:<cvat_port>"

Start the CVAT Enterprise instance as usual.

That’s it! The CVAT login page now should have the Continue with SSO option, allowing users to authenticate using the configured Identity Provider.

4.6 - Social auth configuration

You can now easily set up authentication with popular social services, which opens doors to such benefits as:

• Convenience: you can use the existing social service credentials to sign in to CVAT.
• Time-saving: with just two clicks, you can sign in without the hassle of typing in credentials, saving time and effort.
• Security: social auth service providers have high-level security measures in place to protect your accounts.

Currently, we offer three options:

• Authentication with Google
• Authentication with GitHub
• Authentication with Amazon Cognito

With more to come soon. Stay tuned!

Authentication with Google

To enable authentication, do the following:

1. Log in to the Google Cloud console

2. Create a project, and go to APIs & Services

3. On the left menu, select OAuth consent, then select User type (Internal or External), and click Create.

4. On the OAuth consent screen fill all required fields, and click Save and Continue.

5. On the Scopes screen, click Add or remove scopes and select auth/userinfo.email, auth/userinfo.profile, and openid. Click Update, and Save and Continue.
   For more information, see Configure Auth Consent.

6. On the left menu, click Credentials, on the top menu click + Create credentials, and select OAuth client ID.

7. From the Application Type select Web application and configure: Application name, Authorized JavaScript origins, Authorized redirect URIs.
   For example, if you plan to deploy CVAT instance on https://localhost:8080, add https://localhost:8080 to authorized JS origins and https://localhost:8080/api/auth/social/goolge/login/callback/ to redirect URIs.

8. Create configuration file in CVAT:

   1. Create the auth_config.yml file with the following content:

      ---
      social_account:
        enabled: true
        google:
          client_id: <some_client_id>
          client_secret: <some_client_secret>
      

   2. Set AUTH_CONFIG_PATH="<path_to_auth_config> environment variable.

9. In a terminal, run the following command:

   docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.override.yml up -d --build
   

Authentication with GitHub

There are 2 basic steps to enable GitHub account authentication.

1. Open the GitHub settings page.

2. On the left menu, click <> Developer settings > OAuth Apps > Register new application.
   For more information, see Creating an OAuth App

3. Fill in the name field, set the homepage URL (for example: https://localhost:8080), and authentication callback URL (for example: https://localhost:8080/api/auth/social/github/login/callback/).

4. Create configuration file in CVAT:

   1. Create the auth_config.yml file with the following content:

      ---
      social_account:
        enabled: true
        github:
          client_id: <some_client_id>
          client_secret: <some_client_secret>
      

   2. Set AUTH_CONFIG_PATH="<path_to_auth_config> environment variable.

5. In a terminal, run the following command:

   docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.override.yml up -d --build
   

Authentication with Amazon Cognito

To enable authentication with Amazon Cognito for your CVAT instance, follow these steps:

1. Create an Amazon Cognito pool (Optional)
2. Set up a new app client
3. Configure social authentication in CVAT

Now, let’s dive deeper into how to accomplish these steps.

Amazon Cognito pool creation

This step is optional and should only be performed if a user pool has not already been created. To create a user pool, follow these instructions:

1. Go to the AWS Management Console
2. Locate Cognito in the list of services
3. Click Create user pool
4. Fill in the required fields

App client creation

To create a new app client, follow these steps:

1. Go to the details page of the created user pool
2. Find the App clients item in the menu on the left
3. Click Create app client
4. Fill out the form as shown bellow:
   • Application type: Traditional web application
   • Application name: Specify a desired name, or leave the autogenerated one
   • Return URL (optional): Specify the CVAT redirect URL (<http|https>://<cvat_domain>/api/auth/social/amazon-cognito/login/callback/). This setting can also be updated or specified later after the app client is created.
5. Navigate to the Login pages tab of the created app client
6. Check the parameters in the Managed login pages configuration section and edit them if needed:
   • Allowed callback URLs: Must be set to the CVAT redirect URL
   • Identity providers: Must be specified
   • OAuth grant types: The Authorization code grant must be selected
   • OpenID Connect scopes: OpenID, Profile, Email scopes must be selected

Setting up social authentication in CVAT

To configure social authentication in CVAT, create a configuration file (auth_config.yml) with the following content:

---
social_account:
  enabled: true
  amazon_cognito:
    client_id: <client_id>
    client_secret: <client_secret>
    domain: <custom-domain> or
      https://<custom-cognito-prefix>.auth.us-east-1.amazoncognito.com

To find the client_id and client_secret values, navigate to the created app client page and check the App client information section. To find domain, look for the Domain item in the list on the left.

Once the configuration file is updated, several environment variables must be exported before running CVAT:

export AUTH_CONFIG_PATH="<path_to_auth_config>"
export CVAT_HOST="<cvat_host>"
# cvat_port is optional
export CVAT_BASE_URL="<http|https>://${CVAT_HOST}:<cvat_port>"

Start the CVAT enterprise instance as usual. That’s it! On the CVAT login page, you should now see the option Continue with Amazon Cognito.

5 - Dataset Management

5.1 - Dataset formats

In CVAT, you have the option to export data in various formats. The choice of export format depends on the type of annotation as well as the intended future use of the dataset.

The table below outlines the available formats for data export in CVAT.

5.1.1 - CVAT for image

This is CVAT’s native annotation format, which fully supports all of CVAT’s annotation features. It is ideal for creating data backups.

For more information, see:

• Format specifications
• Dataset examples

CVAT for image export

Applicable for all computer vision tasks in 2D except for Video Tracking.

• Supported annotations: Tags, Oriented Bounding Boxes, Bounding Boxes, Polygons, Polylines, Points, Cuboids, Ellipses, Skeletons, Masks.
• Attributes: Supported.
• Tracks: Supported (via the extra track_id attribute).

The downloaded file is a .zip archive with following structure:

taskname.zip/
├── images/
|   ├── img1.png
|   └── img2.jpg
└── annotations.xml

CVAT for video export

Applicable for all computer vision tasks in 2D except for Classification

• Supported annotations: Bounding Boxes, Oriented Bounding Boxes, Polygons, Polylines, Points, Cuboids, Ellipses, Skeletons, Masks.
• Attributes: Supported.
• Tracks: Supported.
• Shapes are exported as single-frame tracks

Downloaded file is a .zip archive with following structure:

taskname.zip/
├── images/
|   ├── frame_000000.png
|   └── frame_000001.png
└── annotations.xml

CVAT for video import

Uploaded file: either an .xml file or a .zip file with the contents described above.

Format specifications

Each format has X.Y version (e.g. 1.0). In general the major version (X) is incremented when the data format has incompatible changes and the minor version (Y) is incremented when the data format is slightly modified (e.g. it has one or several extra fields inside meta information). The document will describe all changes for all versions of XML annotation format.

Version 1.1

There are two different formats for images and video tasks at the moment. The both formats have a common part which is described below. From the previous version flipped tag was added. Also original_size tag was added for interpolation mode to specify frame size. In annotation mode each image tag has width and height attributes for the same purpose.

For what is rle, see Run-length encoding

<?xml version="1.0" encoding="utf-8"?>
<annotations>
  <version>1.1</version>
  <meta>
    <task>
      <id>Number: id of the task</id>
      <name>String: some task name</name>
      <size>Number: count of frames/images in the task</size>
      <mode>String: interpolation or annotation</mode>
      <overlap>Number: number of overlapped frames between segments</overlap>
      <bugtracker>String: URL on an page which describe the task</bugtracker>
      <flipped>Boolean: were images of the task flipped? (True/False)</flipped>
      <created>String: date when the task was created</created>
      <updated>String: date when the task was updated</updated>
      <labels>
        <label>
          <name>String: name of the label (e.g. car, person)</name>
          <type>String: any, bbox, cuboid, ellipse, mask, polygon, polyline, points, skeleton, tag</type>
          <attributes>
            <attribute>
              <name>String: attribute name</name>
              <mutable>Boolean: mutable (allow different values between frames)</mutable>
              <input_type>String: select, checkbox, radio, number, text</input_type>
              <default_value>String: default value</default_value>
              <values>String: possible values, separated by newlines
ex. value 2
ex. value 3</values>
            </attribute>
          </attributes>
          <svg>String: label representation in svg, only for skeletons</svg>
          <parent>String: label parent name, only for skeletons</parent>
        </label>
      </labels>
      <segments>
        <segment>
          <id>Number: id of the segment</id>
          <start>Number: first frame</start>
          <stop>Number: last frame</stop>
          <url>String: URL (e.g. http://cvat.example.com/?id=213)</url>
        </segment>
      </segments>
      <owner>
        <username>String: the author of the task</username>
        <email>String: email of the author</email>
      </owner>
      <original_size>
        <width>Number: frame width</width>
        <height>Number: frame height</height>
      </original_size>
    </task>
    <dumped>String: date when the annotation was dumped</dumped>
  </meta>
  ...
</annotations>

Annotation

Below you can find description of the data format for images tasks. On each image it is possible to have many different objects. Each object can have multiple attributes. If an annotation task is created with z_order flag then each object will have z_order attribute which is used to draw objects properly when they are intersected (if z_order is bigger the object is closer to camera). In previous versions of the format only box shape was available. In later releases mask, polygon, polyline, points, skeletons and tags were added. Please see below for more details:

<?xml version="1.0" encoding="utf-8"?>
<annotations>
  ...
  <image id="Number: id of the image (the index in lexical order of images)" name="String: path to the image"
    width="Number: image width" height="Number: image height">
    <box label="String: the associated label" xtl="Number: float" ytl="Number: float" xbr="Number: float" ybr="Number: float" occluded="Number: 0 - False, 1 - True" z_order="Number: z-order of the object">
      <attribute name="String: an attribute name">String: the attribute value</attribute>
      ...
    </box>
    <polygon label="String: the associated label" points="x0,y0;x1,y1;..." occluded="Number: 0 - False, 1 - True"
    z_order="Number: z-order of the object">
      <attribute name="String: an attribute name">String: the attribute value</attribute>
      ...
    </polygon>
    <polyline label="String: the associated label" points="x0,y0;x1,y1;..." occluded="Number: 0 - False, 1 - True"
    z_order="Number: z-order of the object">
      <attribute name="String: an attribute name">String: the attribute value</attribute>
      ...
    </polyline>
    <polyline label="String: the associated label" points="x0,y0;x1,y1;..." occluded="Number: 0 - False, 1 - True"
    z_order="Number: z-order of the object">
      <attribute name="String: an attribute name">String: the attribute value</attribute>
      ...
    </polyline>
    <points label="String: the associated label" points="x0,y0;x1,y1;..." occluded="Number: 0 - False, 1 - True"
    z_order="Number: z-order of the object">
      <attribute name="String: an attribute name">String: the attribute value</attribute>
      ...
    </points>
    <tag label="String: the associated label" source="manual or auto">
      <attribute name="String: an attribute name">String: the attribute value</attribute>
      ...
    </tag>
    <skeleton label="String: the associated label" z_order="Number: z-order of the object">
      <points label="String: the associated label" occluded="Number: 0 - False, 1 - True" outside="Number: 0 - False, 1 - True" points="x0,y0;x1,y1">
        <attribute name="String: an attribute name">String: the attribute value</attribute>
      </points>
      ...
      <attribute name="String: an attribute name">String: the attribute value</attribute>
      ...
    </skeleton>
    <mask label="String: the associated label" source="manual or auto" occluded="Number: 0 - False, 1 - True" rle="RLE mask" left="Number: left coordinate of the image where the mask begins" top="Number: top coordinate of the image where the mask begins" width="Number: width of the mask" height="Number: height of the mask" z_order="Number: z-order of the object">
    </mask>
    ...
  </image>
  ...
</annotations>

Example:

<?xml version="1.0" encoding="utf-8"?>
<annotations>
  <version>1.1</version>
  <meta>
    <task>
      <id>4</id>
      <name>segmentation</name>
      <size>27</size>
      <mode>annotation</mode>
      <overlap>0</overlap>
      <bugtracker></bugtracker>
      <flipped>False</flipped>
      <created>2018-09-25 11:34:24.617558+03:00</created>
      <updated>2018-09-25 11:38:27.301183+03:00</updated>
      <labels>
        <label>
          <name>car</name>
          <attributes>
          </attributes>
        </label>
        <label>
          <name>traffic_line</name>
          <attributes>
          </attributes>
        </label>
        <label>
          <name>wheel</name>
          <attributes>
          </attributes>
        </label>
        <label>
          <name>plate</name>
          <attributes>
          </attributes>
        </label>
        <label>
          <name>s1</name>
          <type>skeleton</type>
          <attributes>
          </attributes>
          <svg>&lt;line x1="36.87290954589844" y1="47.732025146484375" x2="86.87290954589844" y2="10.775501251220703" stroke="black" data-type="edge" data-node-from="2" stroke-width="0.5" data-node-to="3"&gt;&lt;/line&gt;&lt;line x1="25.167224884033203" y1="22.64841079711914" x2="36.87290954589844" y2="47.732025146484375" stroke="black" data-type="edge" data-node-from="1" stroke-width="0.5" data-node-to="2"&gt;&lt;/line&gt;&lt;circle r="1.5" stroke="black" fill="#b3b3b3" cx="25.167224884033203" cy="22.64841079711914" stroke-width="0.1" data-type="element node" data-element-id="1" data-node-id="1" data-label-name="1"&gt;&lt;/circle&gt;&lt;circle r="1.5" stroke="black" fill="#b3b3b3" cx="36.87290954589844" cy="47.732025146484375" stroke-width="0.1" data-type="element node" data-element-id="2" data-node-id="2" data-label-name="2"&gt;&lt;/circle&gt;&lt;circle r="1.5" stroke="black" fill="#b3b3b3" cx="86.87290954589844" cy="10.775501251220703" stroke-width="0.1" data-type="element node" data-element-id="3" data-node-id="3" data-label-name="3"&gt;&lt;/circle&gt;</svg>
        </label>
        <label>
          <name>1</name>
          <type>points</type>
          <attributes>
          </attributes>
          <parent>s1</parent>
        </label>
        <label>
          <name>2</name>
          <type>points</type>
          <attributes>
          </attributes>
          <parent>s1</parent>
        </label>
        <label>
          <name>3</name>
          <type>points</type>
          <attributes>
          </attributes>
          <parent>s1</parent>
        </label>
      </labels>
      <segments>
        <segment>
          <id>4</id>
          <start>0</start>
          <stop>26</stop>
          <url>http://localhost:8080/?id=4</url>
        </segment>
      </segments>
      <owner>
        <username>admin</username>
        <email></email>
      </owner>
    </task>
    <dumped>2018-09-25 11:38:28.799808+03:00</dumped>
  </meta>
  <image id="0" name="filename000.jpg" width="1600" height="1200">
    <box label="plate" xtl="797.33" ytl="870.92" xbr="965.52" ybr="928.94" occluded="0" z_order="4">
    </box>
    <polygon label="car" points="561.30,916.23;561.30,842.77;554.72,761.63;553.62,716.67;565.68,677.20;577.74,566.45;547.04,559.87;536.08,542.33;528.40,520.40;541.56,512.72;559.10,509.43;582.13,506.14;588.71,464.48;583.23,448.03;587.61,434.87;594.19,431.58;609.54,399.78;633.66,369.08;676.43,294.52;695.07,279.17;703.84,279.17;735.64,268.20;817.88,264.91;923.14,266.01;997.70,274.78;1047.04,283.55;1063.49,289.04;1090.90,330.70;1111.74,371.27;1135.86,397.59;1147.92,428.29;1155.60,435.97;1157.79,451.32;1156.69,462.28;1159.98,491.89;1163.27,522.59;1173.14,513.82;1199.46,516.01;1224.68,521.49;1225.77,544.52;1207.13,568.64;1181.91,576.32;1178.62,582.90;1177.53,619.08;1186.30,680.48;1199.46,711.19;1206.03,733.12;1203.84,760.53;1197.26,818.64;1199.46,840.57;1203.84,908.56;1192.88,930.49;1184.10,939.26;1162.17,944.74;1139.15,960.09;1058.01,976.54;1028.40,969.96;1002.09,972.15;931.91,974.35;844.19,972.15;772.92,972.15;729.06,967.77;713.71,971.06;685.20,973.25;659.98,968.86;644.63,984.21;623.80,983.12;588.71,985.31;560.20,966.67" occluded="0" z_order="1">
    </polygon>
    <polyline label="traffic_line" points="462.10,0.00;126.80,1200.00" occluded="0" z_order="3">
    </polyline>
    <polyline label="traffic_line" points="1212.40,0.00;1568.66,1200.00" occluded="0" z_order="2">
    </polyline>
    <points label="wheel" points="574.90,939.48;1170.16,907.90;1130.69,445.26;600.16,459.48" occluded="0" z_order="5">
    </points>
    <tag label="good_frame" source="manual">
    </tag>
    <skeleton label="s1" source="manual" z_order="0">
      <points label="1" occluded="0" source="manual" outside="0" points="54.47,94.81">
      </points>
      <points label="2" occluded="0" source="manual" outside="0" points="68.02,162.34">
      </points>
      <points label="3" occluded="0" source="manual" outside="0" points="125.87,62.85">
      </points>
    </skeleton>
    <mask label="car" source="manual" occluded="0" rle="3, 5, 7, 7, 5, 9, 3, 11, 2, 11, 2, 12, 1, 12, 1, 26, 1, 12, 1, 12, 2, 11, 3, 9, 5, 7, 7, 5, 3" left="707" top="888" width="13" height="15" z_order="0">
    </mask>
  </image>
</annotations>