site/content/en/docs/workspace/tasks-page.md
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 {{< ilink "/docs/dataset_management/import-datasets" "export/import datasets" >}}
section.Upload annotation upload annotations in a specific format.
More information is available in the {{< ilink "/docs/dataset_management/import-datasets" "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 {{< ilink "/docs/dataset_management/backup" "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
{{< ilink
"/docs/account_management/organization#transfer-tasks-and-projects-between-organizations"
"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 {{< ilink "/docs/annotation/manual-annotation/utilities/filter#sort-by" "sorting" >}}, {{< ilink "/docs/annotation/manual-annotation/utilities/filter#quick-filters" "quick filters" >}}, and filter.
{{% alert title="Note" color="primary" %}} Applying a filter disables the {{< ilink "/docs/annotation/manual-annotation/utilities/filter#quick-filters" "quick filter" >}}. {{% /alert %}}
The filter works similarly to the filters for annotation, you can create rules from properties, {{< ilink "/docs/annotation/manual-annotation/utilities/filter#supported-operators-for-properties" "operators" >}}, and values and group rules into {{< ilink "/docs/annotation/manual-annotation/utilities/filter#groups" "groups" >}}. For more details, consult the {{< ilink "/docs/annotation/manual-annotation/utilities/filter#create-a-filter" "filter section" >}}. Learn more about {{< ilink "/docs/annotation/manual-annotation/utilities/filter#date-and-time-selection" "date and time selection" >}}.
For clear all filters press Clear filters.
| Properties | Supported values | Description |
|---|---|---|
Dimension | 2D or 3D | Depends on the data format |
| (read more in {{< ilink "/docs/workspace/tasks-page#create-annotation-task" "creating an annotation task" >}}) | ||
Status | annotation, validation or completed | |
Data | video, images | Depends on the data format |
| (read more in {{< ilink "/docs/workspace/tasks-page#create-annotation-task" "creating an annotation task" >}}) | ||
Subset | test, train, validation or custom subset | {{< ilink "/docs/getting_started/vocabulary#subset" "learn more" >}} |
Assignee | username | Assignee is the user who is working on the project, task or job |
| (they are specified on task page) | ||
Owner | username | The user who owns the project, task, or job |
Last updated | last modified date and time (or value range) | The date can be entered in the dd.MM.yyyy HH:mm format |
| or by selecting the date in the window that appears | ||
| when you click on the input field | ||
ID | number or range of job ID | |
Project ID | number or range of project ID | |
Name | name | On the tasks page: name of the task, |
| on the project page: name of the project | ||
Project name | project name | Specified when creating a project, |
| can be changed on the ({{< ilink "/docs/workspace/projects" "project section" >}}) |
Select Open to go to {{< ilink "/docs/workspace/tasks-page#task-details-page" "task details" >}}.
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:
Change the task’s title.
Open Actions menu.
Change the issue tracker or open it if specified.
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.
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 {{< ilink "/docs/account_management/organization" "organization" >}} where the task is created.
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:
annotation, validation, or acceptance. This value affects the task progress bar.new, in progress, rejected, completed.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.
To start annotating in CVAT, you must create an annotation task and specify its parameters.
To create a task:
Next, specify the task parameters in the configurator:
In the Name field, enter the name of the new task.
(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.
<!-- TODO: replace the image with '/images/select_project.png' after updating screenshots -->{{% alert title="Note" color="primary" %}} 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. {{% /alert %}}
The label constructor menu will open:
In the Label name field, enter the name of the label.
(Optional) To limit the use of the label to a certain {{< ilink "/docs/annotation/annotation-editor/controls-sidebar#shapes" "shape tool" >}}, from the Label shape drop-down select the shape.
(Optional) Select the color for the label.
(Optional) Select Add an attribute and set up its properties.
Select Select files to upload files for annotation.
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.
or Submit and continue, to submit the configuration and start a new task.
Labels (or classes) are categories of objects that you can annotate.
Label shape limits the use of the label to certain {{< ilink "/docs/annotation/annotation-editor/controls-sidebar#shapes" "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:
sun with the Label shape type ellipsecar with the Label shape type anyAs 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 {{< ilink "/docs/annotation/annotation-editor/controls-sidebar" "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.
{{% alert title="Note" color="primary" %}} You cannot apply the Label shape to the AI and OpenCV tools, these tools will always be available. {{% /alert %}}
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.
{{% alert title="Note" color="primary" %}}
You cannot change the shape of the skeleton label.
The Label shape field for the skeleton label is disabled.
{{% /alert %}}
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:
age, gender, and color.pose, quality, and truncated.Added attributes will be available from the Objects menu:
To add an attribute:
Go to the Constructor tab and select Add attribute.
In the Name field, enter the attribute name.
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.
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.
To delete an attribute, select Delete attribute.
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: |
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.
{{% alert title="Note" color="primary" %}} Be careful with changing the raw specification of an existing task/project. Removing any "id" properties will lead to losing existing annotations. This property will be removed automatically from any text you insert to this field. {{% /alert %}}
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.
To create a 3D task, you must prepare an archive with one of the following directory structures.
{{% alert title="Note" color="primary" %}} You can't mix 2D and 3D data in the same task. {{% /alert %}}
{{< tabpane >}} {{< tab header="Velodyne" >}} 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 {{< /tab >}} {{< tab header="3D pointcloud" >}} 3D POINTCLOUD DATA FORMAT Structure: pointcloud/ 00001.pcd related_images/ 00001_pcd/ image_01.png # or any other image
{{< /tab >}} {{< tab header="3D Option 1" >}} 3D, DEFAULT DATAFORMAT Option 1 Structure: data/ image.pcd image.png
{{< /tab >}} {{< tab header="3D Option 2" >}} 3D, DEFAULT DATAFORMAT Option 2 Structure: data/ image_1/ image_1.pcd context_1.png # or any other name context_2.jpg
{{< /tab >}} {{< /tabpane >}}
Use advanced configuration to set additional parameters for the task and customize it to meet specific needs or requirements.
The following parameters are available:
| Element | Description |
|---|---|
| Sorting method | Note: Does not work for the video data. |
Several methods to sort the data.
For example, the sequence 2.jpeg, 10.jpeg, 1.jpeg after sorting will be:
For more information, see {{< ilink "/docs/dataset_management/data-on-fly" "Data preparation on the fly" >}}. |
| Image quality | CVAT has two types of data: original quality and compressed. Original quality images are used for dataset export
and automatic annotation. Compressed images are used only for annotations to reduce traffic between the server
and client side.
It is recommended to adjust the compression level only if the images contain small objects that are not
visible in the original quality.
Values range from 5 (highly compressed images) to 100 (not compressed). |
| Overlap size | Use this parameter to create overlapped segments, making tracking continuous from one segment to another.
Note that this functionality only works for bounding boxes.
This parameter has the following options:
Interpolation task (video sequence). If you annotate with a bounding box on two adjacent segments, they will be merged into a single bounding box. In case the overlap is zero or the bounding box is inaccurate (not enclosing the object properly, misaligned or distorted) on the adjacent segments, it may be difficult to accurately interpolate the object's movement between the segments. As a result, multiple tracks will be created for the same object.
Annotation task (independent images). If an object exists on overlapped segments with overlap greater than zero, and the annotation of these segments is done properly, then the segments will be automatically merged into a single object. If the overlap is zero or the annotation is inaccurate (not enclosing the object properly, misaligned, distorted) on the adjacent segments, it may be difficult to accurately track the object. As a result, multiple bounding boxes will be created for the same object.
If the annotations on different segments (on overlapped frames) are very different, you will have two shapes for the same object.
To avoid this, accurately annotate the object on the first segment and the same object on the second segment to create a track
between two annotations. |
| Segment size | Use this parameter to divide a dataset into smaller parts. For example, if you want to share a dataset among multiple
annotators, you can split it into smaller sections and assign each section to a separate job.
This allows annotators to work on the same dataset concurrently. |
| Start frame | Defines the first frame of the video. |
| Stop frame | Defines the last frame of the video. |
| Frame step | Use this parameter to filter video frames or images in a dataset. Specify frame step value to include only
certain frames or images in the dataset.
For example, if the frame step value is 25, the dataset will include every 25th frame or image. If a video
has 100 frames, setting the frame step to 25 will include only frames 1, 26, 51, 76, and 100 in the dataset.
This can be useful for reducing the size of the dataset, or for focusing on specific frames or images
of particular interest. |
| Chunk size | Defines amount of frames to be packed in a chunk when send from client to server.
The server defines automatically if the chunk is empty.
Recommended values: <li> 1080p or less: 36 <li> 2k or less: 8 <li>16 - 4k or less: 4 <li>8 - More: 1 - 4 |
| Issue tracker | Use this parameter to specify the issue tracker URL. |
| Source storage | Specify the source storage for importing resources like annotations and backups.
If the task was assigned to the project, use the Use project source storage toggle to determine whether to
use project values or specify new ones. |
| Target storage | Specify the target storage (local or cloud) for exporting resources like annotations and backups.
If the task is created in the project, use the Use project target storage toggle to determine whether to
use project values or specify new ones. |
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 {{< ilink "/docs/workspace/tasks-page" "tasks page" >}}.
Use Create multi tasks to create multiple video annotation tasks with the same configuration.
{{% alert title="Note" color="primary" %}} The Create multi tasks feature is available for videos only. {{% /alert %}}
Check out:
To create the multi tasks:
Next, specify the parameters in the task configurator:
In the Name field, enter the name of the new task:
{{index}} adds an index to the file in the set (starting from 0).{{file_name}} adds the file's name to the task's name.(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.
{{% alert title="Note" color="primary" %}} 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. {{% /alert %}}
On the Constructor tab, select Add label.
In the Label name field, enter the name of the label.
(Optional) Select the color for the label.
(Optional) Select {{< ilink "/docs/workspace/tasks-page#create-annotation-task#add-an-attribute" "Add an attribute" >}} and set up its properties.
Select {{< ilink "/docs/workspace/tasks-page#create-annotation-task#select-files" "Select files" >}} to upload files for annotation.
{{% alert title="Note" color="primary" %}} You cannot upload multiple tasks from the cloud storage. {{% /alert %}}
Select Submit N tasks
A step-by-step example for creating the multiple tasks:
In the Name field, enter the Create_multitask-{{index}}-{{file_name}}.
Add labels.
Select files. In case there are more than four files, only the total number of selected files will be displayed:
Select Submit N tasks
You will see a progress bar that shows the progress of the tasks being created:
Select Ok.
The result will look like the following:
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: <li> If you want to try again, click Retry failed tasks. <li> If you want to skip the file, click OK. |
Use advanced configuration to set additional parameters for the task and customize it to meet specific needs or requirements.
For more information, consult {{< ilink "/docs/workspace/tasks-page#advanced-configuration" "Advanced configuration" >}}
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.
Go to the Job annotation view and click on the Delete frame button (Alt+Del).
{{% alert title="Note" color="primary" %}} When you delete with the shortcut, the frame will be deleted immediately without additional confirmation. {{% /alert %}}
After that you will be asked to confirm frame deleting.
{{% alert title="Note" color="primary" %}} 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. {{% /alert %}}
When you delete a frame in a job with tracks, you may need to adjust some tracks manually. Common adjustments are:
If you need to enable showing the deleted frames, you can do it in the settings.
Go to the settings and chose Player settings.
Click on the Show deleted frames checkbox. And close the settings dialog.
Then you will be able to navigate through deleted frames. But annotation tools will be unavailable. Deleted frames differ in the corresponding overlay.
There are ways to navigate through deleted frames without enabling this option:
/api/tasks/{id}/jobs/{id}?frame={frame_id}.Navigation with step will not count deleted frames.
You can also restore deleted frames in the task.
Turn on deleted frames visibility, as it was told in the previous part, and go to the deleted frame you want to restore.
Click on the Restore icon. The frame will be restored immediately.