Usage
Create annotation project in CVAT
How to create and configure a project
To create an annotation project first select a dataset. Annotation projects can only be done in a dataset.
Once a dataset has been selected navigate to the cvat section. In this page you will be presented with all the annotation projetcts for the selected dataset.
How to create a project
Click the New project button and specify the following parameters:
-
In the Name field, enter the name of the new project.
-
(Optional) Add labels to the project. To add labels to the project click the Add labels to project panel and the label constructor will be presented.
-
On the Constructor tab, click Add label. You have to specify the label name, type and color. If any field is empty an error message will be displayed.
-
You can add attributes to a label you are creating. To do that click on the Add attrubutes to label button You have to specify the attibute name, its input type, its values and whether its mutable or not.
-
Once all the values to create a label are ok you can click on the Add label button. The label will be created and will be displayed over the label constructor. You can delete a label by clicking n the x button.
-
You can also create a label (or a group of labels) on the Raw tab. Here you can insert your label in JSON format.
-
Once everything is set you can click the Create project button. If there is any error on any filed you will see the error message and the project won’t be careated. Otherwise the project will be created and displayed as the first project of the page.
Actions on projects
Each project has three actions: see annotation tasks of the projects, edit the project and delete the project.
-
Delete project: Deletes the annotation project. You will be prompted with a dialog to confirm that you are going to delete the project.
-
Edit project: Edits the proyect. You can change the project name and add new labels to the project but you cannot delete or edit current project labels.
-
Tasks: Shows the tasks section. In this section you can see the annotation tasks for the selected project and create new tasks.
How to create a task
To create a new task, click on the new task button.
A wizzard will open With the following steps in order to create a task:
-
Select files
1.1 In the Name field, enter the name of the new task.
1.2 Click on on or multiple files to upload files for annotation. You can select dvc files or directories.
-
(Optional) Upload preannotations. This step enables you to add preannotations to your task in zip format. To add preannotations you also have to spectfy the dormat of the annotations on the zip file. If you dont want to add preannotations you can toggle off the preannotations switch.
-
Select a directory to sync your annotations. In this step you have to select a dvc syc directory. You will also be able to create a new directory and save your selection for your future tasks.
Once all the steps are correct you will be able to create a new task. If there is any errors a error message will be displayed on the step which contains the error and the task won’t be created.
While the new task is being created you will see a spinner loader and the creating task message and once the task is created the task will show up.
Actions on tasks
Each task has an actions menu with the following options:
-
Sync annootations: This option allows you to sync the annotations of a selected dvc folder into your project.
The sync status of the task will pass to synchronizing and after a while will finish.
-
Export annotations: With this option you can export the annotations of your task on the selected format as a zip file.
-
Import annotations: Here you can import annoations on zip format. Its important to note that your current annotations will be lost and replaced by the ones you are importing.
-
Delete task: Deletes a task. A confirm dialog will be shown.
