Documentation update, adding descriptions to pages located in Basics and Advanced sections of Manual (#3522)

* Added descriptions to sections manual/basics and manual/advanced

* fixed wording + additional description
main
amotovx 5 years ago committed by GitHub
parent e1198c3a1a
commit 508ce7cdba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -2,6 +2,7 @@
title: '3D Object annotation (advanced)' title: '3D Object annotation (advanced)'
linkTitle: '3D Object annotation' linkTitle: '3D Object annotation'
weight: 18 weight: 18
description: 'Overview of advanced operations available when annotating 3D objects.'
--- ---
As well as 2D-task objects, 3D-task objects support the ability to change appearance, attributes, As well as 2D-task objects, 3D-task objects support the ability to change appearance, attributes,

@ -2,6 +2,7 @@
title: 'AI Tools' title: 'AI Tools'
linkTitle: 'AI Tools' linkTitle: 'AI Tools'
weight: 15 weight: 15
description: 'Overview of semi-automatic and automatic annotation tools available in CVAT.'
--- ---
The tool is designed for semi-automatic and automatic annotation using DL models. The tool is designed for semi-automatic and automatic annotation using DL models.

@ -1,7 +1,8 @@
--- ---
title: 'Analytics' title: 'Analytics Monitoring'
linkTitle: 'Analytics' linkTitle: 'Analytics Monitoring'
weight: 28 weight: 28
description: 'Using Analytics to monitor usage statistics.'
--- ---
If your CVAT instance was created with analytics support, you can press the `Analytics` button in the dashboard If your CVAT instance was created with analytics support, you can press the `Analytics` button in the dashboard

@ -2,6 +2,7 @@
title: 'Annotation with cuboids' title: 'Annotation with cuboids'
linkTitle: 'Annotation with cuboids' linkTitle: 'Annotation with cuboids'
weight: 17 weight: 17
description: 'Guide to creating and editing 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...

@ -2,4 +2,5 @@
title: 'Annotation with points' title: 'Annotation with points'
linkTitle: 'Annotation with points' linkTitle: 'Annotation with points'
weight: 11 weight: 11
description: 'Guide to annotating tasks using single points or shapes containing multiple points.'
--- ---

@ -2,4 +2,5 @@
title: 'Annotation with polygons' title: 'Annotation with polygons'
linkTitle: 'Annotation with polygons' linkTitle: 'Annotation with polygons'
weight: 13 weight: 13
description: 'Guide to creating and editing polygons.'
--- ---

@ -2,6 +2,7 @@
title: 'Annotation with polylines' title: 'Annotation with polylines'
linkTitle: 'Annotation with polylines' linkTitle: 'Annotation with polylines'
weight: 12 weight: 12
description: 'Guide to annotating tasks using polylines.'
--- ---
It is used for road markup annotation etc. It is used for road markup annotation etc.

@ -2,6 +2,7 @@
title: 'Attribute annotation mode (advanced)' title: 'Attribute annotation mode (advanced)'
linkTitle: 'Attribute annotation mode' linkTitle: 'Attribute annotation mode'
weight: 6 weight: 6
description: 'Advanced operations available in attribute annotation mode.'
--- ---
Basic operations in the mode were described in section [attribute annotation mode (basics)](/docs/manual/basics/attribute-annotation-mode-basics/). Basic operations in the mode were described in section [attribute annotation mode (basics)](/docs/manual/basics/attribute-annotation-mode-basics/).

@ -2,6 +2,7 @@
title: 'Automatic annotation' title: 'Automatic annotation'
linkTitle: 'Automatic annotation' linkTitle: 'Automatic annotation'
weight: 27 weight: 27
description: 'Guide to using the automatic annotation of tasks.'
--- ---
Automatic Annotation is used for creating preliminary annotations. Automatic Annotation is used for creating preliminary annotations.

@ -2,7 +2,7 @@
title: 'Command line interface (CLI)' title: 'Command line interface (CLI)'
linkTitle: 'CLI' linkTitle: 'CLI'
weight: 32 weight: 32
description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/utils/cli) description: 'Guide to working with CVAT tasks in the command line interface. This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/utils/cli).'
--- ---
**Description** **Description**

@ -2,6 +2,7 @@
title: 'Context images for 2d task' title: 'Context images for 2d task'
linkTitle: 'Context images' linkTitle: 'Context images'
weight: 23 weight: 23
description: 'Adding additional contextual images to a task.'
--- ---
When you create a task, you can provide the images with additional contextual images. When you create a task, you can provide the images with additional contextual images.

