Documentation for export/import a task (#3367)

* update documentation sorting

* update README.md and documentation

* fix linter errors

* update name sections

* fix links

* fix linter errors

* add 3D task documentation

* update documentation

* fix conflict README.md

* fix linter error v1

* update documentation

* fix mistakes

* update creating an annotation task section

* rename section

* fix numeration

* fix mistakes

* update docs

* fix grammar

* delete info about not implemented features

* fixed comments

Co-authored-by: Andrey Zhavoronkov <andrey.zhavoronkov@intel.com>
Co-authored-by: kirill.sizov <kirill.sizov@intel.com>
main
Timur Osmanov 5 years ago committed by GitHub
parent d47c5e468d
commit dde8a40ce5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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/<id>?action=export`
- method: `GET`
- returns: zip archive
The zip archive has the following structure:
```
.
├── tasks
│   ├── task_1
│   ├── task_2
│   ├── ...
│ └── task_N
└── project.json
```

@ -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

@ -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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Loading…
Cancel
Save