-
Notifications
You must be signed in to change notification settings - Fork 3.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation update, added info about the cloud storage UI #3724
Changes from 3 commits
d2d1806
086dec0
0d60a1c
075a87e
61dc224
b15edf9
3e978d7
b34e1bd
b77f497
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,62 @@ | ||||||
--- | ||||||
title: 'Attach cloud storage' | ||||||
linkTitle: 'Attach cloud storage' | ||||||
weight: 21 | ||||||
description: '' | ||||||
--- | ||||||
|
||||||
In CVAT you can use AWS-S3 and Azur Blob Container cloud storages to store image datasets for your tasks. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we prepare a tutorial here? Let's try to create "AWS account", "load images to S3", "prepare the manifest", "load manifest to S3", "use the storage to create tasks on CVAT. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Users should be able to reproduce our steps. For now we have only description for the complex process. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is also a good idea to get a pubic dataset for the purpose. |
||||||
Initially you need to create a manifest file for your image dataset. Information on how to do that is available | ||||||
on the [Simple command line to prepare dataset manifest file](/docs/manual/advanced/dataset_manifest) page. | ||||||
|
||||||
After the manifest file has been created, you can upload it and your dataset to an AWS-S3 or | ||||||
Azur Blob Container cloud storage. | ||||||
|
||||||
After that you will be able to attach a cloud storage. To do this, press the `Attach new cloud storage` | ||||||
button on the `Cloud storages` page and fill out the following form: | ||||||
|
||||||
![](/images/image228.jpg) | ||||||
|
||||||
- `Display name` - the display name of the cloud storage. | ||||||
- `Description` (optional) - description of the cloud storage, appears when you click on the `?` button | ||||||
of an item on сloud storages page. | ||||||
- `Provider` - chose provider of the cloud storage: | ||||||
|
||||||
- [AWS-S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3.html): | ||||||
|
||||||
- `Bucket` - container name cloud storage | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- [`Autorization type`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-best-practices.html) | ||||||
|
||||||
- `Key id and secret access key pair` | ||||||
- `ACCESS KEY ID` | ||||||
- `SECRET ACCESS KEY ID` | ||||||
|
||||||
- `Anonymous access` | ||||||
|
||||||
- `Region` - here you can choose a region from the list or add a new one. To get more information click | ||||||
on [`?`](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions) | ||||||
|
||||||
</br> | ||||||
- [Azur Blob Container](https://docs.microsoft.com/en-us/azure/storage/blobs/): | ||||||
|
||||||
- `Container name` - name of the cloud storage container | ||||||
|
||||||
- `Autorization type` | ||||||
|
||||||
- [`Account name and SAS token`](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=blobs) | ||||||
- `Account name` | ||||||
- `SAS token` | ||||||
|
||||||
- [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-prevent) | ||||||
- `Account name` | ||||||
|
||||||
</br> | ||||||
- `Manifest` - the path to the manifest file on your cloud storage. | ||||||
You can add multiple file manifests using the add manifest button. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
For more information click on [`?`](/docs/manual/advanced/dataset_manifest/). | ||||||
|
||||||
To publish the cloud storage, click `submit`, after which it will be available on | ||||||
the [Cloud storages page](/docs/manual/basics/cloud-storages/). | ||||||
You can mount the cloud storage using command line interface. More information is available on the | ||||||
[Mounting cloud storage](/docs/administration/advanced/mounting_cloud_storages) page. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It does not correspond to the current functionality and it may mislead a user that the created cloud storage will appear on the page with cloud storages, but it is not like that. So I guess to remove this. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: 'Cloud storages page' | ||
linkTitle: 'Cloud storages page' | ||
weight: 20 | ||
description: 'Overview of the Cloud storages page.' | ||
amotovx marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--- | ||
|
||
![](/images/image227.jpg) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I fixed the preview of the site, there was a mistake. I think using svg in this case is not convenient because for the correct display need to specify the css styles |
||
|
||
The cloud storages page contains elements, each of them relating to a separate cloud storage. | ||
Each element contains: preview, cloud storage name, provider, creation and update info, status, | ||
`?` button for displaying the description and the actions menu. | ||
|
||
Each button in the action menu is responsible for a specific function: | ||
- `Update` — update this cloud storage | ||
- `Delete` — delete cloud storage. | ||
|
||
Click the `Attach a new storage` button to [attach a new storage](/docs/manual/basics/attach-cloud-storage/). |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -76,6 +76,8 @@ If you select tab `Connected file share` you can choose files for annotation fro | |||||
If you select ` Remote source` , you'll see a field where you can enter a list of URLs (one URL per line). | ||||||
If you upload a video or dataset with images and select `Use cache` option, you can attach a `manifest.jsonl` file. | ||||||
You can find how to prepare it [here](/docs/manual/advanced/dataset_manifest/). | ||||||
If you select the 'Cloud Storage' tab, you can select a cloud storage (for this type the cloud storage name), | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
after that choose the manifest file and select the required files. | ||||||
|
||||||
amotovx marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
![](/images/image127.jpg) | ||||||
|
||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.