Update Documentation about export, import and backup features (#4150)

main
Timur Osmanov 4 years ago committed by GitHub
parent dc03234432
commit c9aa9a12e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,4 +1,4 @@
// Copyright (C) 2021 Intel Corporation // Copyright (C) 2021-2022 Intel Corporation
// //
// SPDX-License-Identifier: MIT // SPDX-License-Identifier: MIT
@ -53,7 +53,7 @@ function ImportDatasetModal(): JSX.Element {
dispatch(importDatasetAsync(instance, values.selectedFormat as string, file)); dispatch(importDatasetAsync(instance, values.selectedFormat as string, file));
closeModal(); closeModal();
Notification.info({ Notification.info({
message: 'Dataset export started', message: 'Dataset import started',
description: `Dataset import was started for project #${instance?.id}. `, description: `Dataset import was started for project #${instance?.id}. `,
className: 'cvat-notification-notice-import-dataset-start', className: 'cvat-notification-notice-import-dataset-start',
}); });
@ -91,7 +91,7 @@ function ImportDatasetModal(): JSX.Element {
> >
<Form.Item <Form.Item
name='selectedFormat' name='selectedFormat'
label='Export format' label='Import format'
rules={[{ required: true, message: 'Format must be selected' }]} rules={[{ required: true, message: 'Format must be selected' }]}
> >
<Select placeholder='Select dataset format' className='cvat-modal-import-select'> <Select placeholder='Select dataset format' className='cvat-modal-import-select'>

@ -60,17 +60,18 @@ you the opportunity to speed up the execution of the annotation:
- [AI tools](/docs/manual/advanced/ai-tools/) - tools requiring installation. - [AI tools](/docs/manual/advanced/ai-tools/) - tools requiring installation.
- [Automatic annotation](/docs/manual/advanced/automatic-annotation/) - automatic annotation with using DL models. - [Automatic annotation](/docs/manual/advanced/automatic-annotation/) - automatic annotation with using DL models.
## Dump annotation ## Export dataset
![](/images/image028.jpg) ![](/images/image028.jpg)
1. To download the annotations, first you have to save all changes. 1. To download the annotations, first you have to save all changes.
Click the `Save` button or press `Ctrl+S`to save annotations quickly. Click the `Save` button or press `Ctrl+S`to save annotations quickly.
2. After you saved the changes, click the `Menu` button. 1. After you saved the changes, click the `Menu` button.
3. Then click the `Dump Annotation` button. 1. Then click the `Export dataset` button.
4. Lastly choose a format of the dump annotation file. 1. Lastly choose a format of the dataset.
Exporting is available in formats from the [list of supported formats](/docs/manual/advanced/formats/).
To learn more, go to [downloading annotations](/docs/manual/advanced/downloading-annotations/) To learn more, go to [export/import datasets](/docs/manual/advanced/export-import-datasets/) section.

@ -0,0 +1,60 @@
---
title: 'Backup Task and Project'
linkTitle: 'Backup'
weight: 17
---
In CVAT you can backup tasks and projects.
This can be used to backup a task or project on your PC or to transfer to another server.
## Backup
To backup a task or project, open the action menu and select `Backup Task` or `Backup Project`.
![](/images/image219.jpg)
### Backup structure
As a result, you'll get a zip archive containing data,
task or project and task specification and annotations with the following structure:
{{< tabpane >}}
{{< tab header="Task Backup Structure" >}}
.
├── data
│ └── {user uploaded data}
├── task.json
└── annotations.json
{{< /tab >}}
{{< tab header="Project Backup Structure" >}}
.
├── task_{id}
│ ├── data
│ │ └── {user uploaded data}
│ ├── task.json
│ └── annotations.json
└── project.json
{{< /tab >}}
{{< /tabpane >}}
### Backup API
- endpoint: `/v1/tasks/{id}/backup` or `/v1/projects/{id}/backup`
- method: `GET`
- responses: 202, 201 with zip archive payload
## Create from backup
To create a task or project from a backup, go to the tasks or projects page,
click the `Create from backup` button and select the archive you need.
![](/images/image220.jpg)
As a result, you'll get a task containing data, parameters, and annotations of the previously exported task.
### Create from backup API
- endpoint: `/api/v1/tasks/backup` or `/api/v1/projects/backup`
- method: `POST`
- Content-Type: `multipart/form-data`
- responses: 202, 201 with json payload

@ -1,49 +0,0 @@
---
title: 'Downloading annotations'
linkTitle: 'Downloading annotations'
weight: 18
---
1. To download the latest annotations, you have to save all changes first.
Сlick the `Save` button. There is a `Ctrl+S` shortcut to save annotations quickly.
1. After that, сlick the `Menu` button.
1. Press the `Export task dataset` button.
![](/images/image028.jpg)
1. Choose the format for exporting the dataset. Exporting is available in several formats:
- [CVAT for video](/docs/manual/advanced/xml_format/#interpolation)
choose if the task is created in interpolation mode.
- [CVAT for images](/docs/manual/advanced/xml_format/#annotation)
choose if a task is created in annotation mode.
![](/images/image029.jpg 'Example XML format')
- [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/)
- [(VOC) Segmentation mask](http://host.robots.ox.ac.uk/pascal/VOC/) —
archive contains class and instance masks for each frame in the png
format and a text file with the value of each color.
- [YOLO](https://pjreddie.com/darknet/yolo/)
- [COCO](http://cocodataset.org/#format-data)
- [TFRecord](https://www.tensorflow.org/tutorials/load_data/tfrecord)
- [MOT](https://motchallenge.net/)
- [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0/)
- [Datumaro](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats/datumaro)
- [ImageNet](http://www.image-net.org/)
- [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/)
- [WIDER Face](http://shuoyang1213.me/WIDERFACE/)
- [VGGFace2](https://github.com/ox-vgg/vgg_face2)
- [Market-1501](https://www.aitribune.com/dataset/2018051063)
- [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2)
For 3D tasks, the following formats are available:
- [Kitti Raw Format 1.0](http://www.cvlibs.net/datasets/kitti/raw_data.php)
- Sly Point Cloud Format 1.0 - Supervisely Point Cloud dataset
1. To download images with the dataset tick the `Save images` box
1. (Optional) To name the resulting archive, use the `Custom name` field.
![](/images/image225.jpg)

@ -0,0 +1,61 @@
---
title: 'Export/import datasets and upload annotation'
linkTitle: 'Export/import datasets'
weight: 18
description: 'This section explains how to download and upload datasets
(including annotation, images, and metadata) of projects, tasks, and jobs.'
---
## Export dataset
You can export a dataset to a project, task or job.
1. To download the latest annotations, you have to save all changes first.
Сlick the `Save` button. There is a `Ctrl+S` shortcut to save annotations quickly.
![](/images/image028.jpg)
1. After that, сlick the `Menu` button.
Exporting and importing of task and project datasets takes place through the `Action` menu.
1. Press the `Export task dataset` button.
![](/images/image225.jpg)
1. Choose the format for exporting the dataset. Exporting and importing is available in:
- Standard CVAT formats:
- [CVAT for video](/docs/manual/advanced/xml_format/#interpolation)
choose if the task is created in interpolation mode.
- [CVAT for images](/docs/manual/advanced/xml_format/#annotation)
choose if a task is created in annotation mode.
<br>
- And also in formats from the [list of annotation formats supported by CVAT](/docs/manual/advanced/formats/).
- For 3D tasks, the following formats are available:
- [Kitti Raw Format 1.0](http://www.cvlibs.net/datasets/kitti/raw_data.php)
- Sly Point Cloud Format 1.0 - Supervisely Point Cloud dataset
<br>
1. To download images with the dataset, tick the `Save images` box.
1. (Optional) To name the resulting archive, use the `Custom name` field.
## Import dataset
You can import dataset only to a project. In this case, the data will be split into subsets.
To import a dataset, do the following on the `Project` page:
![](/images/image238.jpg)
- Open the `Actions` menu.
- Press the `Import dataset` button.
- Select the dataset format (if you did not specify a custom name during export,
the format will be in the archive name).
- Drag the file to the file upload area or click on the upload area to select the file through the explorer.
During the import process, you will be able to track the progress of the import.
## Upload annotations
In the task or job you can upload an annotation. For this select the item `Upload annotation`
in the menu `Action` of the task or in the job `Menu` on the `Top panel` select the format in which you plan
to upload the annotation and select the annotation file or archive via explorer.

@ -1,46 +0,0 @@
---
title: 'Export/import a task'
linkTitle: 'Export/import'
weight: 17
---
In CVAT you can export and import tasks.
This can be used to backup the task on your PC or to transfer the task to another server.
## Export task
To export a task, open the action menu and select `Export Task`.
![](/images/image219_mapillary_vistas.jpg)
As a result, you'll get a zip archive containing data, task specification and annotations with the following structure:
```
.
├── data
│   ├── {user uploaded data}
│   ├── manifest.jsonl
├── task.json
└── annotations.json
```
Export task API:
- endpoint: `/api/v1/tasks/{id}?action=export`
- method: `GET`
- responses: 202, 201 with zip archive payload
## Import task
To import a task from an archive, go to the tasks page, click the `Import Task` button and select the archive you need.
![](/images/image220.jpg)
As a result, you'll get a task containing data, parameters, and annotations of the previously exported task.
Import task API:
- endpoint: `/api/v1/tasks?action=import`
- method: `POST`
- Content-Type: `multipart/form-data`
- responses: 202, 201 with json payload

@ -10,8 +10,9 @@ description: 'Creating and exporting projects in CVAT.'
At CVAT, you can create a project containing tasks of the same type. At CVAT, you can create a project containing tasks of the same type.
All tasks related to the project will inherit a list of labels. 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.  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 `Create New Project`. On the projects page, you can see a list of projects, use a search,
or create a new project by clicking `Create New Project`.
![](/images/image190.jpg) ![](/images/image190.jpg)
@ -27,28 +28,20 @@ Once created, the project will appear on the projects page. To open a project, j
Here you can do the following: Here you can do the following:
1. Change the project's title. 1. Change the project's title.
1. Open the `Actions` menu. 1. 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.
More information is available in the [export/import datasets](/docs/manual/advanced/export-import-datasets/)
section.
- `Backup project` - make a backup of the project read more in the [backup](/docs/manual/advanced/backup/) section.
- `Delete` - remove the project and all related tasks.
1. Change issue tracker or open issue tracker if it is specified. 1. Change issue tracker or open issue tracker if it is specified.
1. Change labels. 1. Change labels.
You can add new labels or add attributes for the existing labels in the Raw mode or the Constructor mode.  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 `Copy` you can copy the labels to the clipboard. You can also change the color for different labels. By clicking `Copy` you can copy the labels to the clipboard.
1. Assigned to — is used to assign a project to a person. 1. 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. Start typing an assignee's name and/or choose the right person out of the dropdown list.
1. `Tasks` — is a list of all tasks for a particular project, with the ability to search for tasks in the project. 1. `Tasks` — is a list of all tasks for a particular project, with the ability to search for tasks in the project.
[Read more about search](/docs/manual/advanced/search/). [Read more about search](/docs/manual/advanced/search/).
It is possible to choose a subset for tasks in the project. You can use the available options 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. (`Train`, `Test`, `Validation`) or set your own.
You can remove the project and all related tasks through the Action menu.
### Export project
It is possible to download an entire project instead of exporting individual tasks. In this case,
annotations for all tasks in a project will be available in a single archive.
To export a project, do the following on the `Project` page:
- Open the `Actions` menu.
- Press the `Export project dataset` button.
Additional information about exporting tasks can be found in the
[Downloading annotations](/docs/manual/advanced/downloading-annotations/) section.

@ -12,15 +12,16 @@ Each element contains: task name, preview, progress bar, button `Open`, and menu
Each button is responsible for a in menu `Actions` specific function: Each button is responsible for a in menu `Actions` specific function:
- `Export task dataset` — download annotations or annotations and images in a specific format. - `Export task dataset` — download annotations or annotations and images in a specific format.
More information is available in the [Downloading annotations](/docs/manual/advanced/downloading-annotations/) More information is available in the [export/import datasets](/docs/manual/advanced/export-import-datasets/)
section.
- `Upload annotation` upload annotations in a specific format.
More information is available in the [export/import datasets](/docs/manual/advanced/export-import-datasets/)
section. section.
- `Upload annotation` is available in the same formats as in `Export task dataset`. The
[CVAT](/docs/manual/advanced/xml_format/) format accepts both video and image sub-formats.
- `Automatic Annotation` — automatic annotation with OpenVINO toolkit. - `Automatic Annotation` — automatic annotation with OpenVINO toolkit.
Presence depends on how you build CVAT instance. Presence depends on how you build the CVAT instance.
- `Export task` — Export a task into a zip archive. - `Backup task` — make a backup of this task into a zip archive.
Read more in the [export/import a task](/docs/manual/advanced/export-import/) section. Read more in the [backup](/docs/manual/advanced/backup/) section.
- `Move to project` — Moving the task to the project (can be used to move a task from one project to another). - `Move to project` — Moving a task to a project (can be used to move a task from one project to another).
Note that attributes reset during the moving process. In case of label mismatch, Note that attributes reset during the moving process. In case of label mismatch,
you can create or delete necessary labels in the project/task. you can create or delete necessary labels in the project/task.
Some task labels can be matched with the target project labels. Some task labels can be matched with the target project labels.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 387 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Loading…
Cancel
Save