Skip to content

Commit

Permalink
Source & target storage documentation (#5014)
Browse files Browse the repository at this point in the history
  • Loading branch information
arvfilippov authored Sep 30, 2022
1 parent bae7564 commit 55913f0
Show file tree
Hide file tree
Showing 14 changed files with 52 additions and 5 deletions.
12 changes: 12 additions & 0 deletions site/content/en/docs/manual/advanced/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ To backup a task or project, open the action menu and select `Backup Task` or `B

![](/images/image219.jpg)

You can backup a project or a task locally on your PC or using an [attached cloud storage](/docs/manual/basics/attach-cloud-storage/).

(Optional) Specify the name in the `Custom name` text field for backup, otherwise the file of backup name
will be given by the mask `project_<project_name>_backup_<date>_<time>.zip` for the projects
and `task_<task_name>_backup_<date>_<time>.zip` for the tasks.

![](/images/image253.jpg)

If you want to save a backup to a specific [attached cloud storage](/docs/manual/basics/attach-cloud-storage/),
you should additionally turn off the switch `Use default settings`, select the `Cloud storage` value
in the `Target storage` and select this storage in the list of the attached cloud storages.

## Create backup APIs

- endpoints:
Expand Down
21 changes: 20 additions & 1 deletion site/content/en/docs/manual/advanced/export-import-datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,14 @@ You can export a dataset to a project, task or job.
- Sly Point Cloud Format 1.0 - Supervisely Point Cloud dataset

<br>
1. To download images with the dataset, tick the `Save images` box.
1. To download images with the dataset, enable the `Save images` option.
1. (Optional) To name the resulting archive, use the `Custom name` field.
1. You can choose a storage for dataset export by selecting a target storage `Local` or `Cloud storage`.
The default settings are the settings that had been selected when the project was created
(for example, if you specified a local storage when you created the project,
then by default, you will be prompted to export the dataset to your PC).
You can find out the default value by hovering the mouse over the `?`.
Learn more about [attach cloud storage](/docs/manual/basics/attach-cloud-storage/).

## Import dataset

Expand All @@ -52,10 +58,23 @@ To import a dataset, do the following on the `Project` page:
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.

![](/images/image250.jpg)

- You can also import a dataset from an attached cloud storage.
Here you should select the annotation format, then select a cloud storage from the list or use default settings
if you have already specified required cloud storage for task or project
and specify a zip archive to the text field `File name`.

During the import process, you will be able to track the progress of the import.

## Upload annotations

![](/images/image251.jpg)

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.

![](/images/image252.jpg)

Or you can also use the attached cloud storage to upload the annotation file.
12 changes: 8 additions & 4 deletions site/content/en/docs/manual/advanced/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,10 @@ or create a new project by clicking on the `+` button and select `Create New Pro
> Read more about [organizations](/docs/manual/advanced/organization/).
You can change: the name of the project, the list of labels
(which will be used for tasks created as parts of this project) and a link to the issue.
Learn more about [creating a label list](/docs/manual/basics/creating_an_annotation_task/#labels).
(which will be used for tasks created as parts of this project) and a skeleton if it's necessary.
In advanced configuration also you can specify: a link to the issue, source and target storages.
Learn more about [creating a label list](/docs/manual/basics/creating_an_annotation_task/#labels),
[creating the skeleton](/docs/manual/advanced/annotation-with-skeletons/creating-the-skeleton/) and [attach cloud storage](/docs/manual/basics/attach-cloud-storage/).

To save and open project click on `Submit & Open` button. Also you
can click on `Submit & Continue` button for creating several projects in sequence
Expand All @@ -71,9 +73,11 @@ Here you can do the following:
- `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 labels.
1. Change labels and skeleton.
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 `Setup skeleton` you can create a skeleton for this project.

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.
1. `Tasks` — is a list of all tasks for a particular project, with the ability to search,
Expand Down
12 changes: 12 additions & 0 deletions site/content/en/docs/manual/basics/creating_an_annotation_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,18 @@ If the annotation file is large, you can create a repository with

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
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/).
Binary file modified site/content/en/images/image128.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image191.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image192_mapillary_vistas.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image219.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image225.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image238.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/image250.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/image251.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/image252.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/image253.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 55913f0

Please sign in to comment.