Skip to content

Commit fc37800

Browse files
authored
Update items from AAM (basics) to Vocabulary in User Guide (#1459)
* Update items from AAM (basics) to Vocabulary * Delete unused images and gif
1 parent 5e96c2a commit fc37800

17 files changed

+31
-41
lines changed
Binary file not shown.
Binary file not shown.
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading
Loading
Binary file not shown.
Loading
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading
Loading

cvat/apps/documentation/user_guide.md

+31-41
Original file line numberDiff line numberDiff line change
@@ -508,42 +508,41 @@ Usage examples:
508508

509509
### Attribute annotation mode (basics)
510510

511-
- In this mode you can edit attributes with fast navigation between
512-
objects and frames using keyboard. Press ``Shift+Enter`` shortcut
513-
to enter the mode. After that, you can change attributes using a keyboard.
511+
- In this mode you can edit attributes with fast navigation between objects and frames using a keyboard.
512+
Open the drop-down list in the top panel and select Attribute annotation Mode.
514513

515-
![](static/documentation/images/image023.jpg)
514+
![](static/documentation/images/image023_Affectnet.jpg)
516515

517-
- The active attribute will be red. It is ``gender`` in this case. Look at
518-
the bottom side panel to see all possible shortcuts for changing the
519-
attribute. Press ``2`` key on your keyboard to assign ``female`` value for
520-
the attribute.
516+
- In this mode objects panel change to a special panel :
521517

522-
![](static/documentation/images/image024.jpg) ![](static/documentation/images/image025.jpg)
518+
![](static/documentation/images/image026.jpg)
523519

524-
- Press ``Up Arrow``/``Down Arrow`` on your keyboard to go to next/previous
525-
attribute. In this case, after pressing ``Down Arrow`` you will be able to
526-
edit ``Age`` attribute.
520+
- The active attribute will be red. In this case it is ``gender`` . Look at the bottom side panel to see all possible
521+
shortcuts for changing the attribute. Press key ``2`` on your keyboard to assign a value (female) for the attribute
522+
or select from the drop-down list.
527523

528-
![](static/documentation/images/image026.jpg) ![](static/documentation/images/image027.jpg)
529-
530-
- Use ``Right Arrow``/``Left Arrow`` keys to move on previous/next image with annotation.
524+
![](static/documentation/images/image024_Affectnet.jpg)
525+
526+
- Press ``Up Arrow``/``Down Arrow`` on your keyboard or click the buttons in the UI to go to the next/previous
527+
attribute. In this case, after pressing ``Down Arrow`` you will be able to edit the ``Age`` attribute.
531528

532-
### Downloading annotations
529+
![](static/documentation/images/image025_Affectnet.jpg)
533530

534-
1. To download the latest annotations, you have to save all changes first.
535-
To do this, click ``Open Menu`` button.
531+
- Use ``Right Arrow``/``Left Arrow`` keys to move to the previous/next image with annotation.
536532

537-
1. After that, press ``Save Work`` button. There is ``Ctrl+S``
538-
shortcut to save annotations quickly.
533+
To see all the hot keys available in the attribute annotation mode, press ``F2``.
534+
Read more in the section [attribute annotation mode (advanced)](#attribute-annotation-mode-advanced).
539535

540-
![](static/documentation/images/image028.jpg)
536+
### Downloading annotations
541537

542-
1. After that, press ``Dump Annotation`` button.
538+
1. To download the latest annotations, you have to save all changes first.
539+
click the ``Save`` button. There is a ``Ctrl+S`` shortcut to save annotations quickly.
540+
1. After that, сlick the ``Menu`` button.
541+
1. Press the ``Dump Annotation`` button.
543542

544-
![](static/documentation/images/image118.jpg)
543+
![](static/documentation/images/image028.jpg)
545544

546-
1. Choose format dump annotation file. Dump annotation are available in several formats:
545+
1. Choose the format dump of the annotation file. Several formats are available:
547546
- [CVAT XML 1.1 for video](/cvat/apps/documentation/xml_format.md#interpolation)
548547
is highlighted if a task has the interpolation mode
549548
- [CVAT XML 1.1 for images](/cvat/apps/documentation/xml_format.md#annotation)
@@ -554,9 +553,11 @@ Usage examples:
554553
- [PASCAL VOC ZIP 1.1](http://host.robots.ox.ac.uk/pascal/VOC/)
555554
- [YOLO ZIP 1.1](https://pjreddie.com/darknet/yolo/)
556555
- [COCO JSON 1.0](http://cocodataset.org/#format-data)
557-
- ``MASK ZIP 1.0`` — archive contains a mask of each frame in the png format and a text file with
556+
- ``MASK ZIP 1.1`` — archive contains a mask of each frame in the png format and a text file with
558557
the value of each color
559558
- [TFRecord ZIP 1.0](https://www.tensorflow.org/tutorials/load_data/tf_records)
559+
- [MOT ZIP 1.1](https://motchallenge.net/)
560+
- [LabelMe ZIP 3.0 for image](http://labelme.csail.mit.edu/Release3.0/)
560561

561562
### Task synchronization with a repository
562563

@@ -578,21 +579,9 @@ Usage examples:
578579

579580
### Vocabulary
580581

581-
**Bounding box** is an area which defines boundaries of an object. To specify
582-
it, you need to define two opposite corners.
583-
584-
**Tight bounding box** is a bounding box where margin between the object inside
585-
and boundaries of the box is absent. This type of bounding box is used in most
586-
tasks by default, but precision completely depends on an annotation task.
587-
588-
| Bounding box | Tight bounding box |
589-
| ------------ | :----------------: |
590-
| ![](static/documentation/images/image031.jpg) | ![](static/documentation/images/image030.jpg) |
591-
592-
---
593-
**Label** is a type of an annotated object (e.g. person, car, face, etc.)
582+
**Label** is a type of an annotated object (e.g. person, car, vehicle, etc.)
594583

595-
![](static/documentation/images/image032.jpg)
584+
![](static/documentation/images/image032_DETRAC.jpg)
596585

597586
---
598587

@@ -608,9 +597,10 @@ quality, etc.). There are two types of attributes:
608597
![](static/documentation/images/image072.jpg)
609598

610599
---
611-
**Track** is a set of shapes on different frames which corresponds to one object. Tracks are created in ``Interpolation mode``
600+
**Track** is a set of shapes on different frames which corresponds to one object.
601+
Tracks are created in ``Track mode``
612602

613-
![](static/documentation/images/gif004.gif)
603+
![](static/documentation/images/gif003_DETRAC.gif)
614604

615605
---
616606
**Annotation** is a set of shapes and tracks. There are several types of annotations:

0 commit comments

Comments
 (0)