-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Changes from all commits
Commits
Show all changes
61 commits
Select commit
Hold shift + click to select a range
2a78dfb
User Guide update v1
b69fa50
Fix codacy issue and missing definitions
15588bc
Fix codacy issue v1
f2e92a9
Fix codacy issue v2
a167232
Fix codacy issue and ordered lists
107ffc9
Fix codacy issue, ordered lists and hyperlink
ccb58ec
Fix codacy issue and ordered lists v3
b24bf5b
Fix ordered lists v4
f0b878c
Fix codacy issues v5
b8b7761
Cancel the "task sync" image change
fba03a8
Fix codacy issue v6
93cbcde
Fix codacy issues v7
f496874
Fix codacy issues v8
62f6306
Fix codacy issues v9
45c1add
Update image131.jpg
857d206
Fix codacy issues v10
fb57b2e
Fix codacy issues v11
2345f52
Fix codacy issues v12
fb67a52
Fix codacy issues v13
80cdb6a
Fix codacy issues v14
4c0e1fa
Fix codacy issues v15
de45cc2
Fix codacy issues v16
80d0855
Fix codacy issues v17
175c5f3
Fix codacy issues v18
8ff0e06
Fix codacy issues v19
5ab6e03
Fix codacy issues v20
bdf7b74
Fix codacy issues v21
a871331
Fix codacy issues v22
299a2e7
Fix codacy issues v22
dadd30d
Fix codacy issues v23
54d17b5
Fix codacy issues v24
63c2d1a
Fix codacy issues v24
4704b00
Fix codacy issues v25
72072dd
Fix codacy issues v25
d582349
Fix codacy issues v26
6fe48c6
Fix codacy issues v27
057a8b8
Fix codacy issues v28
bccbde9
Fix codacy issues v29
d417d24
Update section "Model Manager" and update images
d85b85f
Revert "Update section "Model Manager" and update images"
9c3accb
Merge remote-tracking branch 'upstream/develop' into User-Guide-update
3ec9485
Updating the Model Manager section and images
8df45cc
Fix codacy issues
241e35f
Fix codacy issues v2
6dde18d
Merge remote-tracking branch 'upstream/develop' into develop
99be418
Updating text and images in the Auto Annotation section
1d0063a
Fix codacy issues v1
a42f022
Fix codacy issues v2
1546e81
Change extension "JPG" to "jpg"
aa3f677
Delete images with the extension "JPG"
e84facd
Added images with the extension "jpg"
d6e0791
Added image "ReID merge" and change image "search"
cfc7559
Merge remote-tracking branch 'upstream/develop' into develop
6d35976
Update image "Analytics"
bb36340
Fix user_guide.md
e5a9c4d
Fix user_guide.md v2
525dc15
Merge remote-tracking branch 'upstream/develop' into develop
d36079f
Update section "Task synchronization with a repository" and update im…
0f13df9
Merge remote-tracking branch 'upstream/develop' into develop
9d9fcc6
Update item "Creating an annotation task"
e405903
Update images and user_guide.md
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file not shown.
Binary file added
BIN
+116 KB
cvat/apps/documentation/static/documentation/images/image007_DETRAC.jpg
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
BIN
-299 Bytes
(97%)
cvat/apps/documentation/static/documentation/images/image123.jpg
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
BIN
+797 Bytes
(110%)
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.
Binary file modified
BIN
+2.06 KB
(110%)
cvat/apps/documentation/static/documentation/images/image125.jpg
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
BIN
-10.4 KB
(73%)
cvat/apps/documentation/static/documentation/images/image126.jpg
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
BIN
+8.74 KB
(130%)
cvat/apps/documentation/static/documentation/images/image128.jpg
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
BIN
-7.6 KB
(88%)
cvat/apps/documentation/static/documentation/images/image131.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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). | ||
|
@@ -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. | ||
|
@@ -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. | ||
|
||
**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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @azhavoro , could you please confirm that we support chunks of size 1? |
||
|
||
**Dataset Repository**. URL link of the repository optionally specifies the path to the repository for storage | ||
(``default: annotation / <dump_file_name> .zip``). | ||
|
@@ -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. | ||
|
@@ -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) | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@azhavoro , could you please work with Timur to resolve the unclear description? We wanted to update it in the UI as well.