Skip to content
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, updated info about downloading annotations and exporting projects #3546

Merged
merged 5 commits into from
Aug 17, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions site/content/en/docs/manual/advanced/downloading-annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ weight: 1
---

1. To download the latest annotations, you have to save all changes first.
click the `Save` button. There is a `Ctrl+S` shortcut to save annotations quickly.
Сlick the `Save` button. There is a `Ctrl+S` shortcut to save annotations quickly.
1. After that, сlick the `Menu` button.
1. Press the `Dump Annotation` button.
1. Press the `Export task dataset` button.

![](/images/image028.jpg)

1. Choose format dump annotation file. Dump annotation are available in several formats:
1. Choose the format for exporting the dataset. Exporting is available in several formats:

- [CVAT for video](/docs/manual/advanced/xml_format/#interpolation)
is highlighted if a task has the interpolation mode.
choose if the task is created in interpolation mode.
- [CVAT for images](/docs/manual/advanced/xml_format/#annotation)
is highlighted if a task has the annotation mode.
choose if a task is created in annotation mode.

![](/images/image029.jpg 'Example XML format')

Expand All @@ -30,7 +30,20 @@ weight: 1
- [MOT](https://motchallenge.net/)
- [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0/)
- [Datumaro](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats/datumaro)
- [ImageNet](http://www.image-net.org/)
- [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/)
- [WIDER Face](http://shuoyang1213.me/WIDERFACE/)
- [VGGFace2](https://github.com/ox-vgg/vgg_face2)
- [Market-1501](https://www.aitribune.com/dataset/2018051063)
- [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2)


For 3D tasks, the following formats are available:
- Point Cloud Format 1.0
- Velodyn points format 1.0
- [Kitti Raw Format 1.0](http://www.cvlibs.net/datasets/kitti/raw_data.php)
- Sly Point Cloud Format 1.0 - Supervisely Point Cloud dataset

1. To download images with the dataset tick the `Save images` box

1. (Optional) To name the resulting archive, use the `Custom name` field.

![](/images/image225.jpg)
17 changes: 16 additions & 1 deletion site/content/en/docs/manual/advanced/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
title: 'Projects'
linkTitle: 'Projects'
weight: 3
description: 'Creating projects in CVAT.'
description: 'Creating and exporting projects in CVAT.'
---

### Create project

At CVAT, you can create a project containing tasks of the same type.
All tasks related to the project will inherit a list of labels.

Expand Down Expand Up @@ -34,4 +36,17 @@ Here you can do the following:
 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.

It is possible to choose a subset for tasks in the project. Available options are `Train`, `Test` and `Validation`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to note that subset can be custom also, I guess.


You can remove the project and all related tasks through the Action menu.

### Export project

It is possible to download an entire project instead of exporting individual tasks. In this case,
annotations for all tasks in a project will be available in a single archive.
To export a project, do the following on the `Project` page:
- Open the `Actions` menu.
- Press the `Export project dataset` button.

Additional information about exporting tasks can be found in the
[Downloading annotations](/docs/manual/advanced/downloading-annotations/) section.
27 changes: 5 additions & 22 deletions site/content/en/docs/manual/basics/creating_an_annotation_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,28 +230,11 @@ description: 'Instructions on how to create and configure an annotation task.'
Each element contains: task name, preview, progress bar, button `Open`, and menu `Actions`.
Each button is responsible for a in menu `Actions` specific function:

- `Dump Annotation` and `Export as a dataset` — download annotations or
annotations and images in a specific format. The following formats are available:
- [CVAT for video](/docs/manual/advanced/xml_format/#interpolation)
is highlighted if a task has the interpolation mode.
- [CVAT for images](/docs/manual/advanced/xml_format/#annotation)
is highlighted if a task has the annotation mode.
- [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/)
- [(VOC) Segmentation mask](http://host.robots.ox.ac.uk/pascal/VOC/) —
archive contains class and instance masks for each frame in the png
format and a text file with the value of each color.
- [YOLO](https://pjreddie.com/darknet/yolo/)
- [COCO](http://cocodataset.org/#format-data)
- [TFRecord](https://www.tensorflow.org/tutorials/load_data/tfrecord)
- [MOT](https://motchallenge.net/)
- [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0/)
- [Datumaro](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats/datumaro)
- Point Cloud Format 1.0 (Available in 3d task)
- Velodyn points format 1.0 (Available in 3d task)
- `Upload annotation` is available in the same formats as in `Dump annotation`.
- [CVAT](/docs/manual/advanced/xml_format/) accepts both video and image sub-formats.
- Point Cloud Format 1.0 (Available in 3d task)
- Velodyn points format 1.0 (Available in 3d task)
- `Export task dataset` — download annotations or annotations and images in a specific format.
More information is available in the [Downloading annotations](/docs/manual/advanced/downloading-annotations/)
section.
- `Upload annotation` is available in the same formats as in `Export task dataset`. The
[CVAT](/docs/manual/advanced/xml_format/) format accepts both video and image sub-formats.
- `Automatic Annotation` — automatic annotation with OpenVINO toolkit.
Presence depends on how you build CVAT instance.
- `Export task` — Export a task into a zip archive.
Expand Down
Binary file modified site/content/en/images/image028.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/image225.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.