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

Update item "Interface of the annotation tool" in User Guide #1386

Merged
merged 63 commits into from
Apr 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
2a78dfb
User Guide update v1
Dec 13, 2019
b69fa50
Fix codacy issue and missing definitions
Dec 16, 2019
15588bc
Fix codacy issue v1
Dec 17, 2019
f2e92a9
Fix codacy issue v2
Dec 17, 2019
a167232
Fix codacy issue and ordered lists
Dec 17, 2019
107ffc9
Fix codacy issue, ordered lists and hyperlink
Dec 17, 2019
ccb58ec
Fix codacy issue and ordered lists v3
Dec 17, 2019
b24bf5b
Fix ordered lists v4
Dec 17, 2019
f0b878c
Fix codacy issues v5
Dec 17, 2019
b8b7761
Cancel the "task sync" image change
Dec 17, 2019
fba03a8
Fix codacy issue v6
Dec 17, 2019
93cbcde
Fix codacy issues v7
Dec 17, 2019
f496874
Fix codacy issues v8
Dec 17, 2019
62f6306
Fix codacy issues v9
Dec 17, 2019
45c1add
Update image131.jpg
Dec 17, 2019
857d206
Fix codacy issues v10
Dec 18, 2019
fb57b2e
Fix codacy issues v11
Dec 18, 2019
2345f52
Fix codacy issues v12
Dec 18, 2019
fb67a52
Fix codacy issues v13
Dec 18, 2019
80cdb6a
Fix codacy issues v14
Dec 18, 2019
4c0e1fa
Fix codacy issues v15
Dec 18, 2019
de45cc2
Fix codacy issues v16
Dec 18, 2019
80d0855
Fix codacy issues v17
Dec 18, 2019
175c5f3
Fix codacy issues v18
Dec 18, 2019
8ff0e06
Fix codacy issues v19
Dec 18, 2019
5ab6e03
Fix codacy issues v20
Dec 18, 2019
bdf7b74
Fix codacy issues v21
Dec 18, 2019
a871331
Fix codacy issues v22
Dec 18, 2019
299a2e7
Fix codacy issues v22
Dec 18, 2019
dadd30d
Fix codacy issues v23
Dec 18, 2019
54d17b5
Fix codacy issues v24
Dec 18, 2019
63c2d1a
Fix codacy issues v24
Dec 18, 2019
4704b00
Fix codacy issues v25
Dec 18, 2019
72072dd
Fix codacy issues v25
Dec 18, 2019
d582349
Fix codacy issues v26
Dec 18, 2019
6fe48c6
Fix codacy issues v27
Dec 18, 2019
057a8b8
Fix codacy issues v28
Dec 18, 2019
bccbde9
Fix codacy issues v29
Dec 18, 2019
d417d24
Update section "Model Manager" and update images
Dec 19, 2019
d85b85f
Revert "Update section "Model Manager" and update images"
Dec 19, 2019
9c3accb
Merge remote-tracking branch 'upstream/develop' into User-Guide-update
Dec 19, 2019
3ec9485
Updating the Model Manager section and images
Dec 19, 2019
8df45cc
Fix codacy issues
Dec 19, 2019
241e35f
Fix codacy issues v2
Dec 20, 2019
6dde18d
Merge remote-tracking branch 'upstream/develop' into develop
Dec 23, 2019
99be418
Updating text and images in the Auto Annotation section
Dec 23, 2019
1d0063a
Fix codacy issues v1
Dec 23, 2019
a42f022
Fix codacy issues v2
Dec 23, 2019
1546e81
Change extension "JPG" to "jpg"
Dec 23, 2019
aa3f677
Delete images with the extension "JPG"
Dec 23, 2019
e84facd
Added images with the extension "jpg"
Dec 23, 2019
d6e0791
Added image "ReID merge" and change image "search"
Dec 24, 2019
cfc7559
Merge remote-tracking branch 'upstream/develop' into develop
Dec 24, 2019
6d35976
Update image "Analytics"
Dec 24, 2019
bb36340
Fix user_guide.md
Dec 24, 2019
e5a9c4d
Fix user_guide.md v2
Dec 25, 2019
525dc15
Merge remote-tracking branch 'upstream/develop' into develop
Dec 25, 2019
d36079f
Update section "Task synchronization with a repository" and update im…
Dec 25, 2019
0f13df9
Merge remote-tracking branch 'upstream/develop' into develop
Apr 3, 2020
9d9fcc6
Update item "Creating an annotation task"
Apr 6, 2020
e405903
Update images and user_guide.md
Apr 7, 2020
4b3376e
Update item "Interface of the annotation tool"
Apr 9, 2020
19f3dd5
Update user_gide.md
Apr 9, 2020
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
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 cvat/apps/documentation/static/documentation/images/image124.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 26 additions & 16 deletions cvat/apps/documentation/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you
The ``Done`` button applies the changes and the ``Reset`` button cancels the changes.
![](static/documentation/images/image126.jpg)

