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 "Creating an annotation task" in User Guide #1363

Merged
merged 61 commits into from
Apr 8, 2020
Merged
Changes from 1 commit
Commits
Show all changes
61 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
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
Prev Previous commit
Next Next commit
Fix codacy issue v1
  • Loading branch information
timurx.osmanov committed Dec 17, 2019
commit 15588bceb351954e04d95ea46fe72655f6a07835
92 changes: 47 additions & 45 deletions cvat/apps/documentation/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
- [Annotation with polygons](#annotation-with-polygons)
- [Annotation with polylines](#annotation-with-polylines)
- [Annotation with points](#annotation-with-points)
- [Points in annotation mode](#points-in-annotation-mode)
- [Linear interpolation with one point](#linear-interpolation-with-one-point)
- [Annotation with Auto Segmentation](#annotation-with-auto-segmentation)
- [Auto annotation](#auto-annotation)
- [Shape grouping](#shape-grouping)
Expand Down Expand Up @@ -55,7 +57,7 @@ computer vision tasks developed by our team.

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

- For register a new user press "Create an account"
- For register a new user press "Create an account"

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

Expand Down Expand Up @@ -94,33 +96,33 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you
![](static/documentation/images/image005.jpg)

**Labels**. There are two ways of working with labels:
- The ``Constructor`` is a simple way to add and adjust labels.
To add a new label click the ``Add label`` button.

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

You can set a name of the label in the ``Label name`` field.

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

If necessary you can add an attribute and set its properties by clicking ``Add an attribute``:

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

1. Set the attribute’s name.
1. Choose the way to display the attribute:
- Select — drop down list of value
- Radio — is used when it is necessary to choose just one option out of few suggested.
- Checkbox — is used when it is necessary to choose any number of options out of suggested.
- Text — is used when an attribute is entered as a text.
- Number — is used when an attribute is entered as a number.
1. Set values for the attribute. The values could be separated by pressing ``Enter``.
- The ``Constructor`` is a simple way to add and adjust labels.
To add a new label click the ``Add label`` button.
![](static/documentation/images/image123.jpg)
You can set a name of the label in the ``Label name`` field.
![](static/documentation/images/image124.jpg)
If necessary you can add an attribute and set its properties by clicking ``Add an attribute``:
![](static/documentation/images/image125.jpg)

1. Set the attribute’s name.
1. Choose the way to display the attribute:
- Select — drop down list of value
- Radio — is used when it is necessary to choose just one option out of few suggested.
- Checkbox — is used when it is necessary to choose any number of options out of suggested.
- Text — is used when an attribute is entered as a text.
- Number — is used when an attribute is entered as a number.
1. Set values for the attribute. The values could be separated by pressing ``Enter``.
The entered value is displayed as a separate element which could be deleted
by pressing ``Backspace`` or clicking the close button (x).
If the specified way of displaying the attribute is Text or Number,
the entered value will be displayed as text by default (e.g. you can specify the text format).
1. Checkbox ``Mutable`` determines if an attribute would be changed frame to frame.
1. You can delete the attribute by clicking the close button (x).
1. Checkbox ``Mutable`` determines if an attribute would be changed frame to frame.
1. You can delete the attribute by clicking the close button (x).

Click the ``Continue`` button to add more labels.
If you need to cancel adding a label - press the ``Cancel`` button.
Expand Down Expand Up @@ -242,27 +244,27 @@ The next actions are available on this page:

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

1. Change the task’s title.
1. Open ``Actions`` menu.
1. Change issue tracker or open issue tracker if it is specified.
1. Change labels.You can add new labels or add attributes for the existing labels in the Raw mode or the Constructor mode.
By clicking ``Copy`` you will copy the labels to the clipboard.
1. Assigned to — is used to assign a task to a person. Start typing an assignee’s name and/or
choose the right person out of the dropdown list.

1. ``Jobs`` — is a list of all jobs for a particular task. Here you can find the next data:
- Jobs name whit a hyperlink to it.
- Frames — the frame interval.
- A status of the job. The status is specified by the user in the menu inside the job.
There are three types of status: annotation, validation or completed.
The status of the job is changes the progress bar of the task.
- Started on — start date of this job.
- Duration — is the amount of time the job is being worked.
- Assignee is the user who is working on the job.
You can start typing an assignee’s name and/or choose the right person out of the dropdown list.
- ``Copy``. By clicking Copy you will copy the job list to the clipboard.
The job list contains direct links to jobs.

1. Change the task’s title.
1. Open ``Actions`` menu.
1. Change issue tracker or open issue tracker if it is specified.
1. Change labels.
You can add new labels or add attributes for the existing labels in the Raw mode or the Constructor mode.
By clicking ``Copy`` you will copy the labels to the clipboard.
1. Assigned to — is used to assign a task to a person. Start typing an assignee’s name and/or
choose the right person out of the dropdown list.

1. ``Jobs`` — is a list of all jobs for a particular task. Here you can find the next data:
- Jobs name whit a hyperlink to it.
- Frames — the frame interval.
- A status of the job. The status is specified by the user in the menu inside the job.
There are three types of status: annotation, validation or completed.
The status of the job is changes the progress bar of the task.
- Started on — start date of this job.
- Duration — is the amount of time the job is being worked.
- Assignee is the user who is working on the job.
You can start typing an assignee’s name and/or choose the right person out of the dropdown list.
- ``Copy``. By clicking Copy you will copy the job list to the clipboard.
The job list contains direct links to jobs.

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
Expand Down