diff --git a/cvat/apps/documentation/backup_hld.md b/cvat/apps/documentation/backup_hld.md deleted file mode 100644 index ee6309cd..00000000 --- a/cvat/apps/documentation/backup_hld.md +++ /dev/null @@ -1,54 +0,0 @@ -## Task and Project Import/Export functionality - -This document describes the high-level design for implementing import / export implementation for tasks and projects. - -API endpoints: - -- Import task - - - endpoint: `/api/v1/tasks?action=import​` - - method: `POST` - - Content-Type: `multipart/form-data​` - - returns: json - -- Export task - - - endpoint: `/api/v1/tasks/{id}?action=export​` - - method: `GET` - - returns: zip archive - - The zip archive has the following structure: - - ``` - . - ├── data - │   ├── {user uploaded data} - │   ├── manifest.jsonl - ├── task.json - └── annotations.json - ``` - -- Import project - - - endpoint: `/api/v1/projects?action=import​` - - method: `POST` - - Content-Type: `multipart/form-data​` - - returns: json - -- Export project - - - endpoint: `/api/v1/projects/?action=export​` - - method: `GET` - - returns: zip archive - - The zip archive has the following structure: - - ``` - . - ├── tasks - │   ├── task_1 - │   ├── task_2 - │   ├── ... - │ └── task_N - └── project.json - ``` diff --git a/site/content/en/docs/manual/advanced/export-import.md b/site/content/en/docs/manual/advanced/export-import.md new file mode 100644 index 00000000..b9e4a811 --- /dev/null +++ b/site/content/en/docs/manual/advanced/export-import.md @@ -0,0 +1,46 @@ +--- +title: 'Export/import a task' +linkTitle: 'Export/import' +weight: 25 +--- + +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 diff --git a/site/content/en/docs/manual/basics/creating_an_annotation_task.md b/site/content/en/docs/manual/basics/creating_an_annotation_task.md index 36a7f6e9..3a66446d 100644 --- a/site/content/en/docs/manual/basics/creating_an_annotation_task.md +++ b/site/content/en/docs/manual/basics/creating_an_annotation_task.md @@ -237,6 +237,8 @@ weight: 2 - Velodyn points format 1.0 (Available in 3d task) - `Automatic Annotation` — automatic annotation with OpenVINO toolkit. Presence depends on how you build CVAT instance. + - `Export task` — Export a task into a zip archive. + Read more in the [export/import a task](/docs/manual/advanced/export-import/) section. - `Move to project` — Moving the task to the 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, you can create or delete necessary labels in the project/task. diff --git a/site/content/en/images/image219_mapillary_vistas.jpg b/site/content/en/images/image219_mapillary_vistas.jpg new file mode 100644 index 00000000..eca0244f Binary files /dev/null and b/site/content/en/images/image219_mapillary_vistas.jpg differ diff --git a/site/content/en/images/image220.jpg b/site/content/en/images/image220.jpg new file mode 100644 index 00000000..689b9b4e Binary files /dev/null and b/site/content/en/images/image220.jpg differ