In ``Raw`` and ``Constructor`` mode, you can press the ``Copy`` button to copy the list of labels.

**Select files**. Press tab ``My computer`` to choose some files for annotation from your PC.
If you select tab ``Connected file share`` you can choose files for annotation from your network.
If you select `` Remote source`` , you'll see a field where you can enter a list of URLs (one URL per line).
Expand All @@ -147,6 +149,8 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you
![](static/documentation/images/image128.jpg)

**Z-Order**. Defines the order on drawn polygons. Check the box for enable layered displaying.

**Use zip chunks**. Force to use zip chunks as compressed data. Actual for videos only.

**Image Quality**. Use this option to specify quality of uploaded images.
The option helps to load high resolution datasets faster.
Expand Down Expand Up @@ -182,8 +186,17 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you

**Stop frame**. Frame on which video in task ends.

**Frame Filter**. Use this option to filter video frames.
For example, enter ``step=25`` to leave every twenty fifth frame in the video. Use this option on video files only.
**Frame Step**. Use this option to filter video frames.
For example, enter ``25`` to leave every twenty fifth frame in the video. Use this option on video files only.
Copy link
Contributor

Choose a reason for hiding this comment

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

The option should work fine with images as well.


**Chunk size**. Defines a number of frames to be packed in a chunk when send from client to server.
Server defines automatically if empty.

Recommended values:
- 1080p or less: 36
- 2k or less: 8 - 16
- 4k or less: 4 - 8
- More: 1 - 4

**Dataset Repository**. URL link of the repository optionally specifies the path to the repository for storage
(``default: annotation / <dump_file_name> .zip``).
Expand Down Expand Up @@ -232,7 +245,7 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you
- [Pascal VOC 2012](http://host.robots.ox.ac.uk/pascal/VOC/)
- [MS COCO](http://cocodataset.org/#format-data)
- [YOLO](https://pjreddie.com/darknet/yolo/)
- ``Auto Annotation`` — automatic annotation with OpenVINO toolkit.
- ``Automatic Annotation`` — automatic annotation with OpenVINO toolkit.
Presence depends on how you build CVAT instance.
- ``Open bug tracker`` — opens a link to Issue tracker.
- ``Delete`` — delete task.
Expand Down Expand Up @@ -269,7 +282,7 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you
1. Follow a link inside ``Jobs`` section to start annotation process.
In some cases, you can have several links. It depends on size of your
task and ``Overlap Size`` and ``Segment Size`` parameters. To improve
UX, only the first several frames will be loaded and you will be able
UX, only the first chunk of several frames will be loaded and you will be able
to annotate first images. Other frames will be loaded in background.

![](static/documentation/images/image007.jpg)
Expand Down Expand Up @@ -334,18 +347,15 @@ The search is case insensitive.
## Interface of the annotation tool

The tool consists of:
- ``Workspace`` — where images are shown;
- ``Bottom panel`` (under workspace) — for navigation, filtering annotation and accessing tools' menu;
- ``Side panel`` — contains two lists: objects (on the frame) and labels (of objects on the frame);
- ``Bottom side panel`` — contains the main annotation functions (create, merge, group objects).
Here you can choose a type of shape, a label you want to annotate and a mode (annotation or interpolation)

![](static/documentation/images/image034.jpg)

There is also:
- ``Settings`` (F2) — the button inside ``Open Menu`` in the bottom panel. Contains different parameters
which can be adjusted according to the user's needs.
- ``Context menu`` — available on right mouse button.
- ``Header`` - pinned header used to navigate CVAT sections and account settings;
- ``Top panel`` — contains navigation buttons, main functions and menu access;
- ``Workspace`` — space where images are shown;
- ``Controls sidebar`` — contains tools for navigating the image, zoom,
creating shapes and editing tracks (merge, split, group)
- ``Objects sidebar`` — contains label filter, two lists:
objects (on the frame) and labels (of objects on the frame) and appearance settings.

![](static/documentation/images/image034_DETRAC.jpg)

### Basic navigation

Expand Down