@ -2,6 +2,7 @@
title: 'Filter' title: 'Filter'
linkTitle: 'Filter' linkTitle: 'Filter'
weight: 20 weight: 20
description: 'Guide to using the Filter feature in CVAT.'
--- ---
There are some reasons to use the feature: There are some reasons to use the feature:

@ -2,6 +2,7 @@
title: 'Formats' title: 'Formats'
linkTitle: 'Formats' linkTitle: 'Formats'
weight: 31 weight: 31
description: 'List of annotation formats supported by CVAT.'
--- ---
#### CVAT supported the following formats: #### CVAT supported the following formats:

@ -2,6 +2,7 @@
title: 'OpenCV tools' title: 'OpenCV tools'
linkTitle: 'OpenCV tools' linkTitle: 'OpenCV tools'
weight: 14 weight: 14
description: 'Guide to using Computer Vision algorithms during annotation.'
--- ---
The tool based on [Open CV](https://opencv.org/) Computer Vision library The tool based on [Open CV](https://opencv.org/) Computer Vision library

@ -2,6 +2,7 @@
title: 'Projects' title: 'Projects'
linkTitle: 'Projects' linkTitle: 'Projects'
weight: 3 weight: 3
description: 'Creating projects in CVAT.'
--- ---
At CVAT, you can create a project containing tasks of the same type. At CVAT, you can create a project containing tasks of the same type.

@ -2,6 +2,7 @@
title: 'Review' title: 'Review'
linkTitle: 'Review' linkTitle: 'Review'
weight: 22 weight: 22
description: 'Guide to using the Review mode for task validation.'
--- ---
A special mode to check the annotation allows you to point to an object or area in the frame containing an error. A special mode to check the annotation allows you to point to an object or area in the frame containing an error.

@ -2,6 +2,7 @@
title: 'Search' title: 'Search'
linkTitle: 'Search' linkTitle: 'Search'
weight: 2 weight: 2
description: 'Overview of available search options.'
--- ---
There are several options how to use the search. There are several options how to use the search.

@ -2,6 +2,7 @@
title: 'Shape grouping' title: 'Shape grouping'
linkTitle: 'Shape grouping' linkTitle: 'Shape grouping'
weight: 21 weight: 21
description: 'Grouping multiple shapes during annotation.'
--- ---
This feature allows us to group several shapes. This feature allows us to group several shapes.

@ -2,6 +2,7 @@
title: 'Shape mode (advanced)' title: 'Shape mode (advanced)'
linkTitle: 'Shape mode' linkTitle: 'Shape mode'
weight: 4 weight: 4
description: 'Advanced operations available during annotation in shape mode.'
--- ---
Basic operations in the mode were described in section [shape mode (basics)](/docs/manual/basics/shape-mode-basics/). Basic operations in the mode were described in section [shape mode (basics)](/docs/manual/basics/shape-mode-basics/).

@ -2,6 +2,7 @@
title: 'Shortcuts' title: 'Shortcuts'
linkTitle: 'Shortcuts' linkTitle: 'Shortcuts'
weight: 24 weight: 24
description: 'List of available mouse and keyboard shortcuts.'
--- ---
Many UI elements have shortcut hints. Put your pointer to a required element to see it. Many UI elements have shortcut hints. Put your pointer to a required element to see it.

@ -2,6 +2,7 @@
title: 'Track mode (advanced)' title: 'Track mode (advanced)'
linkTitle: 'Track mode' linkTitle: 'Track mode'
weight: 5 weight: 5
description: 'Advanced operations available during annotation in track mode.'
--- ---
Basic operations in the mode were described in section [track mode (basics)](/docs/manual/basics/track-mode-basics/). Basic operations in the mode were described in section [track mode (basics)](/docs/manual/basics/track-mode-basics/).

@ -2,6 +2,7 @@
title: '3D Object annotation (basics)' title: '3D Object annotation (basics)'
linkTitle: '3D Object annotation' linkTitle: '3D Object annotation'
weight: 13 weight: 13
description: 'Overview of basic operations available when annotating 3D objects.'
--- ---
### Navigation ### Navigation

@ -2,6 +2,7 @@
title: 'Attribute annotation mode (basics)' title: 'Attribute annotation mode (basics)'
linkTitle: 'Attribute annotation mode' linkTitle: 'Attribute annotation mode'
weight: 12 weight: 12
description: 'Usage examples and basic operations available in attribute annotation mode.'
--- ---
- 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. Open the drop-down list in the top panel and select Attribute annotation Mode.

@ -2,6 +2,7 @@
title: 'Basic navigation' title: 'Basic navigation'
linkTitle: 'Basic navigation' linkTitle: 'Basic navigation'
weight: 6 weight: 6
description: 'Overview of basic controls.'
--- ---
1. Use arrows below to move to the next/previous frame. 1. Use arrows below to move to the next/previous frame.
Use the scroll bar slider to scroll through frames. Use the scroll bar slider to scroll through frames.

@ -2,6 +2,7 @@
title: 'Controls sidebar' title: 'Controls sidebar'
linkTitle: 'Controls sidebar' linkTitle: 'Controls sidebar'
weight: 23 weight: 23
description: 'Overview of available functions on the controls sidebar of the annotation tool.'
--- ---
## Navigation ## Navigation

@ -2,6 +2,7 @@
title: 'Creating an annotation task' title: 'Creating an annotation task'
linkTitle: 'Creating an annotation task' linkTitle: 'Creating an annotation task'
weight: 2 weight: 2
description: 'Instructions on how to create and configure an annotation task.'
--- ---
1. Create an annotation task pressing `Create new task` button on the tasks page or on the project page. 1. Create an annotation task pressing `Create new task` button on the tasks page or on the project page.

@ -2,6 +2,7 @@
title: 'Objects sidebar' title: 'Objects sidebar'
linkTitle: 'Objects sidebar' linkTitle: 'Objects sidebar'
weight: 24 weight: 24
description: 'Overview of available functions on the objects sidebar of the annotation tool.'
--- ---
## Hide objects sidebar ## Hide objects sidebar

@ -2,6 +2,7 @@
title: 'Shape mode (basics)' title: 'Shape mode (basics)'
linkTitle: 'Shape mode' linkTitle: 'Shape mode'
weight: 10 weight: 10
description: 'Usage examples and basic operations available during annotation in shape mode.'
--- ---
Usage examples: Usage examples:

@ -2,6 +2,7 @@
title: 'Task details' title: 'Task details'
linkTitle: 'Task details' linkTitle: 'Task details'
weight: 3 weight: 3
description: 'Overview of the Task details page.'
--- ---
Task details is a task page which contains a preview, a progress bar Task details is a task page which contains a preview, a progress bar

@ -2,6 +2,7 @@
title: 'Top Panel' title: 'Top Panel'
linkTitle: 'Top Panel' linkTitle: 'Top Panel'
weight: 21 weight: 21
description: 'Overview of controls available on the top panel of the annotation tool.'
--- ---
![](/images/image035.jpg) ![](/images/image035.jpg)

@ -2,6 +2,7 @@
title: 'Track mode (basics)' title: 'Track mode (basics)'
linkTitle: 'Track mode' linkTitle: 'Track mode'
weight: 11 weight: 11
description: 'Usage examples and basic operations available during annotation in track mode.'
--- ---
Usage examples: Usage examples:

@ -2,6 +2,7 @@
title: 'Types of shapes' title: 'Types of shapes'
linkTitle: 'Types of shapes' linkTitle: 'Types of shapes'
weight: 5 weight: 5
description: 'List of shapes available for annotation.'
--- ---
There are five shapes which you can annotate your images with: There are five shapes which you can annotate your images with:

@ -2,6 +2,7 @@
title: 'Vocabulary' title: 'Vocabulary'
linkTitle: 'Vocabulary' linkTitle: 'Vocabulary'
weight: 14 weight: 14
description: 'List of terms pertaining to annotation in CVAT.'
--- ---
**Label** is a type of an annotated object (e.g. person, car, vehicle, etc.) **Label** is a type of an annotated object (e.g. person, car, vehicle, etc.)

@ -2,6 +2,7 @@
title: 'Workspace' title: 'Workspace'
linkTitle: 'Workspace' linkTitle: 'Workspace'
weight: 22 weight: 22
description: 'Overview of available functions on the workspace of the annotation tool.'
--- ---
This is the main field in which drawing and editing objects takes place. This is the main field in which drawing and editing objects takes place.

Loading…
Cancel
Save