diff --git a/cvat/apps/documentation/static/documentation/images/image035.jpg b/cvat/apps/documentation/static/documentation/images/image035.jpg index 532cd9de50f7..f236651423cc 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image035.jpg and b/cvat/apps/documentation/static/documentation/images/image035.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image036.jpg b/cvat/apps/documentation/static/documentation/images/image036.jpg index e0a9a315cc34..7a95f684b6fc 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image036.jpg and b/cvat/apps/documentation/static/documentation/images/image036.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image037.jpg b/cvat/apps/documentation/static/documentation/images/image037.jpg index 3dd5c1d032f1..71466981ebb6 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image037.jpg and b/cvat/apps/documentation/static/documentation/images/image037.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image040.jpg b/cvat/apps/documentation/static/documentation/images/image040.jpg index f5a81f675067..ba744a37ce58 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image040.jpg and b/cvat/apps/documentation/static/documentation/images/image040.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image041.jpg b/cvat/apps/documentation/static/documentation/images/image041.jpg index 71c307e3437d..afc98fc8f665 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image041.jpg and b/cvat/apps/documentation/static/documentation/images/image041.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image051.jpg b/cvat/apps/documentation/static/documentation/images/image051.jpg index a7648afab8e2..c3fef5ea2ca2 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image051.jpg and b/cvat/apps/documentation/static/documentation/images/image051.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image060.jpg b/cvat/apps/documentation/static/documentation/images/image060.jpg index 14098aadb5bb..5fc4b9cc64d2 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image060.jpg and b/cvat/apps/documentation/static/documentation/images/image060.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image061.jpg b/cvat/apps/documentation/static/documentation/images/image061.jpg index 2ffc9a5d5741..c4c065daf8eb 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image061.jpg and b/cvat/apps/documentation/static/documentation/images/image061.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image141.jpg b/cvat/apps/documentation/static/documentation/images/image141.jpg new file mode 100644 index 000000000000..2e63a6726427 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image141.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image143.jpg b/cvat/apps/documentation/static/documentation/images/image143.jpg new file mode 100644 index 000000000000..ed0af85884db Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image143.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image144_DETRAC.jpg b/cvat/apps/documentation/static/documentation/images/image144_DETRAC.jpg new file mode 100644 index 000000000000..f9d204bf7d36 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image144_DETRAC.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image145.jpg b/cvat/apps/documentation/static/documentation/images/image145.jpg new file mode 100644 index 000000000000..cc5d2e028b7b Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image145.jpg differ diff --git a/cvat/apps/documentation/user_guide.md b/cvat/apps/documentation/user_guide.md index f80274cbd84e..e9315d89d3dd 100644 --- a/cvat/apps/documentation/user_guide.md +++ b/cvat/apps/documentation/user_guide.md @@ -681,22 +681,14 @@ In tab ``Workspace`` you can: - Press `` Go back`` or ``F3`` to return to the annotation. --- -Go to the next/previous frame with step equals to 1. Shortcuts: ``D`` — previous, ``F`` — next. -![](static/documentation/images/image040.jpg) +### Top Panel ---- -Play the sequence of frames or the set of images. Shortcut: ``Space`` (change at ``Open Menu`` —> ``Settings`` —> ``Player Speed``). - -![](static/documentation/images/image041.jpg) +![](static/documentation/images/image035.jpg) --- -Go to specified frame. Press ``~`` to focus on the element. - -![](static/documentation/images/image060.jpg) ---- -**Open Menu** button +#### Menu button It is the main menu of the annotation tool. It can be used to download, upload and remove annotations. @@ -704,97 +696,88 @@ It is the main menu of the annotation tool. It can be used to download, upload a Button assignment: -- ``Open Task`` — open task in cvat dashboard -- ``RunReID Merge`` — The ReID application uses deep learning model to perform - an automatic merging of bounding boxes between neighbor frames. You can use - "Merge" and "Split" functionality to edit automatically generated annotation - [read more](/cvat/apps/reid). -- ``Dump Annotation`` — download annotations from the task -- ``Upload Annotation`` — uploading annotations to the task -- ``Remove Annotation`` — remove annotations from current task -- ``Settings`` — open the settings menu -- ``Fullscreen Player`` — fullscreen player mode -- ``Switch AAM`` — switch to attribute annotation mode -- ``Help`` — open the shortkeys -- ``Save Work`` — save annotations for the current job. The button has an - indication of the saving process - -It also shows statistics about the current task, for example: -- task name -- status of the task: ``annotation``, ``validation`` or ``completed task`` -- technical information about task -- number of created bounding boxes, sorted by labels (e.g. vehicle, person) and -type of annotation (polygons, boxes, etc.) - ---- -**Filter** input box +- ``Dump Annotations`` — downloads annotations from a task. +- ``Upload Annotations`` — uploads annotations into a task. +- ``Remove Annotations`` — removes annotations from the current job. +- ``Export as a dataset`` — download a data set from a task. Several formats are available: + - [Datumaro](https://github.com/opencv/cvat/blob/develop/datumaro/docs/design.md) + - [Pascal VOC 2012](http://host.robots.ox.ac.uk/pascal/VOC/) + - [MS COCO](http://cocodataset.org/#format-data) + - [YOLO](https://pjreddie.com/darknet/yolo/) +- ``Open the task`` — opens a page with details about the task. +- ``Run ReID merge`` — automatic merge of shapes or tracks. + It is used to combine individual objects - created by automatic annotation in a single track. + For more information click [here](cvat/apps/reid/README.md). -The way how to use filters is described in the advanced guide (below). +#### Save Work +Saves annotations for the current job. The button has an indication of the saving process. -![](static/documentation/images/image059.jpg) + ![](static/documentation/images/image141.jpg) ---- -**History / Undo-redo** panel +#### Undo-redo buttons -Use ``Ctrl+Z`` for undo actions and ``Ctrl+Shift+Z`` or ``Ctrl+Y`` to redo them. + Use buttons to undo actions or redo them. -![](static/documentation/images/image061.jpg) + ![](static/documentation/images/image061.jpg) --- -**Propagation** input box - -Allows you to select how many frames of the selected object will be copied clicking ``Ctrl+B`` (50 by default) -![](static/documentation/images/image101.jpg) +#### Player ---- -**Rotation** of an image + Go to the first /the latest frames. -Buttons are used to rotate the image clockwise / counterclockwise or use ``Ctrl+R``/``Ctrl+Shift+R`` + ![](static/documentation/images/image036.jpg) -![](static/documentation/images/image102.jpg) +Go to the next/previous frame with a predefined step. Shortcuts: +``V`` — step backward, ``C`` — step forward. By default the step is ``10`` frames +(change at ``Account Menu`` —> ``Settings`` —> ``Player Step``). ---- -**Fill Opacity** slider + ![](static/documentation/images/image037.jpg) -Change opacity of every bounding box in the annotation. +Go to the next/previous frame (the step is 1 frame). Shortcuts: ``D`` — previous, ``F`` — next. -![](static/documentation/images/image086.jpg) + ![](static/documentation/images/image040.jpg) -Opacity can be changed from 0% to 100% and by random colors or white. If any -white option is chosen, ``Color By`` scheme won't work. +Play the sequence of frames or the set of images. +Shortcut: ``Space`` (change at ``Account Menu`` —> ``Settings`` —> ``Player Speed``). -**Selected Fill Opacity** slider + ![](static/documentation/images/image041.jpg) -Change the opacity of the selected object's fill. +Go to a specific frame. Press ``~`` to focus on the element. -![](static/documentation/images/image087.jpg) + ![](static/documentation/images/image060.jpg) -Opacity can be changed from 0% to 100%. +--- -**Black Stroke** checkbox +#### Fullscreen Player +The fullscreen player mode. The keyboard shortcut is ``F11``. -Change bounding box border from white/colored to black. + ![](static/documentation/images/image143.jpg) -![](static/documentation/images/image088.jpg) +#### Info +Open the job info. -**Color By** options + ![](static/documentation/images/image144_DETRAC.jpg) -Change the color scheme of annotation: -- ``Instance`` — every bounding box has random color +- Job status: ``annotation``, ``validation`` or ``completed`` task - ![](static/documentation/images/image095.jpg) +_Overview_: -- ``Group`` — every group of boxes has its own random color, ungrouped boxes are white +- ``Assinger`` - the one to whom the job is assigned. +- ``Start Frame`` - the number of the first frame in this job. +- ``End Frame`` - the number of the last frame in this job. +- ``Frames`` - the total number of all frames in the job. +- ``Z-Order`` - z-order enable indicator. - ![](static/documentation/images/image094.jpg) +_Annotations statistics_: -- ``Label`` — every label (e.g. vehicle, pedestrian, road marks) has its own random color + This is a table number of created shapes, sorted by labels (e.g. vehicle, person) + and type of annotation (shape, track). As well as the number of manual and interpolated frames. - ![](static/documentation/images/image093.jpg) +#### UI switcher +Switching between user interface modes. - You can change any random color pointing on needed box on a frame or on a - side panel and press ``Enter``. + ![](static/documentation/images/image145.jpg) --- ### Side panel