diff --git a/cvat/apps/documentation/static/documentation/images/image067.jpg b/cvat/apps/documentation/static/documentation/images/image067.jpg index 40384b8e5b1c..ce8cba2b2349 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image067.jpg and b/cvat/apps/documentation/static/documentation/images/image067.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image068.jpg b/cvat/apps/documentation/static/documentation/images/image068.jpg deleted file mode 100644 index 9d8eae4e76af..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/image068.jpg and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/image068_mapillary_vistas.jpg b/cvat/apps/documentation/static/documentation/images/image068_mapillary_vistas.jpg new file mode 100644 index 000000000000..86178d57cc44 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image068_mapillary_vistas.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image152_DETRAC.jpg b/cvat/apps/documentation/static/documentation/images/image152_DETRAC.jpg new file mode 100644 index 000000000000..8bfdcb0d3811 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image152_DETRAC.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image155.jpg b/cvat/apps/documentation/static/documentation/images/image155.jpg new file mode 100644 index 000000000000..5081f66de030 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image155.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image164_mapillary_vistas.jpg b/cvat/apps/documentation/static/documentation/images/image164_mapillary_vistas.jpg new file mode 100644 index 000000000000..8869db3b84f7 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image164_mapillary_vistas.jpg differ diff --git a/cvat/apps/documentation/user_guide.md b/cvat/apps/documentation/user_guide.md index b19e960273a6..f80274cbd84e 100644 --- a/cvat/apps/documentation/user_guide.md +++ b/cvat/apps/documentation/user_guide.md @@ -100,7 +100,7 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you **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) @@ -109,49 +109,49 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you ![](static/documentation/images/image125.jpg) - The following actions are available here: - 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 following actions are available here: + 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. 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. - After all the necessary labels are added click the ``Done`` button. - After clicking ``Done`` the added labels would be displayed as separate elements of different colour. - You can edit or delete labels by clicking ``Update attributes`` or ``Delete label``. + Click the ``Continue`` button to add more labels. + If you need to cancel adding a label - press the ``Cancel`` button. + After all the necessary labels are added click the ``Done`` button. + After clicking ``Done`` the added labels would be displayed as separate elements of different colour. + You can edit or delete labels by clicking ``Update attributes`` or ``Delete label``. - - The ``Raw`` is a way of working with labels for an advanced user. - Raw presents label data in _json_ format with an option of editing and copying labels as a text. - The ``Done`` button applies the changes and the ``Reset`` button cancels the changes. + - The ``Raw`` is a way of working with labels for an advanced user. + Raw presents label data in _json_ format with an option of editing and copying labels as a text. + 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. + **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). - + ![](static/documentation/images/image127.jpg) #### Advanced configuration - ![](static/documentation/images/image128.jpg) + ![](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. Use the value from ``1`` (completely compressed images) to ``95`` (almost not compressed images). @@ -190,8 +190,8 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you For example, enter ``25`` to leave every twenty fifth frame in the video or every twenty fifth image. **Chunk size**. Defines a number of frames to be packed in a chunk when send from client to server. - Server defines automatically if empty. - + Server defines automatically if empty. + Recommended values: - 1080p or less: 36 - 2k or less: 8 - 16 @@ -248,32 +248,32 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you Push ``Open`` button to go to task details. -1. Task details is a task page which contains a preview, a progress bar +1. Task details is a task page which contains a preview, a progress bar and the details of the task (specified when the task was created) and the jobs section. - + ![](static/documentation/images/image131_DETRAC.jpg) - The next actions are available on this page: 1. Change the task’s title. - 1. Open ``Actions`` menu. + 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. + 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 + 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. - ``Jobs`` — is a list of all jobs for a particular task. Here you can find the next data: - Jobs name with 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. + - 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. + - 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. + - ``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 @@ -285,33 +285,33 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you ### Models -On the ``Models`` page allows you to manage your deep learning (DL) models uploaded for auto annotation. -Using the functionality you can upload, update or delete a specific DL model. -To open the model manager, click the ``Models`` button on the navigation bar. +On the ``Models`` page allows you to manage your deep learning (DL) models uploaded for auto annotation. +Using the functionality you can upload, update or delete a specific DL model. +To open the model manager, click the ``Models`` button on the navigation bar. The ``Models`` page contains information about all the existing models. The list of models is divided into two sections: -- Primary — contains default CVAT models. Each model is a separate element. -It contains the model’s name, a framework on which the model was based on and +- Primary — contains default CVAT models. Each model is a separate element. +It contains the model’s name, a framework on which the model was based on and ``Supported labels`` (a dropdown list of all supported labels). -- Uploaded by a user — Contains models uploaded by a user. -The list of user models has additional columns with the following information: -name of the user who uploaded the model and the upload date. +- Uploaded by a user — Contains models uploaded by a user. +The list of user models has additional columns with the following information: +name of the user who uploaded the model and the upload date. Here you can delete models in the ``Actions`` menu. ![](static/documentation/images/image099.jpg) -In order to add your model, click `` Create new model``. -Enter model name, and select model file using "Select files" button. +In order to add your model, click `` Create new model``. +Enter model name, and select model file using "Select files" button. To annotate a task with a custom model you need to prepare 4 files: -- ``Model config`` (*.xml) - a text file with network configuration. -- ``Model weights`` (*.bin) - a binary file with trained weights. -- ``Label map`` (*.json) - a simple json file with label_map dictionary like an object with +- ``Model config`` (*.xml) - a text file with network configuration. +- ``Model weights`` (*.bin) - a binary file with trained weights. +- ``Label map`` (*.json) - a simple json file with label_map dictionary like an object with string values for label numbers. -- ``Interpretation script`` (*.py) - a file used to convert net output layer to a predefined structure -which can be processed by CVAT. +- ``Interpretation script`` (*.py) - a file used to convert net output layer to a predefined structure +which can be processed by CVAT. You can learn more about creating model files by pressing [(?)](/cvat/apps/auto_annotation). -Check the box `` Load globally`` if you want everyone to be able to use the model. -Click the ``Submit`` button to submit a model. +Check the box `` Load globally`` if you want everyone to be able to use the model. +Click the ``Submit`` button to submit a model. ![](static/documentation/images/image104.jpg) @@ -348,7 +348,7 @@ The tool consists of: - ``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 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) @@ -362,17 +362,17 @@ The tool consists of: ![](static/documentation/images/image008.jpg) -1. To navigate the image, use the button on the controls sidebar. - Another way an image can be moved/shifted is by holding the left mouse button inside - an area without annotated objects. +1. To navigate the image, use the button on the controls sidebar. + Another way an image can be moved/shifted is by holding the left mouse button inside + an area without annotated objects. If the ``Mouse Wheel`` is pressed, then all annotated objects are ignored. Otherwise the a highlighted bounding box will be moved instead of the image itself. ![](static/documentation/images/image136.jpg) -1. You can use the button on the sidebar controls to zoom on a region of interest. +1. You can use the button on the sidebar controls to zoom on a region of interest. Use the button ``Fit the image`` to fit the image in the workspace. - You can also use the mouse wheel to scale the image + You can also use the mouse wheel to scale the image (the image will be zoomed relatively to your current cursor position). ![](static/documentation/images/image137.jpg) @@ -406,16 +406,16 @@ Usage examples: ![](static/documentation/images/image082.jpg) - Before you start, select the correct `` Label`` (should be specified by you when creating the task) + Before you start, select the correct `` Label`` (should be specified by you when creating the task) and `` Drawing Method`` (by 2 points or by 4 points): - ![](static/documentation/images/image080.jpg) + ![](static/documentation/images/image080.jpg) 1. Creating a new annotation in ``Shape mode``: - - Create a separate ``Rectangle`` by clicking on ``Shape``. + - Create a separate ``Rectangle`` by clicking on ``Shape``. - ![](static/documentation/images/image081.jpg) + ![](static/documentation/images/image081.jpg) - Choose the opposite points. Your first rectangle is ready! @@ -428,7 +428,7 @@ Usage examples: You can also undo your actions using ``Ctrl+Z`` and redo them with ``Shift+Ctrl+Z`` or ``Ctrl+Y``. 1. You can see the ``Object card`` in the objects sidebar or open it by right-clicking on the object. - You can change the attributes in the details section. + You can change the attributes in the details section. You can perform basic operations or delete an object by clicking on the action menu button. ![](static/documentation/images/image012.jpg) @@ -445,10 +445,10 @@ Usage examples: - Add/modify/delete objects for existing annotations. - Edit tracks, merge several rectangles into one track. -1. Like in the ``Shape mode``, you need to select a ``Rectangle`` on the sidebar, +1. Like in the ``Shape mode``, you need to select a ``Rectangle`` on the sidebar, in the appearing form, select the desired ``Label`` and the ``Drawing method``. - ![](static/documentation/images/image083.jpg) + ![](static/documentation/images/image083.jpg) 1. Creating a track for an object (look at the selected car as an example): - Create a ``Rectangle`` in ``Track mode`` by clicking on ``Track``. @@ -461,8 +461,8 @@ Usage examples: ![](static/documentation/images/image016.jpg) - - If the object starts to change its position, you need to modify the rectangle where it happens. - It isn't necessary to change the rectangle on each frame, simply update several keyframes + - If the object starts to change its position, you need to modify the rectangle where it happens. + It isn't necessary to change the rectangle on each frame, simply update several keyframes and the frames between them will be interpolated automatically. - Let's jump 30 frames forward and adjust the boundaries of the object. See an example below: @@ -487,7 +487,7 @@ Usage examples: ![](static/documentation/images/gif001_DETRAC.gif) - - Click ``Merge`` button or press key ``M`` and click on any rectangle of the first track + - Click ``Merge`` button or press key ``M`` and click on any rectangle of the first track and on any rectangle of the second track and so on: ![](static/documentation/images/image162_DETRAC.jpg) @@ -505,7 +505,7 @@ Usage examples: ### Attribute annotation mode (basics) -- In this mode you can edit attributes with fast navigation between objects and frames using a keyboard. +- In this mode you can edit attributes with fast navigation between objects and frames using a keyboard. Open the drop-down list in the top panel and select Attribute annotation Mode. ![](static/documentation/images/image023_Affectnet.jpg) @@ -519,7 +519,7 @@ Usage examples: or select from the drop-down list. ![](static/documentation/images/image024_Affectnet.jpg) - + - Press ``Up Arrow``/``Down Arrow`` on your keyboard or click the buttons in the UI to go to the next/previous attribute. In this case, after pressing ``Down Arrow`` you will be able to edit the ``Age`` attribute. @@ -527,14 +527,14 @@ Usage examples: - Use ``Right Arrow``/``Left Arrow`` keys to move to the previous/next image with annotation. -To see all the hot keys available in the attribute annotation mode, press ``F2``. +To see all the hot keys available in the attribute annotation mode, press ``F2``. Read more in the section [attribute annotation mode (advanced)](#attribute-annotation-mode-advanced). ### Downloading annotations -1. To download the latest annotations, you have to save all changes first. +1. To download the latest annotations, you have to save all changes first. click the ``Save`` button. There is a ``Ctrl+S`` shortcut to save annotations quickly. -1. After that, сlick the ``Menu`` button. +1. After that, сlick the ``Menu`` button. 1. Press the ``Dump Annotation`` button. ![](static/documentation/images/image028.jpg) @@ -545,7 +545,7 @@ Read more in the section [attribute annotation mode (advanced)](#attribute-annot - [CVAT for images](/cvat/apps/documentation/xml_format.md#annotation) is highlighted if a task has the annotation mode. - ![](static/documentation/images/image029.jpg "Example XML format") + ![](static/documentation/images/image029.jpg "Example XML format") - [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) - [(VOC) Segmentation mask](http://host.robots.ox.ac.uk/pascal/VOC/) — @@ -596,7 +596,7 @@ quality, etc.). There are two types of attributes: ![](static/documentation/images/image072.jpg) --- -**Track** is a set of shapes on different frames which corresponds to one object. +**Track** is a set of shapes on different frames which corresponds to one object. Tracks are created in ``Track mode`` ![](static/documentation/images/gif003_DETRAC.gif) @@ -631,58 +631,54 @@ In addition the workspace also has the following functions: --- ### Settings -Press ``F2`` to access settings menu. +To open the settings open the user menu in the header and select the settings item or press ``F3``. ![](static/documentation/images/image067.jpg) -There is ``Player Settings`` which adjusts ``Workspace`` and ``Other Settings``. +``Settings`` have two tabs: -In ``Player Settings`` you can: -- Control step of ``C`` and ``V`` shortcuts -- Control speed of ``Space``/``Play`` button -- Show every image in full or zoomed out like previous - (it is enabled by default for interpolation mode and disabled for annotation mode) -- Enable ``Grid`` when you don't need small objects. ``Grid`` can have - different opacity, color and cells' size — use ``F2`` to configure settings. +In tab ``Player`` you can: +- Control step of ``C`` and ``V`` shortcuts. +- Control speed of ``Space``/``Play`` button. +- Show ``Grid``, change grid size, choose color and transparency: - ![](static/documentation/images/image068.jpg) + ![](static/documentation/images/image068_mapillary_vistas.jpg) -- Adjust ``Brightness``/``Contrast``/``Saturation`` of too exposing or too - dark images using ``F2`` — color settings (changes displaying and not the +- Show every image in full size or zoomed out like previous + (it is enabled by default for interpolation mode and disabled for annotation mode). +- ``Rotate all images`` checkbox — switch the rotation of all frames or an individual frame. +- Adjust ``Brightness``/``Contrast``/``Saturation`` of too exposed or too + dark images using ``F3`` — color settings (changes displaying settings and not the image itself). Shortcuts: -- ``Shift+B``/``Alt+B`` for brightness -- ``Shift+C``/``Alt+C`` for contrast -- ``Shift+S``/``Alt+S`` for saturation -- ``F2`` —> ``Reset Color Settings`` to default values +- ``Shift+B+=``/``Shift+B+-`` for brightness. +- ``Shift+C+=``/``Shift+C+-`` for contrast. +- ``Shift+S+=``/``Shift+S+-`` for saturation. - ![](static/documentation/images/image069.jpg) + ![](static/documentation/images/image164_mapillary_vistas.jpg) -``Other Settings`` contains: -- ``Show All Interpolation Tracks`` checkbox — shows hidden object on the - side panel for every interpolated object (turned off by default) -- ``AAM Zoom Margin`` slider — defines margins for shape in attribute annotation mode -- ``Enable AutoSaving`` checkbox — turned off by default -- ``AutoSaving Interval (min)`` input box — 15 minutes by default -- ``Rotate all images`` checkbox — switch the rotation of all frames / individual frame +- ``Reset color settings`` to default values. --- -### Bottom Panel -![](static/documentation/images/image035.jpg) +In tab ``Workspace`` you can: ---- -Go to the first and latest frames. +![](static/documentation/images/image155.jpg) -![](static/documentation/images/image036.jpg) +- ``Enable auto save`` checkbox — turned off by default. +- ``Auto save interval (min)`` input box — 15 minutes by default. +- ``Show all interpolation tracks`` checkbox — shows hidden objects on the + side panel for every interpolated object (turned off by default). +- ``Always show object details`` - show text for an object on the canvas not only when the object is activated: ---- -Go to the next/previous frame with a predefined step. Shortcuts: -``V`` — step backward, ``C`` — step forward. By default the step is ``10`` -(change at ``Open Menu`` —> ``Settings`` —> ``Player Step``). + ![](static/documentation/images/image152_DETRAC.jpg) -![](static/documentation/images/image037.jpg) +- ``Automatic bordering`` - enable automatic bordering for polygons and polylines during drawing/editing. + For more information To find out more, go to the section [annotation with polygons](#Annotation-with-polygons). +- ``Attribute annotation mode (AAM) zoom margin`` input box — defines margins (in px) + for shape in the attribute annotation mode. +- Press `` Go back`` or ``F3`` to return to the annotation. --- Go to the next/previous frame with step equals to 1. Shortcuts: ``D`` — previous, ``F`` — next. @@ -940,15 +936,15 @@ By default, objects in the mode are zoomed. Check ``Open Menu`` —> ``Settings`` —> ``AAM Zoom Margin`` to adjust that. ## Annotation with box by 4 points -It is an efficient method of bounding box annotation, proposed -[here](https://arxiv.org/pdf/1708.02750.pdf). +It is an efficient method of bounding box annotation, proposed +[here](https://arxiv.org/pdf/1708.02750.pdf). Before starting, you need to be sure that ``Box by 4 points`` is selected. ![](static/documentation/images/image134.jpg) -Press ``N`` for entering drawing mode. Click exactly four extreme points: -the top, bottom, left- and right-most physical points on the object. -Drawing is automatically completed right after clicking the fourth point. +Press ``N`` for entering drawing mode. Click exactly four extreme points: +the top, bottom, left- and right-most physical points on the object. +Drawing is automatically completed right after clicking the fourth point. Press ``Esc`` to cancel editing. ![](static/documentation/images/gif016.gif) @@ -1023,9 +1019,9 @@ automatically. You can adjust the polyline after it has been drawn. ## Annotation with cuboids -It is used to annotate 3 dimensional objects such as cars, boxes, etc... +It is used to annotate 3 dimensional objects such as cars, boxes, etc... Currently the feature supports one point perspective and has the contraint -where the vertical edges are exactly parallel to the sides. +where the vertical edges are exactly parallel to the sides. ### Creating the cuboid @@ -1036,9 +1032,9 @@ You may draw the cuboid by placing 4 points, after which the drawing completes a The first 3 points will represent a plane of the cuboid while the last point represents the depth of that plane. For the first 3 points, it is recomended to only draw the 2 closest side faces, -as well as the top and bottom face. +as well as the top and bottom face. -A few examples: +A few examples: ![](static/documentation/images/CuboidDrawing1.gif) ![](static/documentation/images/CuboidDrawing2.gif) @@ -1047,12 +1043,12 @@ A few examples: ### Editing the cuboid -The cuboid can be edited in multiple ways, by dragging points or by dragging certain faces. -First notice that there is a face that is painted with pink lines only, let us call it the front face. +The cuboid can be edited in multiple ways, by dragging points or by dragging certain faces. +First notice that there is a face that is painted with pink lines only, let us call it the front face. -The cuboid can be moved by simply dragging the shape as normal. -The cuboid can be extended by dragging on the point in the middle of the edges. -The cuboid can also be extended up and down by dragging the point at the vertices. +The cuboid can be moved by simply dragging the shape as normal. +The cuboid can be extended by dragging on the point in the middle of the edges. +The cuboid can also be extended up and down by dragging the point at the vertices. ![](static/documentation/images/CuboidEditing1.gif) @@ -1063,17 +1059,17 @@ The cuboid can then be edited as usual. ![](static/documentation/images/EditingPerspective.gif) If you wish to reset perspective effects, you may right click on cuboid, -and select ``Reset Perspective`` to return to a regular cuboid. +and select ``Reset Perspective`` to return to a regular cuboid. The location of the pink face can be swapped with the adjacent visible side face. This is done by right clicking on the cuboid and selecting ``Switch Perspective Orientation``. -Note that this will also reset the perspective effects. +Note that this will also reset the perspective effects. ![](static/documentation/images/ResetPerspective.gif) Certain faces of the cuboid can also be edited, -these faces are the left, right and dorsal faces, relative to the pink face. -Simply drag the faces to move them independently from the rest of the cuboid. +these faces are the left, right and dorsal faces, relative to the pink face. +Simply drag the faces to move them independently from the rest of the cuboid. ![](static/documentation/images/CuboidEditing2.gif) @@ -1105,14 +1101,14 @@ You can add/delete points after finishing. You can use linear interpolation for points to annotate a moving object: -1. Before starting, you have to be sure that ``Points`` is selected. -1. Linear interpolation works only with one point, so you need to set ``Poly Shapes Size``: 1. +1. Before starting, you have to be sure that ``Points`` is selected. +1. Linear interpolation works only with one point, so you need to set ``Poly Shapes Size``: 1. 1. After that select the interpolation mode. - + ![](static/documentation/images/image122.jpg) 1. Press ``N`` or click ``Create Shape`` for entering drawing mode. - Click LMB to create a point and shape will be automatically completed. + Click LMB to create a point and shape will be automatically completed. ![](static/documentation/images/gif011_DETRAC.gif) @@ -1146,25 +1142,25 @@ a shape is created and you can work with it as a polygon. ## Automatic annotation -Automatic Annotation is used for creating preliminary annotations. -To use Automatic Annotation you need a DL model. You can use primary models or models uploaded by a user. +Automatic Annotation is used for creating preliminary annotations. +To use Automatic Annotation you need a DL model. You can use primary models or models uploaded by a user. You can find the list of available models in the ``Models`` section. -1. To launch automatic annotation, you should open the dashboard and find a task which you want to annotate. +1. To launch automatic annotation, you should open the dashboard and find a task which you want to annotate. Then click the ``Actions`` button and choose option ``Automatic Annotation`` from the dropdown menu. ![](static/documentation/images/image119_DETRAC.jpg) -1. In the dialog window select a model you need. DL models are created for specific labels, e.g. - the Crossroad model was taught using footage from cameras located above the highway and it is best to - use this model for the tasks with similar camera angles. - If it's necessary select the ``Clean old annotations`` checkbox. - Adjust the labels so that the task labels will correspond to the labels of the DL model. - For example, let’s consider a task where you have to annotate labels “car” and “person”. - You should connect the “person” label from the model to the “person” label in the task. - As for the “car” label, you should choose the most fitting label available in the model - the “vehicle” label. - The task requires to annotate cars only and choosing the “vehicle” label implies annotation of all vehicles, - in this case using auto annotation will help you complete the task faster. +1. In the dialog window select a model you need. DL models are created for specific labels, e.g. + the Crossroad model was taught using footage from cameras located above the highway and it is best to + use this model for the tasks with similar camera angles. + If it's necessary select the ``Clean old annotations`` checkbox. + Adjust the labels so that the task labels will correspond to the labels of the DL model. + For example, let’s consider a task where you have to annotate labels “car” and “person”. + You should connect the “person” label from the model to the “person” label in the task. + As for the “car” label, you should choose the most fitting label available in the model - the “vehicle” label. + The task requires to annotate cars only and choosing the “vehicle” label implies annotation of all vehicles, + in this case using auto annotation will help you complete the task faster. Click ``Submit`` to begin the automatic annotation process. ![](static/documentation/images/image120.jpg) @@ -1178,9 +1174,9 @@ You can find the list of available models in the ``Models`` section. ![](static/documentation/images/gif014_DETRAC.gif) 1. Separated bounding boxes can be edited by removing false positives, adding unlabeled objects and - merging into tracks using ``ReID merge`` function. Click the ``ReID merge`` button in the menu. - You can use the default settings (for more information click [here](cvat/apps/reid/README.md)). - To launch the merging process click ``Merge``. Each frame of the track will be a key frame. + merging into tracks using ``ReID merge`` function. Click the ``ReID merge`` button in the menu. + You can use the default settings (for more information click [here](cvat/apps/reid/README.md)). + To launch the merging process click ``Merge``. Each frame of the track will be a key frame. ![](static/documentation/images/image133.jpg)