after that choose the manifest file and select the required files.
| My computer | Use this option to select files from your laptop or PC. <br> To select file: <br>1. Click on the **Select files** field: <br>. <br> 2. Select files to upload. |
For more information on how to attach cloud storage, see [attach cloud storage](/docs/manual/basics/attach-cloud-storage/)
| Connected file share | **Advanced option**. <br>Upload files from a local or cloud shared folder. <br>**Note**, that you need to mount a fileshare first. <br>For more information, see [Share path](/docs/administration/basics/installation/#share-path) |
| Remote source | Enter a list of URLs (one per line) in the field. |
| Cloud Storage | **Advanced option**. <br>To upload files from cloud storage, type the cloud storage name, choose the manifest file, and select the required files. <br> For more information, see [Attach cloud storage](/docs/manual/basics/attach-cloud-storage/) |
<!--lint enable maximum-line-length-->
### 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.
> **Note:** 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**.
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
### Data formats for a 3D task
To create a 3D task, you must prepare an archive with one of the following directory structures:
To create a 3D task, you must prepare an archive with one of the following directory structures.
> **Note:** You can't mix 2D and 3D data in the same task.
{{<tabpane>}}
{{<tabpane>}}
{{<tabheader="Velodyne">}}
{{<tabheader="Velodyne">}}
VELODYNE FORMAT
VELODYNE FORMAT
@ -108,6 +212,7 @@ To create a 3D task, you must prepare an archive with one of the following direc
related_images/
related_images/
00001_pcd/
00001_pcd/
image_01.png # or any other image
image_01.png # or any other image
{{</tab>}}
{{</tab>}}
{{<tabheader="3D Option 1">}}
{{<tabheader="3D Option 1">}}
3D, DEFAULT DATAFORMAT Option 1
3D, DEFAULT DATAFORMAT Option 1
@ -115,6 +220,7 @@ To create a 3D task, you must prepare an archive with one of the following direc
data/
data/
image.pcd
image.pcd
image.png
image.png
{{</tab>}}
{{</tab>}}
{{<tabheader="3D Option 2">}}
{{<tabheader="3D Option 2">}}
3D, DEFAULT DATAFORMAT Option 2
3D, DEFAULT DATAFORMAT Option 2
@ -124,137 +230,39 @@ To create a 3D task, you must prepare an archive with one of the following direc
image_1.pcd
image_1.pcd
context_1.png # or any other name
context_1.png # or any other name
context_2.jpg
context_2.jpg
{{</tab>}}
{{</tab>}}
{{</tabpane>}}
{{</tabpane>}}
> You can't mix 2D and 3D data in the same task.
## Advanced configuration
## Advanced configuration
Use advanced configuration to set additional parameters for the task
and customize it to meet specific needs or requirements.
### Sorting method
Option to sort the data. It is not relevant for videos.
For example, the sequence `2.jpeg, 10.jpeg, 1.jpeg` after sorting will be:
- `lexicographical`: 1.jpeg, 10.jpeg, 2.jpeg
- `natural`: 1.jpeg, 2.jpeg, 10.jpeg
- `predefined`: 2.jpeg, 10.jpeg, 1.jpeg
### Use zip/video chunks
Force to use zip chunks as compressed data. Cut out content for videos only.
### Use cache
Defines how to work with data. Select the checkbox to switch to the "on-the-fly data processing",
which will reduce the task creation time (by preparing chunks when requests are received)
and store data in a cache of limited size with a policy of evicting less popular items.
See more [here](/docs/manual/advanced/data_on_fly/).
### Image Quality
Use this option to specify quality of uploaded images.
The option helps to load high resolution datasets faster.
Use the value from `5` (almost completely compressed images) to `100` (not compressed images).
### Overlap Size
Use this option to make overlapped segments.
The option makes tracks continuous from one segment into another.
Use it for interpolation mode. There are several options for using the parameter:
- For an interpolation task (video sequence).
If you annotate a bounding box on two adjacent segments they will be merged into one bounding box.
If overlap equals to zero or annotation is poor on adjacent segments inside a dumped annotation file,
you will have several tracks, one for each segment, which corresponds to the object.
- For an annotation task (independent images).
If an object exists on overlapped segments, the overlap is greater than zero
and the annotation is good enough on adjacent segments, it will be automatically merged into one object.
If overlap equals to zero or annotation is poor on adjacent segments inside a dumped annotation file,
you will have several bounding boxes for the same object.
Thus, you annotate an object on the first segment.
You annotate the same object on second segment, and if you do it right, you
will have one track inside the annotations.
If annotations on different segments (on overlapped frames)
are very different, you will have two shapes for the same object.
This functionality works only for bounding boxes.
Polygons, polylines, points don't support automatic merge on overlapped segments
even the overlap parameter isn't zero and match between corresponding shapes on adjacent segments is perfect.
### Segment size
Use this option to divide a huge dataset into a few smaller segments.
For example, one job cannot be annotated by several labelers (it isn't supported).
Thus using "segment size" you can create several jobs for the same annotation task.
It will help you to parallel data annotation process.
### Start frame
Frame from which video in task begins.
### Stop frame
Frame on which video in task ends.
### Frame Step
Use this option to filter video frames.
For example, enter `25` to leave every twenty fifth frame in the video or every twenty fifth image.
### Chunk size
Defines a number of frames to be packed in a chunk when send from client to server.
Server defines automatically if empty.
Recommended values:
- 1080p or less: 36
- 2k or less: 8 - 16
- 4k or less: 4 - 8
- More: 1 - 4
### Dataset Repository
URL link of the repository optionally specifies the path to the repository for storage
(`default: annotation / <dump_file_name> .zip`).
The .zip and .xml file extension of annotation are supported.
Field format: `URL [PATH]` example: `https://github.com/project/repos.git [1/2/3/4/annotation.xml]`
Supported URL formats :
- `https://github.com/project/repos[.git]`
- `github.com/project/repos[.git]`
- `git@github.com:project/repos[.git]`
After the task is created, the synchronization status is displayed on the task page.
If you specify a dataset repository, when you create a task, you will see a message
about the need to grant access with the ssh key.
This is the key you need to [add to your github account](https://github.com/settings/keys).
For other git systems, you can learn about adding an ssh key in their documentation.
### Use LFS
If the annotation file is large, you can create a repository with
[LFS](https://git-lfs.github.com/) support.
### Issue tracker
Specify full issue tracker's URL if it's necessary.
### Source storage
Specify source storage for import resources like annotations and backups. It can be a local or a cloud storage.
If the task is created in the project, then the `Use project source storage` switch will determine whether
to use the default values or specify new ones.
### Target storage
Specify target storage for export resources like annotations and backups. It can be a local or a cloud storage.
If the task is created in the project, then the `Use project target storage` switch will determine whether
to use the default values or specify new ones.
To save and open task click on `Submit & Open` button. Also you
The following parameters are available:
can click on `Submit & Continue` button for creating several tasks in sequence.
Then, the created tasks will be displayed on a [tasks page](/docs/manual/basics/tasks-page/).
| Sorting method | **Note:** Does not work for the video data. <br><br>Several methods to sort the data. <br> For example, the sequence `2.jpeg`, `10.jpeg`, `1.jpeg` after sorting will be: <br><br><li>**Lexicographica**: `1.jpeg`, `10.jpeg`, `2.jpeg`<li>**Natural**: `1.jpeg`, `2.jpeg`, `10.jpeg`<li>**Predefined**: `2.jpeg`, `10.jpeg`, `1.jpeg`<li>**Random** uploads data in random order. |
| Use zip/video chunks | Use this parameter to divide your video or image dataset for annotation into short video clips a zip file of frames. <br>Zip files are larger but do not require decoding on the client side, and video clips are smaller but require decoding. <br>It is recommended to turn off this parameter for video tasks to reduce traffic between the client side and the server. |
| Use cache | Select checkbox, to enable _on-the-fly_ data processing to reduce task creation time and store data in a cache with a policy of <br>evicting less popular items. <br><br>For more information, see [Data preparation on the fly](/docs/manual/advanced/data_on_fly/). |
| Image Quality | CVAT has two types of data: original quality and compressed. Original quality images are used for dataset export<br> and automatic annotation. Compressed images are used only for annotations to reduce traffic between the server <br>and client side. <br> It is recommended to adjust the compression level only if the images contain small objects that are not <br>visible in the original quality. <br> 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. <br><br>**Note** that this functionality only works for bounding boxes. <br><br>This parameter has the following options: <br><br>**Interpolation task** (video sequence). If you annotate with a bounding box on two adjacent segments, they will be<br> merged into a single bounding box. In case the overlap is zero or the bounding box is inaccurate (not enclosing the object <br>properly, misaligned or distorted) on the adjacent segments, it may be difficult to accurately interpole the object's <br>movement between the segments. As a result, multiple tracks will be created for the same object. <br><br>**Annotation task** (independent images). If an object exists on overlapped segments with overlap greater than zero, <br>and the annotation of these segments is done properly, then the segments will be automatically merged into a single<br> object. If the overlap is zero or the annotation is inaccurate (not enclosing the object properly, misaligned, distorted) on the<br> adjacent segments, it may be difficult to accurately track the object. As a result, multiple bounding boxes will be <br>created for the same object. <br><br>If the annotations on different segments (on overlapped frames) are very different, you will have two shapes <br>for the same object. <br><br>To avoid this, accurately annotate the object on the first segment and the same object on the second segment to create a track <br>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<br> annotators, you can split it into smaller sections and assign each section to a separate job. <br>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 <br>certain frames or images in the dataset. <br>For example, if the frame step value is `25`, the dataset will include every 25th frame or image. If a video <br>has `100` frames, setting the frame step to `25` will include only frames `1`, `26`, `51`, `76`, and `100` in the dataset. <br>This can be useful for reducing the size of the dataset, or for focusing on specific frames or images that are <br>of particular interest. |
| Chunk size | Defines amount of frames to be packed in a chunk when send from client to server. <br>The server defines automatically if the chunk is empty. <br>Recommended values: <li> 1080p or less: 36 <li> 2k or less: 8 <li>16 - 4k or less: 4 <li>8 - More: 1 - 4 |
| Dataset repository | **Advanced option**. <br>URL link of the repository that specifies the path to the repository for storage (`default: annotation / <dump_file_name> .zip`).<br>Supports _.zip_ and _.xml_ formats. <br><br>Field format: `URL [PATH]` example: `https://github.com/project/repos.git [1/2/3/4/annotation.xml]`<br><br> Supported URL formats: <li>`https://github.com/project/repos[.git]` <li>`github.com/project/repos[.git]` <li>`git@github.com:project/repos[.git]` <br><br> After the task is created, the synchronization status will show up on the task page. <br> If you specify a dataset repository, when you create a task, you will see a message about the need to grant access with <br>the ssh key. <br> This is the key you need to [add to your github account](https://github.com/settings/keys). <br> For other git systems, you can learn about adding an ssh key in their documentation. |
| Use LFS | **Advanced option**. <br>Use this parameter for big annotation files, to create a repository with [LFS](https://git-lfs.github.com/) support. |
| Issue tracker | Use this parameter to specify the issue tracker URL. |
| Source storage | Specify the source storage for importing resources like annotations and backups. <br>If the task was assigned to the project, use the **Use project source storage** toggle to determine whether to <br>use project values or specify new ones. |
| Target storage | Specify the target storage (local or cloud) for exporting resources like annotations and backups. <br>If the task is created in the project, use the **Use project target storage** toggle to determine whether to<br> use project values or specify new ones. <br>To save and open the task click **Submit & Open** . <br>To create several tasks in sequence, click on the **Submit & Continue**.<br> Created tasks will be displayed on a [tasks page](/docs/manual/basics/tasks-page/). |
Mariia Acoca
3 years ago
committed by
GitHub
