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 Bottom panel in User Guide #1509

Merged
merged 3 commits into from
May 18, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
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.
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.
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.
122 changes: 52 additions & 70 deletions cvat/apps/documentation/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -702,117 +702,99 @@ Go to the next/previous frame with a predefined step. Shortcuts:
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)
**Main functions**
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's remove the sentence


---
**Open Menu** button
**Menu** button
Copy link
Contributor

Choose a reason for hiding this comment

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

You can use next level header here. Does it make sense?

Suggested change
**Menu** button
#### Menu button


It is the main menu of the annotation tool. It can be used to download, upload and remove annotations.
It is the main menu of the annotation tool. It can be used to download, upload and remove annotations.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please adjust your editor to remove trailing space at the end.


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

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.)
- ``Dump Annotations`` — downloads annotations from a task.
- ``Upload Annotations`` — uploads annotations from a task.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- ``Upload Annotations`` — uploads annotations from a task.
- ``Upload Annotations`` — uploads annotations into a task.

- ``Remove Annotations`` — removes annotations from current job.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- ``Remove Annotations`` — removes annotations from current job.
- ``Remove Annotations`` — removes annotations from the current job.

- ``Open the task`` — opens the task page.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- ``Open the task`` — opens the task page.
- ``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).

---
**Filter** input box
**Save Work** — saves annotations for the current job. The button has an
Copy link
Contributor

Choose a reason for hiding this comment

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

#### Save Work

It saves annotations for the current job. The button has an indication of the saving progress

indication of the saving process.

The way how to use filters is described in the advanced guide (below).
![](static/documentation/images/image141.jpg)

![](static/documentation/images/image059.jpg)
**Undo-redo** buttons

---
**History / Undo-redo** panel
Use buttons to undo actions or redo them.

Use ``Ctrl+Z`` for undo actions and ``Ctrl+Shift+Z`` or ``Ctrl+Y`` to 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)
**Player**

![](static/documentation/images/image101.jpg)
Go to the first /the latest frames.

---
**Rotation** of an image
![](static/documentation/images/image036.jpg)

Buttons are used to rotate the image clockwise / counterclockwise or use ``Ctrl+R``/``Ctrl+Shift+R``
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``).

![](static/documentation/images/image102.jpg)
![](static/documentation/images/image037.jpg)

---
**Fill Opacity** slider
Go to the next/previous frame (the step is 1 frame). Shortcuts: ``D`` — previous, ``F`` — next.

Change opacity of every bounding box in the annotation.
![](static/documentation/images/image040.jpg)

![](static/documentation/images/image086.jpg)
Play the sequence of frames or the set of images.
Shortcut: ``Space`` (change at ``Account Menu`` —> ``Settings`` —> ``Player Speed``).

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.
![](static/documentation/images/image041.jpg)

**Selected Fill Opacity** slider
Go to a specific frame. Press ``~`` to focus on the element.

Change the opacity of the selected object's fill.
![](static/documentation/images/image060.jpg)

![](static/documentation/images/image087.jpg)
---
**UI Switches**

**Fullscreen Player** — the fullscreen player mode. The keyboard shortcut is ``F11``.

Opacity can be changed from 0% to 100%.
![](static/documentation/images/image143.jpg)

**Black Stroke** checkbox
**Info** — open the job info.

Change bounding box border from white/colored to black.
![](static/documentation/images/image144_DETRAC.jpg)

![](static/documentation/images/image088.jpg)
- Job status: ``annotation``, ``validation`` or ``completed`` task

**Color By** options
_Overview_:

Change the color scheme of annotation:
- ``Instance`` — every bounding box has random color
- ``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/image095.jpg)
_Annotations statistics_:

- ``Group`` — every group of boxes has its own random color, ungrouped boxes are white
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/image094.jpg)
**UI switcher** — switching between user interface modes.

- ``Label`` — every label (e.g. vehicle, pedestrian, road marks) has its own random color
![](static/documentation/images/image145.jpg)

![](static/documentation/images/image093.jpg)
---

You can change any random color pointing on needed box on a frame or on a
side panel and press ``Enter``.

---
Copy link
Contributor

Choose a reason for hiding this comment

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

@TOsmanov , double line at the end of the section. Is it expected?

### Side panel
Expand Down