Update Documentation about export, import and backup features (#4150)
parent
dc03234432
commit
c9aa9a12e1
@ -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`.
|
||||
|
||||

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

|
||||
|
||||
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
|
||||
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…
Reference in New Issue