diff --git a/README.md b/README.md index c4cbb630..9e01d8c7 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,15 @@ annotation team. Try it online [cvat.org](https://cvat.org). ## Documentation -- [Contributing](https://openvinotoolkit.github.io/cvat/docs/for-developers/contributing/) -- [Installation guide](https://openvinotoolkit.github.io/cvat/docs/for-users/installation/) -- [User's guide](https://openvinotoolkit.github.io/cvat/docs/for-users/user-guide/) -- [Django REST API documentation](https://openvinotoolkit.github.io/cvat/docs/for-developers/rest_api_guide/) +- [Contributing](https://openvinotoolkit.github.io/cvat/docs/contributing/) +- [Installation guide](https://openvinotoolkit.github.io/cvat/docs/administration/basics/installation/) +- [Manual](https://openvinotoolkit.github.io/cvat/docs/manual/) +- [Django REST API documentation](https://openvinotoolkit.github.io/cvat/docs/administration/basics/rest_api_guide/) - [Datumaro dataset framework](https://github.com/openvinotoolkit/datumaro/blob/develop/README.md) -- [Command line interface](https://openvinotoolkit.github.io/cvat/docs/for-developers/cli/) -- [XML annotation format](https://openvinotoolkit.github.io/cvat/docs/for-developers/xml_format/) -- [AWS Deployment Guide](https://openvinotoolkit.github.io/cvat/docs/for-developers/aws-deployment-guide/) -- [Frequently asked questions](https://openvinotoolkit.github.io/cvat/docs/for-users/faq/) +- [Command line interface](https://openvinotoolkit.github.io/cvat/docs/manual/advanced/cli/) +- [XML annotation format](https://openvinotoolkit.github.io/cvat/docs/manual/advanced/xml_format/) +- [AWS Deployment Guide](https://openvinotoolkit.github.io/cvat/docs/administration/basics/aws-deployment-guide/) +- [Frequently asked questions](https://openvinotoolkit.github.io/cvat/docs/faq/) - [Questions](#questions) ## Screencasts @@ -48,28 +48,28 @@ dataset framework allows additional dataset transformations via its command line tool and Python library. For more information about supported formats look at the -[documentation](https://openvinotoolkit.github.io/cvat/docs/for-users/formats/). +[documentation](https://openvinotoolkit.github.io/cvat/docs/manual/advanced/formats/). -| Annotation format | Import | Export | -| ------------------------------------------------------------------------------------------------------- | ------ | ------ | -| [CVAT for images](https://openvinotoolkit.github.io/cvat/docs/for-developers/xml_format/#annotation) | X | X | -| [CVAT for a video](https://openvinotoolkit.github.io/cvat/docs/for-developers/xml_format/#interpolation) | X | X | -| [Datumaro](https://github.com/openvinotoolkit/datumaro) | | X | -| [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | -| Segmentation masks from [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | -| [YOLO](https://pjreddie.com/darknet/yolo/) | X | X | -| [MS COCO Object Detection](http://cocodataset.org/#format-data) | X | X | -| [TFrecord](https://www.tensorflow.org/tutorials/load_data/tfrecord) | X | X | -| [MOT](https://motchallenge.net/) | X | X | -| [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0) | X | X | -| [ImageNet](http://www.image-net.org) | X | X | -| [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/) | X | X | -| [WIDER Face](http://shuoyang1213.me/WIDERFACE/) | X | X | -| [VGGFace2](https://github.com/ox-vgg/vgg_face2) | X | X | -| [Market-1501](https://www.aitribune.com/dataset/2018051063) | X | X | -| [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2) | X | X | +| Annotation format | Import | Export | +| --------------------------------------------------------------------------------------------------------- | ------ | ------ | +| [CVAT for images](https://openvinotoolkit.github.io/cvat/docs/manual/advanced/xml_format/#annotation) | X | X | +| [CVAT for a video](https://openvinotoolkit.github.io/cvat/docs/manual/advanced/xml_format/#interpolation) | X | X | +| [Datumaro](https://github.com/openvinotoolkit/datumaro) | | X | +| [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | +| Segmentation masks from [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | +| [YOLO](https://pjreddie.com/darknet/yolo/) | X | X | +| [MS COCO Object Detection](http://cocodataset.org/#format-data) | X | X | +| [TFrecord](https://www.tensorflow.org/tutorials/load_data/tfrecord) | X | X | +| [MOT](https://motchallenge.net/) | X | X | +| [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0) | X | X | +| [ImageNet](http://www.image-net.org) | X | X | +| [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/) | X | X | +| [WIDER Face](http://shuoyang1213.me/WIDERFACE/) | X | X | +| [VGGFace2](https://github.com/ox-vgg/vgg_face2) | X | X | +| [Market-1501](https://www.aitribune.com/dataset/2018051063) | X | X | +| [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2) | X | X | @@ -102,7 +102,7 @@ are visible to users. Disabled features: -- [Analytics: management and monitoring of data annotation team](https://openvinotoolkit.github.io/cvat/docs/for-developers/analytics/) +- [Analytics: management and monitoring of data annotation team](https://openvinotoolkit.github.io/cvat/docs/administration/advanced/analytics/) Limitations: diff --git a/cvat-ui/README.md b/cvat-ui/README.md index c32879e6..349d6ff2 100644 --- a/cvat-ui/README.md +++ b/cvat-ui/README.md @@ -36,5 +36,5 @@ npm run build npm run build -- --mode=development # without a minification ``` -Important: You also have to run CVAT REST API server (please read `CONTRIBUTING.md`) +Important: You also have to run CVAT REST API server (please read `https://openvinotoolkit.github.io/cvat/docs/contributing/`) to correct working since UI gets all necessary data (tasks, users, annotations) from there diff --git a/cvat-ui/src/consts.ts b/cvat-ui/src/consts.ts index 65d408ed..e5df214c 100644 --- a/cvat-ui/src/consts.ts +++ b/cvat-ui/src/consts.ts @@ -11,11 +11,11 @@ const GITTER_PUBLIC_URL = 'https://gitter.im/opencv-cvat/public'; const FORUM_URL = 'https://software.intel.com/en-us/forums/intel-distribution-of-openvino-toolkit'; const GITHUB_URL = 'https://github.com/openvinotoolkit/cvat'; const GITHUB_IMAGE_URL = - 'https://raw.githubusercontent.com/openvinotoolkit/cvat/develop/cvat/apps/documentation/static/documentation/images/cvat.jpg'; + 'https://github.com/openvinotoolkit/cvat/raw/develop/site/content/en/images/cvat.jpg'; const SHARE_MOUNT_GUIDE_URL = - 'https://github.com/openvinotoolkit/cvat/blob/master/cvat/apps/documentation/installation.md#share-path'; + 'https://openvinotoolkit.github.io/cvat/docs/administration/basics/installation/#share-path'; const NUCLIO_GUIDE = - 'https://github.com/openvinotoolkit/cvat/blob/develop/cvat/apps/documentation/installation.md#semi-automatic-and-automatic-annotation'; + 'https://openvinotoolkit.github.io/cvat//docs/administration/advanced/installation_automatic_annotation/'; const CANVAS_BACKGROUND_COLORS = ['#ffffff', '#f1f1f1', '#e5e5e5', '#d8d8d8', '#CCCCCC', '#B3B3B3', '#999999']; const NEW_LABEL_COLOR = '#b3b3b3'; const LATEST_COMMENTS_SHOWN_QUICK_ISSUE = 3; diff --git a/site/content/en/docs/_index.md b/site/content/en/docs/_index.md index 26cd3822..12b8b6f4 100644 --- a/site/content/en/docs/_index.md +++ b/site/content/en/docs/_index.md @@ -1,6 +1,7 @@ --- title: 'Documentation' linkTitle: 'Documentation' +description: 'Welcome to the documentation of Computer Vision Annotation Tool.' no_list: true menu: main: @@ -12,48 +13,53 @@ It is being developed and used by Intel to annotate millions of objects with dif Many UI and UX decisions are based on feedbacks from professional data annotation team. Try it online [cvat.org](https://cvat.org). +Our documentation provides information for AI researchers, system administrators, developers, simple and advanced users. +The documentation is divided into three sections, and each section is divided into subsections `basic` and `advanced`. +
{{< blocks/section color="docs" >}} -{{% blocks/feature icon="fa-server" title="[Installation Guide](/docs/for-users/installation/)" %}} +{{% blocks/feature icon="fa-sign-in-alt" title="[Getting started](/docs/getting_started/)" %}} -CVAT installation guide for different operating systems. +Basic information and sections needed for a quick start. {{% /blocks/feature %}} -{{% blocks/feature icon="fa-book" title="[User's Guide](/docs/for-users/user-guide/)" %}} +{{% blocks/feature icon="fa-question" title="[FAQ](/docs/faq/)" %}} -This multipage document contains information on how to work with the CVAT user interface. +Answers to frequently asked questions. {{% /blocks/feature %}} -{{% blocks/feature icon="fa-question" title="[FAQ](/docs/for-users/faq/)" %}} +{{% blocks/feature icon="fab fa-github" title="[GitHub Repository](https://github.com/openvinotoolkit/cvat)" %}} -Answers to frequently asked questions. +Computer Vision Annotation Tool GitHub repository. {{% /blocks/feature %}} + -{{% blocks/feature icon="fa-magic" title="[Installation Auto Annotation](/docs/for-users/installation_automatic_annotation/)" %}} +{{% blocks/feature icon="fa-book" title="[Manual](/docs/manual/)" %}} -This page provides information about the installation of components needed for semi-automatic and automatic annotation. +This section contains documents for CVAT simple and advanced users. {{% /blocks/feature %}} -{{% blocks/feature icon="fa-terminal" title="[For Developers](/docs/for-developers/)" %}} +{{% blocks/feature icon="fa-server" title="[Administration](/docs/administration/)" %}} -This section contains documents for system administrators, AI researchers and any other advanced users. +This section contains documents for system administrators. {{% /blocks/feature %}} -{{% blocks/feature icon="fab fa-github" title="[GitHub Repository](https://github.com/openvinotoolkit/cvat)" %}} +{{% blocks/feature icon="fa-terminal" title="[Contributing](/docs/contributing/)" %}} -Computer Vision Annotation Tool GitHub repository. +This section contains documents for developers. {{% /blocks/feature %}} + {{< /blocks/section >}}
diff --git a/site/content/en/docs/administration/_index.md b/site/content/en/docs/administration/_index.md new file mode 100644 index 00000000..cb85ffa3 --- /dev/null +++ b/site/content/en/docs/administration/_index.md @@ -0,0 +1,9 @@ +--- + +title: 'Administration' +linkTitle: 'Administration' +weight: 3 +description: 'This section contains documents for system administrators' +hide_feedback: true + +--- diff --git a/site/content/en/docs/administration/advanced/_index.md b/site/content/en/docs/administration/advanced/_index.md new file mode 100644 index 00000000..162c9830 --- /dev/null +++ b/site/content/en/docs/administration/advanced/_index.md @@ -0,0 +1,9 @@ +--- + +title: 'Administration (advanced)' +linkTitle: 'Advanced' +weight: 2 +description: 'This section contains basic documents for system administrators' +hide_feedback: true + +--- diff --git a/site/content/en/docs/for-developers/analytics.md b/site/content/en/docs/administration/advanced/analytics.md similarity index 100% rename from site/content/en/docs/for-developers/analytics.md rename to site/content/en/docs/administration/advanced/analytics.md diff --git a/site/content/en/docs/for-developers/backup_guide.md b/site/content/en/docs/administration/advanced/backup_guide.md similarity index 92% rename from site/content/en/docs/for-developers/backup_guide.md rename to site/content/en/docs/administration/advanced/backup_guide.md index f12851ee..316f929f 100644 --- a/site/content/en/docs/for-developers/backup_guide.md +++ b/site/content/en/docs/administration/advanced/backup_guide.md @@ -16,13 +16,13 @@ Docker volumes are used to store all CVAT data: - `cvat_data`: used to store uploaded and prepared media data. Mounted into `cvat` container by `/home/django/data` path. -- `cvat_keys`: used to store user ssh keys needed for [synchronization with a remote Git repository](/docs/for-users/user-guide/task-synchronization/). +- `cvat_keys`: used to store user ssh keys needed for [synchronization with a remote Git repository](/docs/manual/advanced/task-synchronization/). Mounted into `cvat` container by `/home/django/keys` path. - `cvat_logs`: used to store logs of CVAT backend processes managed by supevisord. Mounted into `cvat` container by `/home/django/logs` path. -- `cvat_events`: this is an optional volume that is used only when [Analytics component](/docs/for-developers/analytics/) +- `cvat_events`: this is an optional volume that is used only when [Analytics component](/docs/administration/advanced/analytics/) is enabled and is used to store Elasticsearch database files. Mounted into `cvat_elasticsearch` container by `/usr/share/elasticsearch/data` path. @@ -56,7 +56,7 @@ cvat_data.tar.bz2 cvat_db.tar.bz2 cvat_events.tar.bz2 ## How to restore CVAT from backup -Note: CVAT containers must exist (if no, please follow the [installation guide](/docs/for-users/installation/#quick-installation-guide)). +Note: CVAT containers must exist (if no, please follow the [installation guide](/docs/administration/basics/installation/#quick-installation-guide)). Stop all CVAT containers: ```console diff --git a/site/content/en/docs/for-users/installation_automatic_annotation.md b/site/content/en/docs/administration/advanced/installation_automatic_annotation.md similarity index 100% rename from site/content/en/docs/for-users/installation_automatic_annotation.md rename to site/content/en/docs/administration/advanced/installation_automatic_annotation.md diff --git a/site/content/en/docs/for-developers/mounting_cloud_storages.md b/site/content/en/docs/administration/advanced/mounting_cloud_storages.md similarity index 100% rename from site/content/en/docs/for-developers/mounting_cloud_storages.md rename to site/content/en/docs/administration/advanced/mounting_cloud_storages.md diff --git a/site/content/en/docs/for-developers/AWS-Deployment-Guide.md b/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md similarity index 94% rename from site/content/en/docs/for-developers/AWS-Deployment-Guide.md rename to site/content/en/docs/administration/basics/AWS-Deployment-Guide.md index 1d5328da..ab52cea1 100644 --- a/site/content/en/docs/for-developers/AWS-Deployment-Guide.md +++ b/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md @@ -10,7 +10,7 @@ There are two ways of deploying the CVAT. One of the easy ways to launch CVAT with the tf-annotation app is to use AWS P3 instances, which provides the NVIDIA GPU. Read more about [P3 instances here.](https://aws.amazon.com/about-aws/whats-new/2017/10/introducing-amazon-ec2-p3-instances/) - Overall setup instruction is explained in [main readme file](https://github.com/opencv/cvat/), + Overall setup instruction is explained in [main readme file](https://github.com/openvinotoolkit/cvat/), except Installing Nvidia drivers. So we need to download the drivers and install it. For Amazon P3 instances, download the Nvidia Drivers from Nvidia website. @@ -18,7 +18,7 @@ There are two ways of deploying the CVAT. link. 2. **On Any other AWS Machine:** We can follow the same instruction guide mentioned in the - [installation instructions](/docs/for-users/installation/). + [installation instructions](/docs/administration/basics/installation/). The additional step is to add a [security group and rule to allow incoming connections](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html). For any of above, don't forget to add exposed AWS public IP address or hostname to `docker-compose.override.yml`: diff --git a/site/content/en/docs/for-developers/REST_API_guide.md b/site/content/en/docs/administration/basics/REST_API_guide.md similarity index 100% rename from site/content/en/docs/for-developers/REST_API_guide.md rename to site/content/en/docs/administration/basics/REST_API_guide.md diff --git a/site/content/en/docs/administration/basics/_index.md b/site/content/en/docs/administration/basics/_index.md new file mode 100644 index 00000000..fd9d5bde --- /dev/null +++ b/site/content/en/docs/administration/basics/_index.md @@ -0,0 +1,9 @@ +--- + +title: 'Administration (basics)' +linkTitle: 'Basics' +weight: 1 +description: 'This section contains basic documents for system administrators' +hide_feedback: true + +--- diff --git a/site/content/en/docs/for-users/installation.md b/site/content/en/docs/administration/basics/installation.md similarity index 98% rename from site/content/en/docs/for-users/installation.md rename to site/content/en/docs/administration/basics/installation.md index f46d6c2a..976625a9 100644 --- a/site/content/en/docs/for-users/installation.md +++ b/site/content/en/docs/administration/basics/installation.md @@ -115,7 +115,7 @@ server. Proxy is an advanced topic and it is not covered by the guide. - Open the installed Google Chrome browser and go to [localhost:8080](http://localhost:8080). Type your login/password for the superuser on the login page and press the _Login_ button. Now you should be able to create a new annotation task. Please read the - [CVAT user's guide](/docs/for-users/user-guide/) for more details. + [CVAT manual](/docs/manual/) for more details. ## Windows 10 @@ -178,7 +178,7 @@ server. Proxy is an advanced topic and it is not covered by the guide. - Open the installed Google Chrome browser and go to [localhost:8080](http://localhost:8080). Type your login/password for the superuser on the login page and press the _Login_ button. Now you should be able to create a new annotation task. Please read the - [CVAT user's guide](/docs/for-users/user-guide) for more details. + [CVAT manual](/docs/manual/) for more details. ## Mac OS Mojave @@ -245,7 +245,7 @@ server. Proxy is an advanced topic and it is not covered by the guide. - Open the installed Google Chrome browser and go to [localhost:8080](http://localhost:8080). Type your login/password for the superuser on the login page and press the _Login_ button. Now you should be able to create a new annotation task. Please read the - [CVAT user's guide](/docs/for-users/user-guide) for more details. + [CVAT manual](/docs/manual/) for more details. ## Advanced Topics @@ -274,7 +274,7 @@ Please see the [Docker documentation](https://docs.docker.com/network/proxy/) fo ### Additional components -- [Analytics: management and monitoring of data annotation team](/docs/for-developers/analytics/) +- [Analytics: management and monitoring of data annotation team](/docs/administration/advanced/analytics/) ```bash # Build and run containers with Analytics component support: @@ -284,7 +284,7 @@ docker-compose -f docker-compose.yml \ ### Semi-automatic and automatic annotation -Please follow this [guide](/docs/for-users/installation_automatic_annotation/). +Please follow this [guide](/docs/administration/advanced/installation_automatic_annotation/). ### Stop all containers @@ -342,7 +342,7 @@ You can change the share device path to your actual share. For user convenience we have defined the environment variable \$CVAT_SHARE_URL. This variable contains a text (url for example) which is shown in the client-share browser. -You can [mount](/docs/for-developers/mounting_cloud_storages/) +You can [mount](/docs/administration/advanced/mounting_cloud_storages/) your cloud storage as a FUSE and use it later as a share. ### Email verification diff --git a/site/content/en/docs/contributing/_index.md b/site/content/en/docs/contributing/_index.md new file mode 100644 index 00000000..31ee3ce8 --- /dev/null +++ b/site/content/en/docs/contributing/_index.md @@ -0,0 +1,16 @@ +--- +title: 'Contributing to this project' +linkTitle: 'Contributing' +weight: 4 +description: 'This section contains documents for CVAT developers' +hide_feedback: true +ul_show: false +--- + +Please take a moment to review this document in order to make the contribution +process easy and effective for everyone involved. + +Following these guidelines helps to communicate that you respect the time of +the developers managing and developing this open source project. In return, +they should reciprocate that respect in addressing your issue or assessing +patches and features. diff --git a/site/content/en/docs/contributing/branching-model.md b/site/content/en/docs/contributing/branching-model.md new file mode 100644 index 00000000..0c8c5994 --- /dev/null +++ b/site/content/en/docs/contributing/branching-model.md @@ -0,0 +1,15 @@ +--- +title: 'Branching model' +linkTitle: 'Branching model' +weight: 5 +--- + +The project uses [a successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model). +Thus it has a couple of branches. Some of them are described below: + +- `origin/master` to be the main branch where the source code of + HEAD always reflects a production-ready state + +- `origin/develop` to be the main branch where the source code of + HEAD always reflects a state with the latest delivered development + changes for the next release. Some would call this the “integration branch”. diff --git a/site/content/en/docs/contributing/bug-reports.md b/site/content/en/docs/contributing/bug-reports.md new file mode 100644 index 00000000..e66e5f36 --- /dev/null +++ b/site/content/en/docs/contributing/bug-reports.md @@ -0,0 +1,42 @@ +--- +title: 'Bug reports' +linkTitle: 'Bug reports' +weight: 7 +--- + +A bug is a _demonstrable problem_ that is caused by the code in the repository. +Good bug reports are extremely helpful - thank you! + +Guidelines for bug reports: + +1. **Use the GitHub issue search** — check if the issue has already been + reported. + +2. **Check if the issue has been fixed** — try to reproduce it using the + latest `develop` branch in the repository. + +3. **Isolate the problem** — ideally create a reduced test case. + +A good bug report shouldn't leave others needing to chase you up for more +information. Please try to be as detailed as possible in your report. What is +your environment? What steps will reproduce the issue? What browser(s) and OS +experience the problem? What would you expect to be the outcome? All these +details will help people to fix any potential bugs. + +Example: + +> Short and descriptive example bug report title +> +> A summary of the issue and the browser/OS environment in which it occurs. If +> suitable, include the steps required to reproduce the bug. +> +> 1. This is the first step +> 1. This is the second step +> 1. Further steps, etc. +> +> Any other information you want to share that is relevant to the issue being +> reported. This might include the lines of code that you have identified as +> causing the bug, and potential solutions (and your opinions on their +> merits). + + diff --git a/site/content/en/docs/contributing/coding-style.md b/site/content/en/docs/contributing/coding-style.md new file mode 100644 index 00000000..cb063f65 --- /dev/null +++ b/site/content/en/docs/contributing/coding-style.md @@ -0,0 +1,8 @@ +--- +title: 'JavaScript/Typescript coding style' +linkTitle: 'JavaScript/Typescript coding style' +weight: 4 +--- + +We use the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for JavaScript code with a +little exception - we prefer 4 spaces for indentation of nested blocks and statements. diff --git a/site/content/en/docs/contributing/development-environment.md b/site/content/en/docs/contributing/development-environment.md new file mode 100644 index 00000000..3fbe140c --- /dev/null +++ b/site/content/en/docs/contributing/development-environment.md @@ -0,0 +1,113 @@ +--- +title: 'Development environment' +linkTitle: 'Development environment' +weight: 2 +--- + +- Install necessary dependencies: + + Ubuntu 18.04 + + ```sh + sudo apt-get update && sudo apt-get --no-install-recommends install -y build-essential curl redis-server python3-dev python3-pip python3-venv python3-tk libldap2-dev libsasl2-dev pkg-config libavformat-dev libavcodec-dev libavdevice-dev libavutil-dev libswscale-dev libswresample-dev libavfilter-dev + ``` + + ```sh + # Node and npm (you can use default versions of these packages from apt (8.*, 3.*), but we would recommend to use newer versions) + curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - + sudo apt-get install -y nodejs + ``` + + MacOS 10.15 + + ```sh + brew install git python pyenv redis curl openssl node + ``` + +- Install FFmpeg libraries (libav\*) version 4.0 or higher. + +- Install [Visual Studio Code](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions) + for development + +- Install CVAT on your local host: + + ```sh + git clone https://github.com/openvinotoolkit/cvat + cd cvat && mkdir logs keys + python3 -m venv .env + . .env/bin/activate + pip install -U pip wheel setuptools + pip install -r cvat/requirements/development.txt + python manage.py migrate + python manage.py collectstatic + ``` + + > Note for Mac users + > + > If you have any problems with installing dependencies from + > `cvat/requirements/*.txt`, you may need to reinstall your system python + > In some cases after system update it can be configured incorrectly and cannot compile some native modules + +- Create a super user for CVAT: + + ```sh + $ python manage.py createsuperuser + Username (leave blank to use 'django'): *** + Email address: *** + Password: *** + Password (again): *** + ``` + +- Install npm packages for UI and start UI debug server (run the following command from CVAT root directory): + + ```sh + npm ci && \ + cd cvat-core && npm ci && \ + cd ../cvat-ui && npm ci && npm start + ``` + + > Note for Mac users + > + > If you faced with error + > + > `Node Sass does not yet support your current environment: OS X 64-bit with Unsupported runtime (57)` + > + > Read this article [Node Sass does not yet support your current environment](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) + +- Open new terminal (Ctrl + Shift + T), run Visual Studio Code from the virtual environment + + ```sh + cd .. && source .env/bin/activate && code + ``` + +- Install following VS Code extensions: + + - [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) + - [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) + - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + - [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) + - [vscode-remark-lint](https://marketplace.visualstudio.com/items?itemName=drewbourne.vscode-remark-lint) + - [licenser](https://marketplace.visualstudio.com/items?itemName=ymotongpoo.licenser) + - [Trailing Spaces](https://marketplace.visualstudio.com/items?itemName=shardulm94.trailing-spaces) + +- Reload Visual Studio Code from virtual environment + +- Select `server: debug` configuration and start it (F5) to run REST server and its workers + +You have done! Now it is possible to insert breakpoints and debug server and client of the tool. + +## Note for Windows users + +You develop CVAT under WSL (Windows subsystem for Linux) following next steps. + +- Install WSL using [this guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10). + +- Following this guide install Ubuntu 18.04 Linux distribution for WSL. + +- Run Ubuntu using start menu link or execute next command + + ```powershell + wsl -d Ubuntu-18.04 + ``` + +- Run all commands from this installation guide in WSL Ubuntu shell. diff --git a/site/content/en/docs/contributing/feature-requests.md b/site/content/en/docs/contributing/feature-requests.md new file mode 100644 index 00000000..11715c75 --- /dev/null +++ b/site/content/en/docs/contributing/feature-requests.md @@ -0,0 +1,12 @@ +--- +title: 'Feature requests' +linkTitle: 'Feature requests' +weight: 8 +--- + +Feature requests are welcome. But take a moment to find out whether your idea +fits with the scope and aims of the project. It's up to _you_ to make a strong +case to convince the project's developers of the merits of this feature. Please +provide as much detail and context as possible. + + diff --git a/site/content/en/docs/for-users/formats/_index.md b/site/content/en/docs/contributing/new-annotation-format.md similarity index 78% rename from site/content/en/docs/for-users/formats/_index.md rename to site/content/en/docs/contributing/new-annotation-format.md index 126cdcc5..0cf21485 100644 --- a/site/content/en/docs/for-users/formats/_index.md +++ b/site/content/en/docs/contributing/new-annotation-format.md @@ -1,17 +1,13 @@ --- -title: 'Dataset and annotation formats' -linkTitle: 'Formats' -weight: 6 +title: 'How to add a new annotation format support' +linkTitle: 'New annotation format support' +weight: 10 description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats) --- - - -## How to add a new annotation format support - 1. Add a python script to `dataset_manager/formats` -1. Add an import statement to [registry.py](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats/registry.py). -1. Implement some importers and exporters as the format requires. +2. Add an import statement to [registry.py](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats/registry.py). +3. Implement some importers and exporters as the format requires. Each format is supported by an importer and exporter. @@ -146,18 +142,18 @@ task_data.add_shape(shape) ## Format specifications -- [CVAT](format-cvat) -- [Datumaro](format-datumaro) -- [LabelMe](format-labelme) -- [MOT](format-mot) -- [MOTS](format-mots) -- [COCO](format-coco) -- [PASCAL VOC and mask](format-voc) -- [YOLO](format-yolo) -- [TF detection API](format-tfrecord) -- [ImageNet](format-imagenet) -- [CamVid](format-camvid) -- [WIDER Face](format-widerface) -- [VGGFace2](format-vggface2) -- [Market-1501](format-market1501) -- [ICDAR13/15](format-icdar) +- [CVAT](/docs/manual/advanced/formats/format-cvat/) +- [Datumaro](/docs/manual/advanced/formats/format-datumaro/) +- [LabelMe](/docs/manual/advanced/formats/format-labelme/) +- [MOT](/docs/manual/advanced/formats/format-mot/) +- [MOTS](/docs/manual/advanced/formats/format-mots/) +- [COCO](/docs/manual/advanced/formats/format-coco/) +- [PASCAL VOC and mask](/docs/manual/advanced/formats/format-voc/) +- [YOLO](/docs/manual/advanced/formats/format-yolo/) +- [TF detection API](/docs/manual/advanced/formats/format-tfrecord/) +- [ImageNet](/docs/manual/advanced/formats/format-imagenet/) +- [CamVid](/docs/manual/advanced/formats/format-camvid/) +- [WIDER Face](/docs/manual/advanced/formats/format-widerface/) +- [VGGFace2](/docs/manual/advanced/formats/format-vggface2/) +- [Market-1501](/docs/manual/advanced/formats/format-market1501/) +- [ICDAR13/15](/docs/manual/advanced/formats/format-icdar/) diff --git a/site/content/en/docs/contributing/pull-requests.md b/site/content/en/docs/contributing/pull-requests.md new file mode 100644 index 00000000..1d71b31f --- /dev/null +++ b/site/content/en/docs/contributing/pull-requests.md @@ -0,0 +1,70 @@ +--- +title: 'Pull requests' +linkTitle: 'Pull requests' +weight: 9 +--- + +Good pull requests - patches, improvements, new features - are a fantastic +help. They should remain focused in scope and avoid containing unrelated +commits. + +**Please ask first** before embarking on any significant pull request (e.g. +implementing features, refactoring code, porting to a different language), +otherwise you risk spending a lot of time working on something that the +project's developers might not want to merge into the project. + +Please adhere to the coding conventions used throughout a project (indentation, +accurate comments, etc.) and any other requirements (such as test coverage). + +Follow this process if you'd like your work considered for inclusion in the +project: + +1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the project, clone your fork, + and configure the remotes: + + ```bash + # Clone your fork of the repo into the current directory + git clone https://github.com// + # Navigate to the newly cloned directory + cd + # Assign the original repo to a remote called "upstream" + git remote add upstream https://github.com// + ``` + +1. If you cloned a while ago, get the latest changes from upstream: + + ```bash + git checkout + git pull upstream + ``` + +1. Create a new topic branch (off the main project development branch) to + contain your feature, change, or fix: + + ```bash + git checkout -b + ``` + +1. Commit your changes in logical chunks. Please adhere to these [git commit + message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) + or your code is unlikely be merged into the main project. Use Git's + [interactive rebase](https://docs.github.com/en/github/using-git/about-git-rebase) + feature to tidy up your commits before making them public. + +1. Locally merge (or rebase) the upstream development branch into your topic branch: + + ```bash + git pull [--rebase] upstream + ``` + +1. Push your topic branch up to your fork: + + ```bash + git push origin + ``` + +1. [Open a Pull Request](hhttps://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) + with a clear title and description. + +**IMPORTANT**: By submitting a patch, you agree to allow the project owner to +license your work under the same license as that used by the project. diff --git a/site/content/en/docs/for-developers/CONTRIBUTING.md b/site/content/en/docs/contributing/setup-additional-components.md similarity index 56% rename from site/content/en/docs/for-developers/CONTRIBUTING.md rename to site/content/en/docs/contributing/setup-additional-components.md index 4e42421b..6c5ef57d 100644 --- a/site/content/en/docs/for-developers/CONTRIBUTING.md +++ b/site/content/en/docs/contributing/setup-additional-components.md @@ -1,132 +1,12 @@ --- -title: "Contributing to this project" -linkTitle: "Contributing" -weight: 1 +title: 'Setup additional components in development environment' +linkTitle: 'Setup additional components in development environment' +weight: 3 --- -Please take a moment to review this document in order to make the contribution -process easy and effective for everyone involved. +## DL models as serverless functions -Following these guidelines helps to communicate that you respect the time of -the developers managing and developing this open source project. In return, -they should reciprocate that respect in addressing your issue or assessing -patches and features. - -## Development environment - -- Install necessary dependencies: - - Ubuntu 18.04 - - ```sh - sudo apt-get update && sudo apt-get --no-install-recommends install -y build-essential curl redis-server python3-dev python3-pip python3-venv python3-tk libldap2-dev libsasl2-dev pkg-config libavformat-dev libavcodec-dev libavdevice-dev libavutil-dev libswscale-dev libswresample-dev libavfilter-dev - ``` - - ```sh - # Node and npm (you can use default versions of these packages from apt (8.*, 3.*), but we would recommend to use newer versions) - curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - - sudo apt-get install -y nodejs - ``` - - MacOS 10.15 - - ```sh - brew install git python pyenv redis curl openssl node - ``` - -- Install FFmpeg libraries (libav\*) version 4.0 or higher. - -- Install [Visual Studio Code](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions) - for development - -- Install CVAT on your local host: - - ```sh - git clone https://github.com/openvinotoolkit/cvat - cd cvat && mkdir logs keys - python3 -m venv .env - . .env/bin/activate - pip install -U pip wheel setuptools - pip install -r cvat/requirements/development.txt - python manage.py migrate - python manage.py collectstatic - ``` - - > Note for Mac users - > - > If you have any problems with installing dependencies from - > `cvat/requirements/*.txt`, you may need to reinstall your system python - > In some cases after system update it can be configured incorrectly and cannot compile some native modules - -- Create a super user for CVAT: - - ```sh - $ python manage.py createsuperuser - Username (leave blank to use 'django'): *** - Email address: *** - Password: *** - Password (again): *** - ``` - -- Install npm packages for UI and start UI debug server (run the following command from CVAT root directory): - - ```sh - npm ci && \ - cd cvat-core && npm ci && \ - cd ../cvat-ui && npm ci && npm start - ``` - - > Note for Mac users - > - > If you faced with error - > - > `Node Sass does not yet support your current environment: OS X 64-bit with Unsupported runtime (57)` - > - > Read this article [Node Sass does not yet support your current environment](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) - -- Open new terminal (Ctrl + Shift + T), run Visual Studio Code from the virtual environment - - ```sh - cd .. && source .env/bin/activate && code - ``` - -- Install following VS Code extensions: - - - [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) - - [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - - [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - - [vscode-remark-lint](https://marketplace.visualstudio.com/items?itemName=drewbourne.vscode-remark-lint) - - [licenser](https://marketplace.visualstudio.com/items?itemName=ymotongpoo.licenser) - - [Trailing Spaces](https://marketplace.visualstudio.com/items?itemName=shardulm94.trailing-spaces) - -- Reload Visual Studio Code from virtual environment - -- Select `server: debug` configuration and start it (F5) to run REST server and its workers - -You have done! Now it is possible to insert breakpoints and debug server and client of the tool. - -### Note for Windows users - -You develop CVAT under WSL (Windows subsystem for Linux) following next steps. - -- Install WSL using [this guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10). - -- Following this guide install Ubuntu 18.04 Linux distribution for WSL. - -- Run Ubuntu using start menu link or execute next command - - ```powershell - wsl -d Ubuntu-18.04 - ``` - -- Run all commands from this installation guide in WSL Ubuntu shell. - -## Setup additional components in development environment - -### DL models as serverless functions - -Follow this [guide](/docs/for-users/installation_automatic_annotation/) to install Nuclio: +Follow this [guide](/docs/administration/advanced/installation_automatic_annotation/) to install Nuclio: - You have to install `nuctl` command line tool to build and deploy serverless functions. @@ -258,7 +138,7 @@ Server = nuclio -### Run Cypress tests +## Run Cypress tests - Install Сypress as described in the [documentation](https://docs.cypress.io/guides/getting-started/installing-cypress.html). - Run cypress tests: ```sh @@ -266,149 +146,3 @@ Server = nuclio /node_modules/.bin/cypress run --headless --browser chrome ``` For more information, see the [documentation](https://docs.cypress.io/). - -## JavaScript/Typescript coding style - -We use the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for JavaScript code with a -little exception - we prefer 4 spaces for indentation of nested blocks and statements. - -## Branching model - -The project uses [a successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model). -Thus it has a couple of branches. Some of them are described below: - -- `origin/master` to be the main branch where the source code of - HEAD always reflects a production-ready state - -- `origin/develop` to be the main branch where the source code of - HEAD always reflects a state with the latest delivered development - changes for the next release. Some would call this the “integration branch”. - -## Using the issue tracker - -The issue tracker is the preferred channel for [bug reports](#bugs), -[features requests](#features) and [submitting pull -requests](#pull-requests), but please respect the following restrictions: - -- Please **do not** use the issue tracker for personal support requests (use - [Stack Overflow](http://stackoverflow.com)). - -- Please **do not** derail or troll issues. Keep the discussion on topic and - respect the opinions of others. - - - -## Bug reports - -A bug is a _demonstrable problem_ that is caused by the code in the repository. -Good bug reports are extremely helpful - thank you! - -Guidelines for bug reports: - -1. **Use the GitHub issue search** — check if the issue has already been - reported. - -1. **Check if the issue has been fixed** — try to reproduce it using the - latest `develop` branch in the repository. - -1. **Isolate the problem** — ideally create a reduced test case. - -A good bug report shouldn't leave others needing to chase you up for more -information. Please try to be as detailed as possible in your report. What is -your environment? What steps will reproduce the issue? What browser(s) and OS -experience the problem? What would you expect to be the outcome? All these -details will help people to fix any potential bugs. - -Example: - -> Short and descriptive example bug report title -> -> A summary of the issue and the browser/OS environment in which it occurs. If -> suitable, include the steps required to reproduce the bug. -> -> 1. This is the first step -> 1. This is the second step -> 1. Further steps, etc. -> -> Any other information you want to share that is relevant to the issue being -> reported. This might include the lines of code that you have identified as -> causing the bug, and potential solutions (and your opinions on their -> merits). - - - -## Feature requests - -Feature requests are welcome. But take a moment to find out whether your idea -fits with the scope and aims of the project. It's up to _you_ to make a strong -case to convince the project's developers of the merits of this feature. Please -provide as much detail and context as possible. - - - -## Pull requests - -Good pull requests - patches, improvements, new features - are a fantastic -help. They should remain focused in scope and avoid containing unrelated -commits. - -**Please ask first** before embarking on any significant pull request (e.g. -implementing features, refactoring code, porting to a different language), -otherwise you risk spending a lot of time working on something that the -project's developers might not want to merge into the project. - -Please adhere to the coding conventions used throughout a project (indentation, -accurate comments, etc.) and any other requirements (such as test coverage). - -Follow this process if you'd like your work considered for inclusion in the -project: - -1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the project, clone your fork, - and configure the remotes: - - ```bash - # Clone your fork of the repo into the current directory - git clone https://github.com// - # Navigate to the newly cloned directory - cd - # Assign the original repo to a remote called "upstream" - git remote add upstream https://github.com// - ``` - -1. If you cloned a while ago, get the latest changes from upstream: - - ```bash - git checkout - git pull upstream - ``` - -1. Create a new topic branch (off the main project development branch) to - contain your feature, change, or fix: - - ```bash - git checkout -b - ``` - -1. Commit your changes in logical chunks. Please adhere to these [git commit - message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) - or your code is unlikely be merged into the main project. Use Git's - [interactive rebase](https://docs.github.com/en/github/using-git/about-git-rebase) - feature to tidy up your commits before making them public. - -1. Locally merge (or rebase) the upstream development branch into your topic branch: - - ```bash - git pull [--rebase] upstream - ``` - -1. Push your topic branch up to your fork: - - ```bash - git push origin - ``` - -1. [Open a Pull Request](hhttps://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) - with a clear title and description. - -**IMPORTANT**: By submitting a patch, you agree to allow the project owner to -license your work under the same license as that used by the project. diff --git a/site/content/en/docs/contributing/using-the-issue-tracker.md b/site/content/en/docs/contributing/using-the-issue-tracker.md new file mode 100644 index 00000000..bcb619a2 --- /dev/null +++ b/site/content/en/docs/contributing/using-the-issue-tracker.md @@ -0,0 +1,17 @@ +--- +title: 'Using the issue tracker' +linkTitle: 'Using the issue tracker' +weight: 6 +--- + +The issue tracker is the preferred channel for [bug reports](#bugs), +[features requests](#features) and [submitting pull +requests](#pull-requests), but please respect the following restrictions: + +- Please **do not** use the issue tracker for personal support requests (use + [Stack Overflow](http://stackoverflow.com)). + +- Please **do not** derail or troll issues. Keep the discussion on topic and + respect the opinions of others. + + diff --git a/site/content/en/docs/for-users/faq.md b/site/content/en/docs/faq.md similarity index 89% rename from site/content/en/docs/for-users/faq.md rename to site/content/en/docs/faq.md index e37802f3..169f9053 100644 --- a/site/content/en/docs/for-users/faq.md +++ b/site/content/en/docs/faq.md @@ -9,7 +9,7 @@ description: 'Answers to frequently asked questions' ## How to update CVAT -Before updating, please follow the [backup guide](/docs/for-developers/backup_guide/) +Before updating, please follow the [backup guide](/docs/administration/advanced/backup_guide/) and backup all CVAT volumes. To update CVAT, you should clone or download the new version of CVAT and rebuild the CVAT docker images as usual. @@ -112,14 +112,14 @@ volumes: ## How to mark job/task as completed -The status is set by the user in the [Info window](/docs/for-users/user-guide/top-panel/#info) +The status is set by the user in the [Info window](/docs/manual/basics/top-panel/#info) of the job annotation view. There are three types of status: annotation, validation or completed. The status of the job changes the progress bar of the task. ## How to install CVAT on Windows 10 Home -Follow this [guide](/docs/for-users/installation/#windows-10). +Follow this [guide](/docs/administration/basics/installation/#windows-10). ## I do not have the Analytics tab on the header section. How can I add analytics @@ -142,9 +142,9 @@ services: ## How to create a task with multiple jobs Set the segment size when you create a new task, this option is available in the -[Advanced configuration](/docs/for-users/user-guide/creating_an_annotation_task/#advanced-configuration) +[Advanced configuration](/docs/manual/basics/creating_an_annotation_task/#advanced-configuration) section. ## How to transfer CVAT to another machine -Follow the [backup/restore guide](/docs/for-developers/backup_guide/#how-to-backup-all-cvat-data). +Follow the [backup/restore guide](/docs/administration/advanced/backup_guide/#how-to-backup-all-cvat-data). diff --git a/site/content/en/docs/for-developers/_index.md b/site/content/en/docs/for-developers/_index.md deleted file mode 100644 index ece3aede..00000000 --- a/site/content/en/docs/for-developers/_index.md +++ /dev/null @@ -1,11 +0,0 @@ - - ---- - -title: 'For Developers' -linkTitle: 'For Developers' -weight: 3 -description: 'This section contains documents for system administrators, AI researchers and any other advanced users.' -hide_feedback: true - ---- diff --git a/site/content/en/docs/for-users/_index.md b/site/content/en/docs/for-users/_index.md deleted file mode 100644 index 859ea0e1..00000000 --- a/site/content/en/docs/for-users/_index.md +++ /dev/null @@ -1,11 +0,0 @@ - - ---- - -title: 'For Users' -linkTitle: 'For Users' -weight: 2 -description: 'This section contains documents for CVAT users' -hide_feedback: true - ---- diff --git a/site/content/en/docs/for-users/user-guide/_index.md b/site/content/en/docs/for-users/user-guide/_index.md deleted file mode 100644 index a0583013..00000000 --- a/site/content/en/docs/for-users/user-guide/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "User's guide" -linkTitle: "User's guide" -weight: 1 -description: "This multipage document contains information on how to work with the CVAT user interface" ---- -Computer Vision Annotation Tool (CVAT) is a web-based tool which helps to -annotate videos and images for Computer Vision algorithms. It was inspired -by [Vatic](http://carlvondrick.com/vatic/) free, online, interactive video -annotation tool. CVAT has many powerful features: _interpolation of bounding -boxes between key frames, automatic annotation using deep learning models, -shortcuts for most of critical actions, dashboard with a list of annotation -tasks, LDAP and basic authorization, etc..._ It was created for and used by -a professional data annotation team. UX and UI were optimized especially for -computer vision tasks developed by our team. diff --git a/site/content/en/docs/for-users/user-guide/advanced/_index.md b/site/content/en/docs/for-users/user-guide/advanced/_index.md deleted file mode 100644 index e4d4e110..00000000 --- a/site/content/en/docs/for-users/user-guide/advanced/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Advanced" -linkTitle: "Advanced" -weight: 30 ---- diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-points/_index.md b/site/content/en/docs/for-users/user-guide/advanced/annotation-with-points/_index.md deleted file mode 100644 index bb8e9e3f..00000000 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-points/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Annotation with points" -linkTitle: "Annotation with points" -weight: 10 ---- diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/_index.md b/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/_index.md deleted file mode 100644 index 6d59abd0..00000000 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Annotation with polygons" -linkTitle: "Annotation with polygons" -weight: 8 ---- diff --git a/site/content/en/docs/for-users/user-guide/basics/_index.md b/site/content/en/docs/for-users/user-guide/basics/_index.md deleted file mode 100644 index 93d3098c..00000000 --- a/site/content/en/docs/for-users/user-guide/basics/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Basics" -linkTitle: "Basics" -weight: 8 ---- diff --git a/site/content/en/docs/getting_started.md b/site/content/en/docs/getting_started.md new file mode 100644 index 00000000..787a4f7b --- /dev/null +++ b/site/content/en/docs/getting_started.md @@ -0,0 +1,60 @@ +--- +title: "Getting started" +linkTitle: "Getting started" +weight: 1 +--- + +This section contains basic information and links to sections necessary for a quick start. + +## Installation + +First step is to install CVAT on your system. Use the [Installation Guide](/docs/administration/basics/installation/). + +## Getting started in CVAT + +To find out more, go to the [authorization](/docs/manual/basics/authorization/) section. + +To create a task, go to `Tasks` section. Click `Create new task` to go to the task creation page. + +Set the name of the future task. + +Set the label using the constructor: first click "add label", then enter the name of the label and choose the color. + +![](/images/create_a_new_task.gif) + +You need to upload images or videos for your future annotation. To do so, simply drag and drop the files. + +To learn more, go to [creating an annotation task](/docs/manual/basics/creating_an_annotation_task/) + +## Basic annotation + +When the task is created, you will see a corresponding message in the top right corner. +Click the "Open task" button to go to the task page. + +Once on the task page, open a link to the job in the jobs list. + +Choose a correct section for your type of the task and start annotation. + +| Shape | Annotation | Interpolation | +| --------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| Rectangle | [Shape mode (basics)](/docs/manual/basics/shape-mode-basics/) | [Track mode (basics)](/docs/manual/basics/track-mode-basics/) | +| Polygon | [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/) | [Track mode with polygons](/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons/) | +| Polyline | [Annotation with polylines](/docs/manual/advanced/annotation-with-polylines/) | | +| Points | [Points in shape mode](/docs/manual/advanced/annotation-with-points/points-in-shape-mode/) | [Liner interpolation with one point](/docs/manual/advanced/annotation-with-points/liner-interpolation-with-one-point/) | +| Cuboids | [Annotation with cuboids](/docs/manual/advanced/annotation-with-cuboids/) | [Editing the cuboid](/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid/) | +| Tag | [Annotation with tags](/docs/manual/advanced/annotation-with-tags/) | | + +## Dump annotation + +![](/images/image028.jpg) + +1. To download the annotations, first you have to save all changes. + Click the Save button or press `Ctrl+S`to save annotations quickly. + +2. After you saved the changes, click the Menu button. + +3. Then click the Dump Annotation button. + +4. Lastly choose a format of the dump annotation file. + +To learn more, go to [downloading annotations](/docs/manual/advanced/downloading-annotations/) diff --git a/site/content/en/docs/manual/_index.md b/site/content/en/docs/manual/_index.md new file mode 100644 index 00000000..611d71ab --- /dev/null +++ b/site/content/en/docs/manual/_index.md @@ -0,0 +1,9 @@ +--- + +title: 'Manual' +linkTitle: 'Manual' +weight: 2 +description: 'This section contains documents for CVAT simple and advanced users' +hide_feedback: true + +--- diff --git a/site/content/en/docs/manual/advanced/_index.md b/site/content/en/docs/manual/advanced/_index.md new file mode 100644 index 00000000..42c8c55a --- /dev/null +++ b/site/content/en/docs/manual/advanced/_index.md @@ -0,0 +1,8 @@ +--- +title: "Advanced" +linkTitle: "Advanced" +weight: 2 +description: 'This section contains advanced documents for CVAT users' +hide_feedback: true + +--- diff --git a/site/content/en/docs/for-users/user-guide/advanced/ai-tools.md b/site/content/en/docs/manual/advanced/ai-tools.md similarity index 86% rename from site/content/en/docs/for-users/user-guide/advanced/ai-tools.md rename to site/content/en/docs/manual/advanced/ai-tools.md index 3f57c695..933ae7ac 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/ai-tools.md +++ b/site/content/en/docs/manual/advanced/ai-tools.md @@ -1,12 +1,12 @@ --- -title: "AI Tools" -linkTitle: "AI Tools" -weight: 5 +title: 'AI Tools' +linkTitle: 'AI Tools' +weight: 15 --- The tool is designed for semi-automatic and automatic annotation using DL models. The tool is available only if there is a corresponding model. -For more details about DL models read the [Models](/docs/for-users/user-guide/models/) section. +For more details about DL models read the [Models](/docs/manual/advanced/models/) section. ### Interactors @@ -36,7 +36,7 @@ In most cases specifying positive points alone is enough to build a polygon. - To finish interaction, click on the icon on the controls sidebar or press `N` on your keyboard. - When the object is finished, you can edit it like a polygon. - You can read about editing polygons in the [Annotation with polygons](/docs/for-users/user-guide/advanced/annotation-with-polygons/) section. + You can read about editing polygons in the [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/) section. ### Detectors @@ -49,5 +49,5 @@ Detectors are used to automatically annotate one frame. Supported DL models are ![](/images/image187.jpg) - This action will automatically annotates one frame. - In the [Automatic annotation](/docs/for-users/user-guide/advanced/automatic-annotation/) section you can read + In the [Automatic annotation](/docs/manual/advanced/automatic-annotation/) section you can read how to make automatic annotation of all frames. diff --git a/site/content/en/docs/for-users/user-guide/advanced/analytics.md b/site/content/en/docs/manual/advanced/analytics.md similarity index 90% rename from site/content/en/docs/for-users/user-guide/advanced/analytics.md rename to site/content/en/docs/manual/advanced/analytics.md index f6d8c0f2..410ad9fd 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/analytics.md +++ b/site/content/en/docs/manual/advanced/analytics.md @@ -1,7 +1,7 @@ --- -title: "Analytics" -linkTitle: "Analytics" -weight: 1 +title: 'Analytics' +linkTitle: 'Analytics' +weight: 28 --- If your CVAT instance was created with analytics support, you can press the `Analytics` button in the dashboard diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/_index.md b/site/content/en/docs/manual/advanced/annotation-with-cuboids/_index.md similarity index 72% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/_index.md rename to site/content/en/docs/manual/advanced/annotation-with-cuboids/_index.md index 0a627eba..3070bb78 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/_index.md +++ b/site/content/en/docs/manual/advanced/annotation-with-cuboids/_index.md @@ -1,7 +1,7 @@ --- -title: "Annotation with cuboids" -linkTitle: "Annotation with cuboids" -weight: 11 +title: 'Annotation with cuboids' +linkTitle: 'Annotation with cuboids' +weight: 17 --- It is used to annotate 3 dimensional objects such as cars, boxes, etc... diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/creating-the-cuboid.md b/site/content/en/docs/manual/advanced/annotation-with-cuboids/creating-the-cuboid.md similarity index 100% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/creating-the-cuboid.md rename to site/content/en/docs/manual/advanced/annotation-with-cuboids/creating-the-cuboid.md diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/editing-the-cuboid.md b/site/content/en/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid.md similarity index 83% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/editing-the-cuboid.md rename to site/content/en/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid.md index 74d495cc..b1ebb099 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-cuboids/editing-the-cuboid.md +++ b/site/content/en/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid.md @@ -1,6 +1,6 @@ --- -title: "Editing the cuboid" -linkTitle: "Editing the cuboid" +title: 'Editing the cuboid' +linkTitle: 'Editing the cuboid' weight: 2 --- @@ -38,4 +38,4 @@ Simply drag the faces to move them independently from the rest of the cuboid. ![](/images/gif020_mapillary_vistas.gif) -You can also use cuboids in track mode, similar to rectangles in track mode ([basics](/docs/for-users/user-guide/basics/track-mode-basics/) and [advanced](/docs/for-users/user-guide/advanced/track-mode-advanced/)) or [Track mode with polygons](/docs/for-users/user-guide/advanced/annotation-with-polygons/track-mode-with-polygons/) +You can also use cuboids in track mode, similar to rectangles in track mode ([basics](/docs/manual/basics/track-mode-basics/) and [advanced](/docs/manual/advanced/track-mode-advanced/)) or [Track mode with polygons](/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons/) diff --git a/site/content/en/docs/manual/advanced/annotation-with-points/_index.md b/site/content/en/docs/manual/advanced/annotation-with-points/_index.md new file mode 100644 index 00000000..6a5f13e0 --- /dev/null +++ b/site/content/en/docs/manual/advanced/annotation-with-points/_index.md @@ -0,0 +1,5 @@ +--- +title: 'Annotation with points' +linkTitle: 'Annotation with points' +weight: 11 +--- diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-points/liner-interpolation-with-one-point.md b/site/content/en/docs/manual/advanced/annotation-with-points/liner-interpolation-with-one-point.md similarity index 100% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-points/liner-interpolation-with-one-point.md rename to site/content/en/docs/manual/advanced/annotation-with-points/liner-interpolation-with-one-point.md diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-points/points-in-shape-mode.md b/site/content/en/docs/manual/advanced/annotation-with-points/points-in-shape-mode.md similarity index 100% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-points/points-in-shape-mode.md rename to site/content/en/docs/manual/advanced/annotation-with-points/points-in-shape-mode.md diff --git a/site/content/en/docs/manual/advanced/annotation-with-polygons/_index.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/_index.md new file mode 100644 index 00000000..659eb77b --- /dev/null +++ b/site/content/en/docs/manual/advanced/annotation-with-polygons/_index.md @@ -0,0 +1,5 @@ +--- +title: 'Annotation with polygons' +linkTitle: 'Annotation with polygons' +weight: 13 +--- diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/automatic-borders.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/automatic-borders.md similarity index 100% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/automatic-borders.md rename to site/content/en/docs/manual/advanced/annotation-with-polygons/automatic-borders.md diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/creating-mask.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md similarity index 88% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/creating-mask.md rename to site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md index dce82333..c48b17f4 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/creating-mask.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md @@ -1,6 +1,6 @@ --- -title: "Creating masks" -linkTitle: "Creating masks" +title: 'Creating masks' +linkTitle: 'Creating masks' weight: 6 --- @@ -32,8 +32,8 @@ There are several formats in CVAT that can be used to export masks: - `CamVid` - `MOTS` - `ICDAR` -- `COCO` (RLE-encoded instance masks, [guide](/docs/for-users/formats/format-specifications/format-coco)) -- `TFRecord` ([over Datumaro](https://github.com/openvinotoolkit/datumaro/blob/develop/docs/user_manual.md), [guide](/docs/for-users/formats/format-specifications/format-tfrecord)): +- `COCO` (RLE-encoded instance masks, [guide](/docs/manual/advanced/formats/format-coco)) +- `TFRecord` ([over Datumaro](https://github.com/openvinotoolkit/datumaro/blob/develop/docs/user_manual.md), [guide](/docs/manual/advanced/formats/format-tfrecord)): - `Datumaro` An example of exported masks (in the `Segmentation Mask` format): diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/edit-polygon.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/edit-polygon.md similarity index 100% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/edit-polygon.md rename to site/content/en/docs/manual/advanced/annotation-with-polygons/edit-polygon.md diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/manual-drawing.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/manual-drawing.md similarity index 100% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/manual-drawing.md rename to site/content/en/docs/manual/advanced/annotation-with-polygons/manual-drawing.md diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/track-mode-with-polygons.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons.md similarity index 81% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/track-mode-with-polygons.md rename to site/content/en/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons.md index abb523de..c914268c 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polygons/track-mode-with-polygons.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons.md @@ -1,17 +1,17 @@ --- -title: "Track mode with polygons" -linkTitle: "Track mode with polygons" +title: 'Track mode with polygons' +linkTitle: 'Track mode with polygons' weight: 5 --- Polygons in the track mode allow you to mark moving objects more accurately other than using a rectangle -([Tracking mode (basic)](/docs/for-users/user-guide/basics/track-mode-basics/); [Tracking mode (advanced)](/docs/for-users/user-guide/advanced/track-mode-advanced/)). +([Tracking mode (basic)](/docs/manual/basics/track-mode-basics/); [Tracking mode (advanced)](/docs/manual/advanced/track-mode-advanced/)). 1. To create a polygon in the track mode, click the `Track` button. ![](/images/image184.jpg) -1. Create a polygon the same way as in the case of [Annotation with polygons](/docs/for-users/user-guide/advanced/annotation-with-polygons/). +1. Create a polygon the same way as in the case of [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/). Press `N` to complete the polygon. 1. Pay attention to the fact that the created polygon has a starting point and a direction, diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polylines.md b/site/content/en/docs/manual/advanced/annotation-with-polylines.md similarity index 92% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-polylines.md rename to site/content/en/docs/manual/advanced/annotation-with-polylines.md index 3424f999..08eef047 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-polylines.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polylines.md @@ -1,7 +1,7 @@ --- -title: "Annotation with polylines" -linkTitle: "Annotation with polylines" -weight: 9 +title: 'Annotation with polylines' +linkTitle: 'Annotation with polylines' +weight: 12 --- It is used for road markup annotation etc. diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-rectangle-by-4-points.md b/site/content/en/docs/manual/advanced/annotation-with-rectangle-by-4-points.md similarity index 83% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-rectangle-by-4-points.md rename to site/content/en/docs/manual/advanced/annotation-with-rectangle-by-4-points.md index 8216f6d4..a506408f 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-rectangle-by-4-points.md +++ b/site/content/en/docs/manual/advanced/annotation-with-rectangle-by-4-points.md @@ -1,7 +1,7 @@ --- -title: "Annotation with rectangle by 4 points" -linkTitle: "Annotation with rectangle by 4 points" -weight: 7 +title: 'Annotation with rectangle by 4 points' +linkTitle: 'Annotation with rectangle by 4 points' +weight: 10 --- It is an efficient method of bounding box annotation, proposed diff --git a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-tags.md b/site/content/en/docs/manual/advanced/annotation-with-tags.md similarity index 89% rename from site/content/en/docs/for-users/user-guide/advanced/annotation-with-tags.md rename to site/content/en/docs/manual/advanced/annotation-with-tags.md index 4e358b39..1b6a3930 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/annotation-with-tags.md +++ b/site/content/en/docs/manual/advanced/annotation-with-tags.md @@ -1,7 +1,7 @@ --- -title: "Annotation with Tags" -linkTitle: "Annotation with Tags" -weight: 12 +title: 'Annotation with Tags' +linkTitle: 'Annotation with Tags' +weight: 16 --- It is used to annotate frames, tags are not displayed in the workspace. diff --git a/site/content/en/docs/for-users/user-guide/advanced/attribute-annotation-mode-advanced.md b/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md similarity index 80% rename from site/content/en/docs/for-users/user-guide/advanced/attribute-annotation-mode-advanced.md rename to site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md index 20efda8d..f294003c 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/attribute-annotation-mode-advanced.md +++ b/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md @@ -1,10 +1,10 @@ --- -title: "Attribute annotation mode (advanced)" -linkTitle: "Attribute annotation mode" -weight: 3 +title: 'Attribute annotation mode (advanced)' +linkTitle: 'Attribute annotation mode' +weight: 6 --- -Basic operations in the mode were described in section [attribute annotation mode (basics)](/docs/for-users/user-guide/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/). It is possible to handle lots of objects on the same frame in the mode. diff --git a/site/content/en/docs/for-users/user-guide/advanced/automatic-annotation.md b/site/content/en/docs/manual/advanced/automatic-annotation.md similarity index 97% rename from site/content/en/docs/for-users/user-guide/advanced/automatic-annotation.md rename to site/content/en/docs/manual/advanced/automatic-annotation.md index 0e28b83c..e9702b5d 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/automatic-annotation.md +++ b/site/content/en/docs/manual/advanced/automatic-annotation.md @@ -1,7 +1,7 @@ --- -title: "Automatic annotation" -linkTitle: "Automatic annotation" -weight: 14 +title: 'Automatic annotation' +linkTitle: 'Automatic annotation' +weight: 27 --- Automatic Annotation is used for creating preliminary annotations. diff --git a/site/content/en/docs/for-developers/cli.md b/site/content/en/docs/manual/advanced/cli.md similarity index 96% rename from site/content/en/docs/for-developers/cli.md rename to site/content/en/docs/manual/advanced/cli.md index df786cc3..2738cfce 100644 --- a/site/content/en/docs/for-developers/cli.md +++ b/site/content/en/docs/manual/advanced/cli.md @@ -1,7 +1,7 @@ --- -title: "Command line interface (CLI)" -linkTitle: "CLI" -weight: 3 +title: 'Command line interface (CLI)' +linkTitle: 'CLI' +weight: 32 description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/utils/cli) --- diff --git a/site/content/en/docs/for-users/user-guide/advanced/context-images.md b/site/content/en/docs/manual/advanced/context-images.md similarity index 75% rename from site/content/en/docs/for-users/user-guide/advanced/context-images.md rename to site/content/en/docs/manual/advanced/context-images.md index 2e7f63ca..933ddddf 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/context-images.md +++ b/site/content/en/docs/manual/advanced/context-images.md @@ -1,7 +1,7 @@ --- -title: "Context images for 2d task" -linkTitle: "Context images" -weight: 12.5 +title: 'Context images for 2d task' +linkTitle: 'Context images' +weight: 23 --- When you create a task, you can provide the images with additional contextual images. @@ -22,16 +22,16 @@ An example of the structure: - related_images/ - image_3_to_be_annotated_jpg/ - context_image_for_image_3.jpg - + The contextual image is displayed in the upper right corner of the workspace. You can hide it by clicking on the corresponding button or maximize the image by clicking on it. -![contex_images_1](https://user-images.githubusercontent.com/54434686/119321037-e21a2000-bc84-11eb-8352-ca5ad349780a.jpg) +![contex_images_1](/images/image212_mapillary_vistas.jpg) -When the image is maximized, you can rotate it clockwise/counterclockwise and zoom in/out. +When the image is maximized, you can rotate it clockwise/counterclockwise and zoom in/out. You can also move the image by moving the mouse while holding down the LMB and zoom in/out by scrolling the mouse wheel. To close the image, just click the `X`. -![contex_images_2](https://user-images.githubusercontent.com/54434686/119327072-4344f200-bc8b-11eb-80ba-86ec4f9e436e.jpg) +![contex_images_2](/images/image213_mapillary_vistas.jpg) diff --git a/site/content/en/docs/for-developers/data_on_fly.md b/site/content/en/docs/manual/advanced/data_on_fly.md similarity index 93% rename from site/content/en/docs/for-developers/data_on_fly.md rename to site/content/en/docs/manual/advanced/data_on_fly.md index 5d02ecbd..f18deb30 100644 --- a/site/content/en/docs/for-developers/data_on_fly.md +++ b/site/content/en/docs/manual/advanced/data_on_fly.md @@ -1,7 +1,7 @@ --- title: 'Data preparation on the fly' linkTitle: 'Data preparation on the fly' -weight: 9 +weight: 34 --- @@ -29,4 +29,4 @@ during task creation, which may take some time. #### Uploading a manifest with data When creating a task, you can upload a `manifest.jsonl` file along with the video or dataset with images. -You can see how to prepare it [here](/docs/for-developers/dataset_manifest/). +You can see how to prepare it [here](/docs/manual/advanced/dataset_manifest/). diff --git a/site/content/en/docs/for-developers/dataset_manifest.md b/site/content/en/docs/manual/advanced/dataset_manifest.md similarity index 99% rename from site/content/en/docs/for-developers/dataset_manifest.md rename to site/content/en/docs/manual/advanced/dataset_manifest.md index 5b4e4e5b..58d448f3 100644 --- a/site/content/en/docs/for-developers/dataset_manifest.md +++ b/site/content/en/docs/manual/advanced/dataset_manifest.md @@ -4,7 +4,7 @@ title: 'Simple command line to prepare dataset manifest file' linkTitle: 'Dataset manifest' -weight: 10 +weight: 33 description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/utils/dataset_manifest) --- diff --git a/site/content/en/docs/for-users/user-guide/downloading-annotations.md b/site/content/en/docs/manual/advanced/downloading-annotations.md similarity index 84% rename from site/content/en/docs/for-users/user-guide/downloading-annotations.md rename to site/content/en/docs/manual/advanced/downloading-annotations.md index ecb43601..c121652e 100644 --- a/site/content/en/docs/for-users/user-guide/downloading-annotations.md +++ b/site/content/en/docs/manual/advanced/downloading-annotations.md @@ -1,7 +1,7 @@ --- -title: "Downloading annotations" -linkTitle: "Downloading annotations" -weight: 9 +title: 'Downloading annotations' +linkTitle: 'Downloading annotations' +weight: 1 --- 1. To download the latest annotations, you have to save all changes first. @@ -13,9 +13,9 @@ weight: 9 1. Choose format dump annotation file. Dump annotation are available in several formats: - - [CVAT for video](/docs/for-developers/xml_format/#interpolation) + - [CVAT for video](/docs/manual/advanced/xml_format/#interpolation) is highlighted if a task has the interpolation mode. - - [CVAT for images](/docs/for-developers/xml_format/#annotation) + - [CVAT for images](/docs/manual/advanced/xml_format/#annotation) is highlighted if a task has the annotation mode. ![](/images/image029.jpg 'Example XML format') diff --git a/site/content/en/docs/for-users/user-guide/advanced/filter.md b/site/content/en/docs/manual/advanced/filter.md similarity index 96% rename from site/content/en/docs/for-users/user-guide/advanced/filter.md rename to site/content/en/docs/manual/advanced/filter.md index 8b68c6fc..c1a235e7 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/filter.md +++ b/site/content/en/docs/manual/advanced/filter.md @@ -1,7 +1,7 @@ --- -title: "Filter" -linkTitle: "Filter" -weight: 16 +title: 'Filter' +linkTitle: 'Filter' +weight: 20 --- There are some reasons to use the feature: @@ -34,7 +34,7 @@ The "Add rule" button adds a rule for objects display. A rule may use the follow | `Label` | all the label names that are in the task | label name | | `Type` | shape, track or tag | type of object | | `Shape` | all shape types | type of shape | -| `Occluded` | true or false | occluded ([read more](/docs/for-users/user-guide/advanced/shape-mode-advanced/)) | +| `Occluded` | true or false | occluded ([read more](/docs/manual/advanced/shape-mode-advanced/)) | | `Width` | number of px or field | shape width | | `Height` | number of px or field | shape height | | `ServerID` | number or field | ID of the object on the server
(You can find out by forming a link to the object through the Action menu) | diff --git a/site/content/en/docs/manual/advanced/formats/_index.md b/site/content/en/docs/manual/advanced/formats/_index.md new file mode 100644 index 00000000..332a711d --- /dev/null +++ b/site/content/en/docs/manual/advanced/formats/_index.md @@ -0,0 +1,23 @@ +--- +title: 'Formats' +linkTitle: 'Formats' +weight: 31 +--- + +#### CVAT supported the following formats: + +- [CVAT](format-cvat) +- [Datumaro](format-datumaro) +- [LabelMe](format-labelme) +- [MOT](format-mot) +- [MOTS](format-mots) +- [COCO](format-coco) +- [PASCAL VOC and mask](format-voc) +- [YOLO](format-yolo) +- [TF detection API](format-tfrecord) +- [ImageNet](format-imagenet) +- [CamVid](format-camvid) +- [WIDER Face](format-widerface) +- [VGGFace2](format-vggface2) +- [Market-1501](format-market1501) +- [ICDAR13/15](format-icdar) diff --git a/site/content/en/docs/for-users/formats/format-camvid.md b/site/content/en/docs/manual/advanced/formats/format-camvid.md similarity index 83% rename from site/content/en/docs/for-users/formats/format-camvid.md rename to site/content/en/docs/manual/advanced/formats/format-camvid.md index ce5d7b37..1f5c81c2 100644 --- a/site/content/en/docs/for-users/formats/format-camvid.md +++ b/site/content/en/docs/manual/advanced/formats/format-camvid.md @@ -1,11 +1,11 @@ --- -linkTitle: "CamVid" +linkTitle: 'CamVid' weight: 10 --- -### [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/) +# [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/) -#### CamVid export +## CamVid export Downloaded file: a zip archive of the following structure: @@ -35,7 +35,7 @@ has own color which corresponds to a label. - supported annotations: Rectangles, Polygons -#### CamVid import +## CamVid import Uploaded file: a zip archive of the structure above diff --git a/site/content/en/docs/for-users/formats/format-coco.md b/site/content/en/docs/manual/advanced/formats/format-coco.md similarity index 89% rename from site/content/en/docs/for-users/formats/format-coco.md rename to site/content/en/docs/manual/advanced/formats/format-coco.md index 622a719d..61b74004 100644 --- a/site/content/en/docs/for-users/formats/format-coco.md +++ b/site/content/en/docs/manual/advanced/formats/format-coco.md @@ -3,11 +3,11 @@ linkTitle: 'MS COCO' weight: 5 --- -### [MS COCO Object Detection](http://cocodataset.org/#format-data) +# [MS COCO Object Detection](http://cocodataset.org/#format-data) - [Format specification](https://github.com/openvinotoolkit/datumaro/blob/develop/docs/formats/coco_user_manual.md#format-specification) -#### COCO export +## COCO export Downloaded file: a zip archive with the structure described [here](https://github.com/openvinotoolkit/datumaro/blob/develop/docs/formats/coco_user_manual.md#load-coco-dataset) @@ -33,7 +33,7 @@ For example, [support for COCO keypoints over Datumaro](https://github.com/openv This way, one can export CVAT points as single keypoints or keypoint lists (without the `visibility` COCO flag). -#### COCO import +## COCO import Uploaded file: a single unpacked `*.json` or a zip archive with the structure described [here](https://github.com/openvinotoolkit/datumaro/blob/develop/docs/formats/coco_user_manual.md#load-coco-dataset) @@ -41,7 +41,7 @@ Uploaded file: a single unpacked `*.json` or a zip archive with the structure de - supported annotations: Polygons, Rectangles (if the `segmentation` field is empty) -#### How to create a task from MS COCO dataset +## How to create a task from MS COCO dataset 1. Download the [MS COCO dataset](https://github.com/openvinotoolkit/datumaro/blob/develop/docs/formats/coco_user_manual.md#load-COCO-dataset). @@ -54,11 +54,11 @@ Uploaded file: a single unpacked `*.json` or a zip archive with the structure de ``` 1. Select `val2017.zip` as data - (See [Creating an annotation task](/docs/for-users/user-guide/creating_an_annotation_task/) + (See [Creating an annotation task](/docs/manual/basics/creating_an_annotation_task/) guide for details) -1. Unpack `annotations_trainval2017.zip` +2. Unpack `annotations_trainval2017.zip` -1. click `Upload annotation` button, +3. click `Upload annotation` button, choose `COCO 1.1` and select `instances_val2017.json` annotation file. It can take some time. diff --git a/site/content/en/docs/for-users/formats/format-cvat.md b/site/content/en/docs/manual/advanced/formats/format-cvat.md similarity index 85% rename from site/content/en/docs/for-users/formats/format-cvat.md rename to site/content/en/docs/manual/advanced/formats/format-cvat.md index 5339e1c8..0d9ab7da 100644 --- a/site/content/en/docs/for-users/formats/format-cvat.md +++ b/site/content/en/docs/manual/advanced/formats/format-cvat.md @@ -3,7 +3,7 @@ linkTitle: "CVAT" weight: 1 --- -### CVAT +# CVAT This is the native CVAT annotation format. It supports all CVAT annotations features, so it can be used to make data backups. @@ -16,9 +16,9 @@ features, so it can be used to make data backups. - attributes are supported -- [Format specification](/docs/for-developers/xml_format/) +- [Format specification](/docs/manual/advanced/xml_format/) -#### CVAT for images export +## CVAT for images export Downloaded file: a ZIP file of the following structure: @@ -32,7 +32,7 @@ taskname.zip/ - tracks are split by frames -#### CVAT for videos export +## CVAT for videos export Downloaded file: a ZIP file of the following structure: @@ -46,6 +46,6 @@ taskname.zip/ - shapes are exported as single-frame tracks -#### CVAT loader +## CVAT loader Uploaded file: an XML file or a ZIP file of the structures above diff --git a/site/content/en/docs/for-users/formats/format-datumaro.md b/site/content/en/docs/manual/advanced/formats/format-datumaro.md similarity index 88% rename from site/content/en/docs/for-users/formats/format-datumaro.md rename to site/content/en/docs/manual/advanced/formats/format-datumaro.md index 5a846d62..2cb63ef1 100644 --- a/site/content/en/docs/for-users/formats/format-datumaro.md +++ b/site/content/en/docs/manual/advanced/formats/format-datumaro.md @@ -1,9 +1,9 @@ --- -linkTitle: "Datumaro" +linkTitle: 'Datumaro' weight: 1.5 --- -### Datumaro format +# Datumaro format [Datumaro](https://github.com/openvinotoolkit/datumaro/) is a tool, which can help with complex dataset and annotation transformations, format conversions, diff --git a/site/content/en/docs/for-users/formats/format-icdar.md b/site/content/en/docs/manual/advanced/formats/format-icdar.md similarity index 92% rename from site/content/en/docs/for-users/formats/format-icdar.md rename to site/content/en/docs/manual/advanced/formats/format-icdar.md index a40d5147..43d187d7 100644 --- a/site/content/en/docs/for-users/formats/format-icdar.md +++ b/site/content/en/docs/manual/advanced/formats/format-icdar.md @@ -1,11 +1,11 @@ --- -linkTitle: "ICDAR13/15" +linkTitle: 'ICDAR13/15' weight: 14 --- -### [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2) +# [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2) -#### ICDAR13/15 export +## ICDAR13/15 export Downloaded file: a zip archive of the following structure: @@ -54,7 +54,7 @@ taskname.zip/ - supported annotations: Rectangles and Polygons with label `icdar` and attributes `index`, `text`, `color`, `center` -#### ICDAR13/15 import +## ICDAR13/15 import Uploaded file: a zip archive of the structure above diff --git a/site/content/en/docs/for-users/formats/format-imagenet.md b/site/content/en/docs/manual/advanced/formats/format-imagenet.md similarity index 81% rename from site/content/en/docs/for-users/formats/format-imagenet.md rename to site/content/en/docs/manual/advanced/formats/format-imagenet.md index c73c35ce..4f6ac12b 100644 --- a/site/content/en/docs/for-users/formats/format-imagenet.md +++ b/site/content/en/docs/manual/advanced/formats/format-imagenet.md @@ -1,11 +1,11 @@ --- -linkTitle: "ImageNet" +linkTitle: 'ImageNet' weight: 9 --- -### [ImageNet](http://www.image-net.org) +# [ImageNet](http://www.image-net.org) -#### ImageNet export +## ImageNet export Downloaded file: a zip archive of the following structure: @@ -29,7 +29,7 @@ taskname.zip/ - supported annotations: Labels -#### ImageNet import +## ImageNet import Uploaded file: a zip archive of the structure above diff --git a/site/content/en/docs/for-users/formats/format-labelme.md b/site/content/en/docs/manual/advanced/formats/format-labelme.md similarity index 78% rename from site/content/en/docs/for-users/formats/format-labelme.md rename to site/content/en/docs/manual/advanced/formats/format-labelme.md index 47c7e3f8..b4262f25 100644 --- a/site/content/en/docs/for-users/formats/format-labelme.md +++ b/site/content/en/docs/manual/advanced/formats/format-labelme.md @@ -1,11 +1,11 @@ --- -linkTitle: "LabelMe" +linkTitle: 'LabelMe' weight: 2 --- -### [LabelMe](http://labelme.csail.mit.edu/Release3.0) +# [LabelMe](http://labelme.csail.mit.edu/Release3.0) -#### LabelMe export +## LabelMe export Downloaded file: a zip archive of the following structure: @@ -17,7 +17,7 @@ taskname.zip/ - supported annotations: Rectangles, Polygons (with attributes) -#### LabelMe import +## LabelMe import Uploaded file: a zip archive of the following structure: diff --git a/site/content/en/docs/for-users/formats/format-market1501.md b/site/content/en/docs/manual/advanced/formats/format-market1501.md similarity index 85% rename from site/content/en/docs/for-users/formats/format-market1501.md rename to site/content/en/docs/manual/advanced/formats/format-market1501.md index 027ffd42..42a03d67 100644 --- a/site/content/en/docs/for-users/formats/format-market1501.md +++ b/site/content/en/docs/manual/advanced/formats/format-market1501.md @@ -1,11 +1,11 @@ --- -linkTitle: "Market-1501" +linkTitle: 'Market-1501' weight: 13 --- -### [Market-1501](https://www.aitribune.com/dataset/2018051063) +# [Market-1501](https://www.aitribune.com/dataset/2018051063) -#### Market-1501 export +## Market-1501 export Downloaded file: a zip archive of the following structure: @@ -33,7 +33,7 @@ s1 - sequence - supported annotations: Label `market-1501` with attributes (`query`, `person_id`, `camera_id`) -#### Market-1501 import +## Market-1501 import Uploaded file: a zip archive of the structure above diff --git a/site/content/en/docs/for-users/formats/format-mot.md b/site/content/en/docs/manual/advanced/formats/format-mot.md similarity index 85% rename from site/content/en/docs/for-users/formats/format-mot.md rename to site/content/en/docs/manual/advanced/formats/format-mot.md index 211e3eaf..1e6ce417 100644 --- a/site/content/en/docs/for-users/formats/format-mot.md +++ b/site/content/en/docs/manual/advanced/formats/format-mot.md @@ -1,11 +1,11 @@ --- -linkTitle: "MOT" +linkTitle: 'MOT' weight: 3 --- -### [MOT sequence](https://arxiv.org/pdf/1906.04567.pdf) +# [MOT sequence](https://arxiv.org/pdf/1906.04567.pdf) -#### MOT export +## MOT export Downloaded file: a zip archive of the following structure: @@ -34,7 +34,7 @@ person - supported annotations: Rectangle shapes and tracks - supported attributes: `visibility` (number), `ignored` (checkbox) -#### MOT import +## MOT import Uploaded file: a zip archive of the structure above or: diff --git a/site/content/en/docs/for-users/formats/format-mots.md b/site/content/en/docs/manual/advanced/formats/format-mots.md similarity index 78% rename from site/content/en/docs/for-users/formats/format-mots.md rename to site/content/en/docs/manual/advanced/formats/format-mots.md index caa4ac66..df0a6996 100644 --- a/site/content/en/docs/for-users/formats/format-mots.md +++ b/site/content/en/docs/manual/advanced/formats/format-mots.md @@ -1,11 +1,11 @@ --- -linkTitle: "MOTS" +linkTitle: 'MOTS' weight: 4 --- -### [MOTS PNG](https://www.vision.rwth-aachen.de/page/mots) +# [MOTS PNG](https://www.vision.rwth-aachen.de/page/mots) -#### MOTS PNG export +## MOTS PNG export Downloaded file: a zip archive of the following structure: @@ -29,7 +29,7 @@ person - supported annotations: Rectangle and Polygon tracks -#### MOTS PNG import +## MOTS PNG import Uploaded file: a zip archive of the structure above diff --git a/site/content/en/docs/for-users/formats/format-tfrecord.md b/site/content/en/docs/manual/advanced/formats/format-tfrecord.md similarity index 92% rename from site/content/en/docs/for-users/formats/format-tfrecord.md rename to site/content/en/docs/manual/advanced/formats/format-tfrecord.md index ed95511e..cb260218 100644 --- a/site/content/en/docs/for-users/formats/format-tfrecord.md +++ b/site/content/en/docs/manual/advanced/formats/format-tfrecord.md @@ -1,9 +1,9 @@ --- -linkTitle: "TFRecord" +linkTitle: 'TFRecord' weight: 8 --- -### [TFRecord](https://www.tensorflow.org/tutorials/load_data/tfrecord) +# [TFRecord](https://www.tensorflow.org/tutorials/load_data/tfrecord) TFRecord is a very flexible format, but we try to correspond the format that used in @@ -28,7 +28,7 @@ image_feature_description = { } ``` -#### TFRecord export +## TFRecord export Downloaded file: a zip archive with following structure: @@ -63,7 +63,7 @@ How to export masks: datum export -f tf_detection_api -p btm [-- --save-images] ``` -#### TFRecord import +## TFRecord import Uploaded file: a zip archive of following structure: @@ -74,7 +74,7 @@ taskname.zip/ - supported annotations: Rectangles -#### How to create a task from TFRecord dataset (from VOC2007 for example) +## How to create a task from TFRecord dataset (from VOC2007 for example) 1. Create `label_map.pbtxt` file with the following content: @@ -183,7 +183,7 @@ python create_pascal_tf_record.py --data_dir --set train --y ``` Select images. zip as data. - See [Creating an annotation task](/docs/for-users/user-guide/creating_an_annotation_task/) + See [Creating an annotation task](/docs/manual/basics/creating_an_annotation_task/) guide for details. 1. Zip `pascal.tfrecord` and `label_map.pbtxt` files together diff --git a/site/content/en/docs/for-users/formats/format-vggface2.md b/site/content/en/docs/manual/advanced/formats/format-vggface2.md similarity index 82% rename from site/content/en/docs/for-users/formats/format-vggface2.md rename to site/content/en/docs/manual/advanced/formats/format-vggface2.md index 500b47bd..d9c8665d 100644 --- a/site/content/en/docs/for-users/formats/format-vggface2.md +++ b/site/content/en/docs/manual/advanced/formats/format-vggface2.md @@ -1,11 +1,11 @@ --- -linkTitle: "VGGFace2" +linkTitle: 'VGGFace2' weight: 12 --- -### [VGGFace2](https://github.com/ox-vgg/vgg_face2) +# [VGGFace2](https://github.com/ox-vgg/vgg_face2) -#### VGGFace2 export +## VGGFace2 export Downloaded file: a zip archive of the following structure: @@ -28,7 +28,7 @@ label1 - supported annotations: Rectangles, Points (landmarks - groups of 5 points) -#### VGGFace2 import +## VGGFace2 import Uploaded file: a zip archive of the structure above diff --git a/site/content/en/docs/for-users/formats/format-voc.md b/site/content/en/docs/manual/advanced/formats/format-voc.md similarity index 90% rename from site/content/en/docs/for-users/formats/format-voc.md rename to site/content/en/docs/manual/advanced/formats/format-voc.md index e1ea96cb..f735d390 100644 --- a/site/content/en/docs/for-users/formats/format-voc.md +++ b/site/content/en/docs/manual/advanced/formats/format-voc.md @@ -1,9 +1,9 @@ --- -linkTitle: "Pascal VOC" +linkTitle: 'Pascal VOC' weight: 6 --- -### [Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/) +# [Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/) - [Format specification](http://host.robots.ox.ac.uk/pascal/VOC/voc2012/devkit_doc.pdf) @@ -20,7 +20,7 @@ weight: 6 - action attributes (import only, should be defined as `checkbox` -es) - arbitrary attributes (in the `attributes` section of XML files) -#### Pascal VOC export +## Pascal VOC export Downloaded file: a zip archive of the following structure: @@ -47,7 +47,7 @@ bicycle::: bird::: ``` -#### Pascal VOC import +## Pascal VOC import Uploaded file: a zip archive of the structure declared above or the following: @@ -70,7 +70,7 @@ There are 2 options: 1. match by frame number. File name should be `.jpg` or `frame_000000.jpg`. It should be used when task was created from video. -#### Segmentation mask export +## Segmentation mask export Downloaded file: a zip archive of the following structure: @@ -105,7 +105,7 @@ Colors are generated following to Pascal VOC [algorithm](http://host.robots.ox.a - supported shapes: Rectangles, Polygons -#### Segmentation mask import +## Segmentation mask import Uploaded file: a zip archive of the following structure: @@ -146,7 +146,7 @@ the last label:12,28,0:: # color index 200 - supported shapes: Polygons -#### How to create a task from Pascal VOC dataset +## How to create a task from Pascal VOC dataset 1. Download the Pascal Voc dataset (Can be downloaded from the [PASCAL VOC website](http://host.robots.ox.ac.uk/pascal/VOC/)) @@ -162,11 +162,11 @@ the last label:12,28,0:: # color index 200 attributes for each label if you want to use them. Select interesting image files - (See [Creating an annotation task](/docs/for-users/user-guide/creating_an_annotation_task/) guide for details) + (See [Creating an annotation task](/docs/manual/basics/creating_an_annotation_task/) guide for details) -1. zip the corresponding annotation files +2. zip the corresponding annotation files -1. click `Upload annotation` button, choose `Pascal VOC ZIP 1.1` +3. click `Upload annotation` button, choose `Pascal VOC ZIP 1.1` and select the zip file with annotations from previous step. It may take some time. diff --git a/site/content/en/docs/for-users/formats/format-widerface.md b/site/content/en/docs/manual/advanced/formats/format-widerface.md similarity index 85% rename from site/content/en/docs/for-users/formats/format-widerface.md rename to site/content/en/docs/manual/advanced/formats/format-widerface.md index 0f76382e..e5c5dd33 100644 --- a/site/content/en/docs/for-users/formats/format-widerface.md +++ b/site/content/en/docs/manual/advanced/formats/format-widerface.md @@ -1,11 +1,11 @@ --- -linkTitle: "Wider Face" +linkTitle: 'Wider Face' weight: 9 --- -### [WIDER Face](http://shuoyang1213.me/WIDERFACE/) +# [WIDER Face](http://shuoyang1213.me/WIDERFACE/) -#### WIDER Face export +## WIDER Face export Downloaded file: a zip archive of the following structure: @@ -27,7 +27,7 @@ taskname.zip/ - `blur`, `expression`, `illumination`, `pose`, `invalid` - `occluded` (both the annotation property & an attribute) -#### WIDER Face import +## WIDER Face import Uploaded file: a zip archive of the structure above diff --git a/site/content/en/docs/for-users/formats/format-yolo.md b/site/content/en/docs/manual/advanced/formats/format-yolo.md similarity index 91% rename from site/content/en/docs/for-users/formats/format-yolo.md rename to site/content/en/docs/manual/advanced/formats/format-yolo.md index 4a58f2cb..edc773f3 100644 --- a/site/content/en/docs/for-users/formats/format-yolo.md +++ b/site/content/en/docs/manual/advanced/formats/format-yolo.md @@ -1,14 +1,14 @@ --- -linkTitle: "YOLO" +linkTitle: 'YOLO' weight: 7 --- -### [YOLO](https://pjreddie.com/darknet/yolo/) +# [YOLO](https://pjreddie.com/darknet/yolo/) - [Format specification](https://github.com/AlexeyAB/darknet#how-to-train-to-detect-your-custom-objects) - supported annotations: Rectangles -#### YOLO export +## YOLO export Downloaded file: a zip archive with following structure: @@ -54,7 +54,7 @@ The `*.txt` file structure: each line describes label and bounding box in the following format `label_id cx cy w h`. `obj.names` contains the ordered list of label names. -#### YOLO import +## YOLO import Uploaded file: a zip archive of the same structure as above It must be possible to match the CVAT frame (image name) @@ -67,7 +67,7 @@ and annotation file name. There are 2 options: should be in the following format `.jpg` . It should be used when task was created from a video. -#### How to create a task from YOLO formatted dataset (from VOC for example) +## How to create a task from YOLO formatted dataset (from VOC for example) 1. Follow the official [guide](https://pjreddie.com/darknet/yolo/)(see Training YOLO on VOC section) and prepare the YOLO formatted annotation files. @@ -87,7 +87,7 @@ zip images.zip -j -@ < train.txt Select images. zip as data. Most likely you should use `share` functionality because size of images. zip is more than 500Mb. - See [Creating an annotation task](/docs/for-users/user-guide/creating_an_annotation_task/) + See [Creating an annotation task](/docs/manual/basics/creating_an_annotation_task/) guide for details. 1. Create `obj.names` with the following content: diff --git a/site/content/en/docs/for-users/user-guide/models.md b/site/content/en/docs/manual/advanced/models.md similarity index 58% rename from site/content/en/docs/for-users/user-guide/models.md rename to site/content/en/docs/manual/advanced/models.md index 1c3c0d46..e031d317 100644 --- a/site/content/en/docs/for-users/user-guide/models.md +++ b/site/content/en/docs/manual/advanced/models.md @@ -1,7 +1,7 @@ --- -title: "Models" -linkTitle: "Models" -weight: 5 +title: 'Models' +linkTitle: 'Models' +weight: 26 --- The Models page contains a list of deep learning (DL) models deployed for semi-automatic and automatic annotation. @@ -11,13 +11,14 @@ The list of models is presented in the form of a table. The parameters indicated - `Framework` the model is based on - model `Name` - model `Type`: - - `detector` - used for automatic annotation (available in [detectors](/docs/for-users/user-guide/advanced/ai-tools/#detectors) and [automatic annotation](/docs/for-users/user-guide/advanced/automatic-annotation/)) - - `interactor` - used for semi-automatic shape annotation (available in [interactors](/docs/for-users/user-guide/advanced/ai-tools/#interactors)) - - `tracker` - used for semi-automatic track annotation (available in [trackers](/docs/for-users/user-guide/advanced/ai-tools/#trackers)) - - `reid` - used to combine individual objects into a track (available in [automatic annotation](/docs/for-users/user-guide/advanced/automatic-annotation/)) + - `detector` - used for automatic annotation (available in [detectors](/docs/manual/advanced/ai-tools/#detectors) + and [automatic annotation](/docs/manual/advanced/automatic-annotation/)) + - `interactor` - used for semi-automatic shape annotation (available in [interactors](/docs/manual/advanced/ai-tools/#interactors)) + - `tracker` - used for semi-automatic track annotation (available in [trackers](/docs/manual/advanced/ai-tools/#trackers)) + - `reid` - used to combine individual objects into a track (available in [automatic annotation](/docs/manual/advanced/automatic-annotation/)) - `Description` - brief description of the model - `Labels` - list of the supported labels (only for the models of the `detectors` type) ![](/images/image099.jpg) -Read how to install your model [here](/docs/for-users/installation/#semi-automatic-and-automatic-annotation). +Read how to install your model [here](/docs/administration/basics/installation/#semi-automatic-and-automatic-annotation). diff --git a/site/content/en/docs/for-users/user-guide/advanced/opencv-tools.md b/site/content/en/docs/manual/advanced/opencv-tools.md similarity index 90% rename from site/content/en/docs/for-users/user-guide/advanced/opencv-tools.md rename to site/content/en/docs/manual/advanced/opencv-tools.md index 762b4a9f..ab68f0a1 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/opencv-tools.md +++ b/site/content/en/docs/manual/advanced/opencv-tools.md @@ -1,7 +1,7 @@ --- -title: "OpenCV tools" -linkTitle: "OpenCV tools" -weight: 6 +title: 'OpenCV tools' +linkTitle: 'OpenCV tools' +weight: 14 --- The tool based on [Open CV](https://opencv.org/) Computer Vision library @@ -37,4 +37,4 @@ displayed as a red square which is tied to the cursor. During the drawing process you can remove the last point by clicking on it with the left mouse button. - Once all the points are placed, you can complete the creation of the object by clicking on the icon or clicking `N`. - As a result, a polygon will be created (read more about the polygons in the [annotation with polygons](/docs/for-users/user-guide/advanced/annotation-with-polygons/)). + As a result, a polygon will be created (read more about the polygons in the [annotation with polygons](/docs/manual/advanced/annotation-with-polygons/)). diff --git a/site/content/en/docs/for-users/user-guide/projects.md b/site/content/en/docs/manual/advanced/projects.md similarity index 96% rename from site/content/en/docs/for-users/user-guide/projects.md rename to site/content/en/docs/manual/advanced/projects.md index 896bbefe..55e80cc2 100644 --- a/site/content/en/docs/for-users/user-guide/projects.md +++ b/site/content/en/docs/manual/advanced/projects.md @@ -1,7 +1,7 @@ --- -title: "Projects" -linkTitle: "Projects" -weight: 4 +title: 'Projects' +linkTitle: 'Projects' +weight: 3 --- At CVAT, you can create a project containing tasks of the same type. diff --git a/site/content/en/docs/for-users/user-guide/advanced/review.md b/site/content/en/docs/manual/advanced/review.md similarity index 97% rename from site/content/en/docs/for-users/user-guide/advanced/review.md rename to site/content/en/docs/manual/advanced/review.md index 187eac82..54e80189 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/review.md +++ b/site/content/en/docs/manual/advanced/review.md @@ -1,7 +1,7 @@ --- -title: "Review" -linkTitle: "Review" -weight: 13 +title: 'Review' +linkTitle: 'Review' +weight: 22 --- A special mode to check the annotation allows you to point to an object or area in the frame containing an error. diff --git a/site/content/en/docs/for-users/user-guide/search.md b/site/content/en/docs/manual/advanced/search.md similarity index 95% rename from site/content/en/docs/for-users/user-guide/search.md rename to site/content/en/docs/manual/advanced/search.md index d2120c10..0fb2f1a4 100644 --- a/site/content/en/docs/for-users/user-guide/search.md +++ b/site/content/en/docs/manual/advanced/search.md @@ -1,7 +1,7 @@ --- -title: "Search" -linkTitle: "Search" -weight: 6 +title: 'Search' +linkTitle: 'Search' +weight: 2 --- There are several options how to use the search. diff --git a/site/content/en/docs/for-users/user-guide/advanced/shape-grouping.md b/site/content/en/docs/manual/advanced/shape-grouping.md similarity index 91% rename from site/content/en/docs/for-users/user-guide/advanced/shape-grouping.md rename to site/content/en/docs/manual/advanced/shape-grouping.md index 751c5bdf..9a570760 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/shape-grouping.md +++ b/site/content/en/docs/manual/advanced/shape-grouping.md @@ -1,7 +1,7 @@ --- -title: "Shape grouping" -linkTitle: "Shape grouping" -weight: 15 +title: 'Shape grouping' +linkTitle: 'Shape grouping' +weight: 21 --- This feature allows us to group several shapes. diff --git a/site/content/en/docs/for-users/user-guide/advanced/shape-mode-advanced.md b/site/content/en/docs/manual/advanced/shape-mode-advanced.md similarity index 84% rename from site/content/en/docs/for-users/user-guide/advanced/shape-mode-advanced.md rename to site/content/en/docs/manual/advanced/shape-mode-advanced.md index 042de3e0..d98cefd1 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/shape-mode-advanced.md +++ b/site/content/en/docs/manual/advanced/shape-mode-advanced.md @@ -1,10 +1,10 @@ --- -title: "Shape mode (advanced)" -linkTitle: "Shape mode" -weight: 1 +title: 'Shape mode (advanced)' +linkTitle: 'Shape mode' +weight: 4 --- -Basic operations in the mode were described in section [shape mode (basics)](/docs/for-users/user-guide/basics/shape-mode-basics/). +Basic operations in the mode were described in section [shape mode (basics)](/docs/manual/basics/shape-mode-basics/). **Occluded** Occlusion is an attribute used if an object is occluded by another object or diff --git a/site/content/en/docs/for-users/user-guide/advanced/shortcuts.md b/site/content/en/docs/manual/advanced/shortcuts.md similarity index 99% rename from site/content/en/docs/for-users/user-guide/advanced/shortcuts.md rename to site/content/en/docs/manual/advanced/shortcuts.md index 3c6c515b..e83e8211 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/shortcuts.md +++ b/site/content/en/docs/manual/advanced/shortcuts.md @@ -1,7 +1,7 @@ --- -title: "Shortcuts" -linkTitle: "Shortcuts" -weight: 18 +title: 'Shortcuts' +linkTitle: 'Shortcuts' +weight: 24 --- Many UI elements have shortcut hints. Put your pointer to a required element to see it. diff --git a/site/content/en/docs/for-users/user-guide/task-synchronization.md b/site/content/en/docs/manual/advanced/task-synchronization.md similarity index 87% rename from site/content/en/docs/for-users/user-guide/task-synchronization.md rename to site/content/en/docs/manual/advanced/task-synchronization.md index e698664f..36134541 100644 --- a/site/content/en/docs/for-users/user-guide/task-synchronization.md +++ b/site/content/en/docs/manual/advanced/task-synchronization.md @@ -1,7 +1,7 @@ --- -title: "Task synchronization with a repository" -linkTitle: "Task synchronization" -weight: 10 +title: 'Task synchronization with a repository' +linkTitle: 'Task synchronization' +weight: 25 --- 1. At the end of the annotation process, a task is synchronized by clicking diff --git a/site/content/en/docs/for-users/user-guide/advanced/track-mode-advanced.md b/site/content/en/docs/manual/advanced/track-mode-advanced.md similarity index 76% rename from site/content/en/docs/for-users/user-guide/advanced/track-mode-advanced.md rename to site/content/en/docs/manual/advanced/track-mode-advanced.md index fbba2dbb..dacc0772 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/track-mode-advanced.md +++ b/site/content/en/docs/manual/advanced/track-mode-advanced.md @@ -1,10 +1,10 @@ --- -title: "Track mode (advanced)" -linkTitle: "Track mode" -weight: 2 +title: 'Track mode (advanced)' +linkTitle: 'Track mode' +weight: 5 --- -Basic operations in the mode were described in section [track mode (basics)](/docs/for-users/user-guide/basics/track-mode-basics/). +Basic operations in the mode were described in section [track mode (basics)](/docs/manual/basics/track-mode-basics/). Shapes that were created in the track mode, have extra navigation buttons. diff --git a/site/content/en/docs/for-developers/xml_format.md b/site/content/en/docs/manual/advanced/xml_format.md similarity index 99% rename from site/content/en/docs/for-developers/xml_format.md rename to site/content/en/docs/manual/advanced/xml_format.md index 620e0cc5..8b1d6944 100644 --- a/site/content/en/docs/for-developers/xml_format.md +++ b/site/content/en/docs/manual/advanced/xml_format.md @@ -1,7 +1,7 @@ --- title: 'XML annotation format' linkTitle: 'XML annotation format' -weight: 3 +weight: 30 --- diff --git a/site/content/en/docs/manual/basics/_index.md b/site/content/en/docs/manual/basics/_index.md new file mode 100644 index 00000000..41121d0b --- /dev/null +++ b/site/content/en/docs/manual/basics/_index.md @@ -0,0 +1,8 @@ +--- +title: "Basics" +linkTitle: "Basics" +weight: 1 +description: 'This section contains basic documents for CVAT users' +hide_feedback: true + +--- diff --git a/site/content/en/docs/for-users/user-guide/basics/attribute-annotation-mode-basics.md b/site/content/en/docs/manual/basics/attribute-annotation-mode-basics.md similarity index 86% rename from site/content/en/docs/for-users/user-guide/basics/attribute-annotation-mode-basics.md rename to site/content/en/docs/manual/basics/attribute-annotation-mode-basics.md index 59cc8d83..648d3ee4 100644 --- a/site/content/en/docs/for-users/user-guide/basics/attribute-annotation-mode-basics.md +++ b/site/content/en/docs/manual/basics/attribute-annotation-mode-basics.md @@ -1,7 +1,7 @@ --- -title: "Attribute annotation mode (basics)" -linkTitle: "Attribute annotation mode" -weight: 6 +title: 'Attribute annotation mode (basics)' +linkTitle: 'Attribute annotation mode' +weight: 12 --- - 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. @@ -26,4 +26,4 @@ weight: 6 - 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`. -Read more in the section [attribute annotation mode (advanced)](/docs/for-users/user-guide/advanced/attribute-annotation-mode-advanced/). +Read more in the section [attribute annotation mode (advanced)](/docs/manual/advanced/attribute-annotation-mode-advanced/). diff --git a/site/content/en/docs/for-users/user-guide/getting_started.md b/site/content/en/docs/manual/basics/authorization.md similarity index 93% rename from site/content/en/docs/for-users/user-guide/getting_started.md rename to site/content/en/docs/manual/basics/authorization.md index cd358fd8..829df269 100644 --- a/site/content/en/docs/for-users/user-guide/getting_started.md +++ b/site/content/en/docs/manual/basics/authorization.md @@ -1,9 +1,8 @@ --- -title: "Getting started" -linkTitle: "Getting started" +title: 'Authorization' +linkTitle: 'Authorization' weight: 1 --- -### Authorization - First of all, you have to log in to CVAT tool. diff --git a/site/content/en/docs/for-users/user-guide/basics/basic-navigation.md b/site/content/en/docs/manual/basics/basic-navigation.md similarity index 93% rename from site/content/en/docs/for-users/user-guide/basics/basic-navigation.md rename to site/content/en/docs/manual/basics/basic-navigation.md index 91863eac..9f2a0373 100644 --- a/site/content/en/docs/for-users/user-guide/basics/basic-navigation.md +++ b/site/content/en/docs/manual/basics/basic-navigation.md @@ -1,7 +1,7 @@ --- -title: "Basic navigation" -linkTitle: "Basic navigation" -weight: 1 +title: 'Basic navigation' +linkTitle: 'Basic navigation' +weight: 6 --- 1. Use arrows below to move to the next/previous frame. Use the scroll bar slider to scroll through frames. diff --git a/site/content/en/docs/for-users/user-guide/controls-sidebar.md b/site/content/en/docs/manual/basics/controls-sidebar.md similarity index 53% rename from site/content/en/docs/for-users/user-guide/controls-sidebar.md rename to site/content/en/docs/manual/basics/controls-sidebar.md index b2450203..feaff597 100644 --- a/site/content/en/docs/for-users/user-guide/controls-sidebar.md +++ b/site/content/en/docs/manual/basics/controls-sidebar.md @@ -1,8 +1,11 @@ --- -title: "Controls sidebar" -linkTitle: "Controls sidebar" -weight: 15 +title: 'Controls sidebar' +linkTitle: 'Controls sidebar' +weight: 23 --- + +## Navigation + **Navigation block** - contains tools for moving and rotating images. |Icon |Description | |-- |-- | @@ -12,6 +15,8 @@ weight: 15 --- +## Zoom + **Zoom block** - contains tools for image zoom. |Icon |Description | |-- |-- | @@ -20,26 +25,30 @@ weight: 15 --- +## Shapes + **Shapes block** - contains all the tools for creating shapes. |Icon |Description |Links to section | |-- |-- |-- | -|![](/images/image189.jpg)|`AI Tools`|[AI Tools](/docs/for-users/user-guide/advanced/ai-tools/)| -|![](/images/image201.jpg)|`OpenCV`|[OpenCV](/docs/for-users/user-guide/advanced/opencv-tools/)| -|![](/images/image167.jpg)|`Rectangle`|[Shape mode](/docs/for-users/user-guide/basics/shape-mode-basics/); [Track mode](/docs/for-users/user-guide/basics/track-mode-basics/);
[Drawing by 4 points](/docs/for-users/user-guide/advanced/annotation-with-rectangle-by-4-points/)| -|![](/images/image168.jpg)|`Polygon`|[Annotation with polygons](/docs/for-users/user-guide/advanced/annotation-with-polygons/); [Track mode with polygons](/docs/for-users/user-guide/advanced/annotation-with-polygons/track-mode-with-polygons/)| -|![](/images/image169.jpg)|`Polyline`|[Annotation with polylines](/docs/for-users/user-guide/advanced/annotation-with-polylines/)| -|![](/images/image170.jpg)|`Points`|[Annotation with points](/docs/for-users/user-guide/advanced/annotation-with-points/)| -|![](/images/image176.jpg)|`Cuboid`|[Annotation with cuboids](/docs/for-users/user-guide/advanced/annotation-with-cuboids/)| -|![](/images/image171.jpg)|`Tag`|[Annotation with tags](/docs/for-users/user-guide/advanced/annotation-with-tags/)| -|![](/images/image195.jpg)|`Open an issue`|[Review](/docs/for-users/user-guide/advanced/review/) (available only in review mode)| +|![](/images/image189.jpg)|`AI Tools`|[AI Tools](/docs/manual/advanced/ai-tools/)| +|![](/images/image201.jpg)|`OpenCV`|[OpenCV](/docs/manual/advanced/opencv-tools/)| +|![](/images/image167.jpg)|`Rectangle`|[Shape mode](/docs/manual/basics/shape-mode-basics/); [Track mode](/docs/manual/basics/track-mode-basics/);
[Drawing by 4 points](/docs/manual/advanced/annotation-with-rectangle-by-4-points/)| +|![](/images/image168.jpg)|`Polygon`|[Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/); [Track mode with polygons](/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons/)| +|![](/images/image169.jpg)|`Polyline`|[Annotation with polylines](/docs/manual/advanced/annotation-with-polylines/)| +|![](/images/image170.jpg)|`Points`|[Annotation with points](/docs/manual/advanced/annotation-with-points/)| +|![](/images/image176.jpg)|`Cuboid`|[Annotation with cuboids](/docs/manual/advanced/annotation-with-cuboids/)| +|![](/images/image171.jpg)|`Tag`|[Annotation with tags](/docs/manual/advanced/annotation-with-tags/)| +|![](/images/image195.jpg)|`Open an issue`|[Review](/docs/manual/advanced/review/) (available only in review mode)| --- +## Edit + **Edit block** - contains tools for editing tracks and shapes. |Icon |Description |Links to section | |-- |-- |-- | -|![](/images/image172.jpg)|`Merge Shapes`(`M`) — starts/stops the merging shapes mode. |[Track mode (basics)](/docs/for-users/user-guide/basics/track-mode-basics/)| -|![](/images/image173.jpg)|`Group Shapes` (`G`) — starts/stops the grouping shapes mode.|[Shape grouping](/docs/for-users/user-guide/advanced/shape-grouping/)| -|![](/images/image174.jpg)|`Split` — splits a track. |[Track mode (advanced)](/docs/for-users/user-guide/advanced/track-mode-advanced/)| +|![](/images/image172.jpg)|`Merge Shapes`(`M`) — starts/stops the merging shapes mode. |[Track mode (basics)](/docs/manual/basics/track-mode-basics/)| +|![](/images/image173.jpg)|`Group Shapes` (`G`) — starts/stops the grouping shapes mode.|[Shape grouping](/docs/manual/advanced/shape-grouping/)| +|![](/images/image174.jpg)|`Split` — splits a track. |[Track mode (advanced)](/docs/manual/advanced/track-mode-advanced/)| --- diff --git a/site/content/en/docs/for-users/user-guide/creating_an_annotation_task.md b/site/content/en/docs/manual/basics/creating_an_annotation_task.md similarity index 90% rename from site/content/en/docs/for-users/user-guide/creating_an_annotation_task.md rename to site/content/en/docs/manual/basics/creating_an_annotation_task.md index 24d5a53e..5a988b31 100644 --- a/site/content/en/docs/for-users/user-guide/creating_an_annotation_task.md +++ b/site/content/en/docs/manual/basics/creating_an_annotation_task.md @@ -1,13 +1,13 @@ --- -title: "Creating an annotation task" -linkTitle: "Creating an annotation task" +title: 'Creating an annotation task' +linkTitle: 'Creating an annotation task' weight: 2 --- 1. Create an annotation task pressing `Create new task` button on the tasks page or on the project page. ![](/images/image004.jpg) -1. Specify parameters of the task: +2. Specify parameters of the task: #### Basic configuration @@ -35,19 +35,19 @@ weight: 2 The following actions are available here: 1. Set the attribute’s name. - 1. Choose the way to display the attribute: + 2. 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`. + 3. 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). + 4. Checkbox `Mutable` determines if an attribute would be changed frame to frame. + 5. 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. @@ -66,7 +66,7 @@ weight: 2 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). If you upload a video or dataset with images and select `Use cache` option, you can attach a `manifest.jsonl` file. - You can find how to prepare it [here](/docs/for-developers/dataset_manifest/). + You can find how to prepare it [here](/docs/manual/advanced/dataset_manifest/). ![](/images/image127.jpg) @@ -79,7 +79,7 @@ weight: 2 **Use cache**. Defines how to work with data. Select the checkbox to switch to the "on-the-fly data processing", which will reduce the task creation time (by preparing chunks when requests are received) and store data in a cache of limited size with a policy of evicting less popular items. - See more [here](/docs/for-developers/data_on_fly/). + See more [here](/docs/manual/advanced/data_on_fly/). **Image Quality**. Use this option to specify quality of uploaded images. The option helps to load high resolution datasets faster. @@ -152,15 +152,15 @@ weight: 2 ![](/images/image006_detrac.jpg) -1. The tasks page contains elements and each of them relates to a separate task. They are sorted in creation order. +3. The tasks page contains elements and each of them relates to a separate task. They are sorted in creation order. Each element contains: task name, preview, progress bar, button `Open`, and menu `Actions`. Each button is responsible for a in menu `Actions` specific function: - `Dump Annotation` and `Export as a dataset` — download annotations or annotations and images in a specific format. The following formats are available: - - [CVAT for video](/docs/for-developers/xml_format/#interpolation) + - [CVAT for video](/docs/manual/advanced/xml_format/#interpolation) is highlighted if a task has the interpolation mode. - - [CVAT for images](/docs/for-developers/xml_format/#annotation) + - [CVAT for images](/docs/manual/advanced/xml_format/#annotation) is highlighted if a task has the annotation mode. - [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) - [(VOC) Segmentation mask](http://host.robots.ox.ac.uk/pascal/VOC/) — @@ -173,7 +173,7 @@ weight: 2 - [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0/) - [Datumaro](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats/datumaro) - `Upload annotation` is available in the same formats as in `Dump annotation`. - - [CVAT](/docs/for-developers/xml_format/) accepts both video and image sub-formats. + - [CVAT](/docs/manual/advanced/xml_format/) accepts both video and image sub-formats. - `Automatic Annotation` — automatic annotation with OpenVINO toolkit. Presence depends on how you build CVAT instance. - `Move to project` — Moving the task to the project (can be used to move a task from one project to another). @@ -182,4 +182,4 @@ weight: 2 Some task labels can be matched with the target project labels. - `Delete` — delete task. - Push `Open` button to go to [task details](/docs/for-users/user-guide/task-details). + Push `Open` button to go to [task details](/docs/manual/basics/task-details/). diff --git a/site/content/en/docs/for-users/user-guide/interface.md b/site/content/en/docs/manual/basics/interface.md similarity index 87% rename from site/content/en/docs/for-users/user-guide/interface.md rename to site/content/en/docs/manual/basics/interface.md index 1c7416c2..58db916f 100644 --- a/site/content/en/docs/for-users/user-guide/interface.md +++ b/site/content/en/docs/manual/basics/interface.md @@ -1,7 +1,7 @@ --- -title: "Interface of the annotation tool" -linkTitle: "Interface" -weight: 7 +title: 'Interface of the annotation tool' +linkTitle: 'Interface' +weight: 4 --- The tool consists of: diff --git a/site/content/en/docs/for-users/user-guide/objects-sidebar.md b/site/content/en/docs/manual/basics/objects-sidebar.md similarity index 93% rename from site/content/en/docs/for-users/user-guide/objects-sidebar.md rename to site/content/en/docs/manual/basics/objects-sidebar.md index acf2a25a..67b4cf25 100644 --- a/site/content/en/docs/for-users/user-guide/objects-sidebar.md +++ b/site/content/en/docs/manual/basics/objects-sidebar.md @@ -1,20 +1,20 @@ --- -title: "Objects sidebar" -linkTitle: "Objects sidebar" -weight: 16 +title: 'Objects sidebar' +linkTitle: 'Objects sidebar' +weight: 24 --- `Hide` - the button hides the object's sidebar. ![](/images/image146.jpg) -#### Objects +## Objects **Filter** input box ![](/images/image059.jpg) -The way how to use filters is described in the advanced guide [here](/docs/for-users/user-guide/advanced/filter/). +The way how to use filters is described in the advanced guide [here](/docs/manual/advanced/filter/). **List of objects** @@ -28,8 +28,8 @@ The way how to use filters is described in the advanced guide [here](/docs/for-u In the objects sidebar you can see the list of available objects on the current frame. The following figure is an example of how the list might look like: -| Shape mode | Track mode | -| --------------------------------------------- | --------------------------------------------- | +| Shape mode | Track mode | +| ------------------------- | ------------------------- | | ![](/images/image044.jpg) | ![](/images/image045.jpg) | --- @@ -90,7 +90,7 @@ By clicking on the `Details` button you can collapse or expand the field with al --- -#### Labels +## Labels In this tab you can lock or hide objects of a certain label. To change the color for a specific label, @@ -118,7 +118,7 @@ In case you do not point the cursor to the object, pressing `Ctrl + Num(0..9)` w --- -#### Appearance +## Appearance **Color By** options diff --git a/site/content/en/docs/for-users/user-guide/settings.md b/site/content/en/docs/manual/basics/settings.md similarity index 89% rename from site/content/en/docs/for-users/user-guide/settings.md rename to site/content/en/docs/manual/basics/settings.md index 8e45b310..102f7509 100644 --- a/site/content/en/docs/for-users/user-guide/settings.md +++ b/site/content/en/docs/manual/basics/settings.md @@ -1,6 +1,6 @@ --- -title: "Settings" -linkTitle: "Settings" +title: 'Settings' +linkTitle: 'Settings' weight: 13 --- To open the settings open the user menu in the header and select the settings item or press `F2`. @@ -33,9 +33,9 @@ In tab `Workspace` you can: ![](/images/image152_detrac.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](/docs/for-users/user-guide/advanced/annotation-with-polygons/). + For more information To find out more, go to the section [annotation with polygons](/docs/manual/advanced/annotation-with-polygons/). -- `Intelligent polygon cropping` - activates intelligent cropping when editing the polygon (read more in the section [edit polygon](/docs/for-users/user-guide/advanced/annotation-with-polygons/edit-polygon/) +- `Intelligent polygon cropping` - activates intelligent cropping when editing the polygon (read more in the section [edit polygon](/docs/manual/advanced/annotation-with-polygons/edit-polygon/) - `Attribute annotation mode (AAM) zoom margin` input box — defines margins (in px) for shape in the attribute annotation mode. diff --git a/site/content/en/docs/for-users/user-guide/basics/shape-mode-basics.md b/site/content/en/docs/manual/basics/shape-mode-basics.md similarity index 83% rename from site/content/en/docs/for-users/user-guide/basics/shape-mode-basics.md rename to site/content/en/docs/manual/basics/shape-mode-basics.md index 25ae034b..f52acded 100644 --- a/site/content/en/docs/for-users/user-guide/basics/shape-mode-basics.md +++ b/site/content/en/docs/manual/basics/shape-mode-basics.md @@ -1,7 +1,7 @@ --- -title: "Shape mode (basics)" -linkTitle: "Shape mode" -weight: 3 +title: 'Shape mode (basics)' +linkTitle: 'Shape mode' +weight: 10 --- Usage examples: @@ -27,7 +27,7 @@ Usage examples: ![](/images/image011_detrac.jpg) - - To learn about creating a rectangle using the by 4 point drawing method, ([read here](/docs/for-users/user-guide/advanced/annotation-with-rectangle-by-4-points/)). + - To learn about creating a rectangle using the by 4 point drawing method, ([read here](/docs/manual/advanced/annotation-with-rectangle-by-4-points/)). - It is possible to adjust boundaries and location of the rectangle using a mouse. Rectangle's size is shown in the top right corner , you can check it by clicking on any point of the shape. @@ -43,4 +43,4 @@ Usage examples: ![](/images/image013_detrac.jpg) - Read more in the section [shape mode (advanced)](/docs/for-users/user-guide/advanced/shape-mode-advanced/). + Read more in the section [shape mode (advanced)](/docs/manual/advanced/shape-mode-advanced/). diff --git a/site/content/en/docs/for-users/user-guide/task-details.md b/site/content/en/docs/manual/basics/task-details.md similarity index 81% rename from site/content/en/docs/for-users/user-guide/task-details.md rename to site/content/en/docs/manual/basics/task-details.md index 300cfcd9..2d3db9b1 100644 --- a/site/content/en/docs/for-users/user-guide/task-details.md +++ b/site/content/en/docs/manual/basics/task-details.md @@ -1,7 +1,7 @@ --- -title: "Task details" -linkTitle: "Task details" -weight: 2.5 +title: 'Task details' +linkTitle: 'Task details' +weight: 3 --- Task details is a task page which contains a preview, a progress bar @@ -11,12 +11,12 @@ and the details of the task (specified when the task was created) and the jobs s - The next actions are available on this page: 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 (available only if the task is not related to the project). + 2. Open `Actions` menu. + 3. Change issue tracker or open issue tracker if it is specified. + 4. Change labels (available only if the task is not related to the project). 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 + 5. 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. @@ -28,7 +28,8 @@ and the details of the task (specified when the task was created) and the jobs s - 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. - - Reviewer – a user assigned to carry out the review, read more in the [review](/docs/for-users/user-guide/advanced/review/) section. + - Reviewer – a user assigned to carry out the review, + read more in the [review](/docs/manual/advanced/review/) section. - `Copy`. By clicking `Copy` you will copy the job list to the clipboard. The job list contains direct links to jobs. diff --git a/site/content/en/docs/for-users/user-guide/top-panel.md b/site/content/en/docs/manual/basics/top-panel.md similarity index 82% rename from site/content/en/docs/for-users/user-guide/top-panel.md rename to site/content/en/docs/manual/basics/top-panel.md index 4efc8b39..7b1b9489 100644 --- a/site/content/en/docs/for-users/user-guide/top-panel.md +++ b/site/content/en/docs/manual/basics/top-panel.md @@ -1,14 +1,14 @@ --- -title: "Top Panel" -linkTitle: "Top Panel" -weight: 14 +title: 'Top Panel' +linkTitle: 'Top Panel' +weight: 21 --- ![](/images/image035.jpg) --- -#### Menu button +## Menu button It is the main menu of the annotation tool. It can be used to download, upload and remove annotations. @@ -25,17 +25,17 @@ Button assignment: - [MS COCO](http://cocodataset.org/#format-data) - [YOLO](https://pjreddie.com/darknet/yolo/) - `Open the task` — opens a page with details about the task. -- `Request a review` - calls up the form to submit the job for a review, read more in the [review](/docs/for-users/user-guide/advanced/review/) section. +- `Request a review` - calls up the form to submit the job for a review, read more in the [review](/docs/manual/advanced/review/) section. - `Finish the job` - changes the status of the job to `completed` and returns to the task page without review. -- `Submit the review` - (available during the review) calls up the form to submit a review, read more in the [review](/docs/for-users/user-guide/advanced/review/) section. +- `Submit the review` - (available during the review) calls up the form to submit a review, read more in the [review](/docs/manual/advanced/review/) section. -#### Save Work +## Save Work Saves annotations for the current job. The button has an indication of the saving process. ![](/images/image141.jpg) -#### Undo-redo buttons +## Undo-redo buttons Use buttons to undo actions or redo them. @@ -43,7 +43,7 @@ Use buttons to undo actions or redo them. --- -#### Player +## Player Go to the first /the latest frames. @@ -60,7 +60,7 @@ To customize, right-click on the button and select one of three options: 1. The default option - go to the next / previous frame (the step is 1 frame). 2. Go to the next / previous frame that has any objects (in particular filtered). - Read the [filter](/docs/for-users/user-guide/advanced/filter/) section to know the details how to use it. + Read the [filter](/docs/manual/advanced/filter/) section to know the details how to use it. 3. Go to the next / previous frame without annotation at all. Use this option in cases when you need to find missed frames quickly. @@ -79,13 +79,13 @@ Go to a specific frame. Press `~` to focus on the element. --- -#### Fullscreen Player +## Fullscreen Player The fullscreen player mode. The keyboard shortcut is `F11`. ![](/images/image143.jpg) -#### Info +## Info Open the job info. @@ -94,7 +94,8 @@ Open the job info. _Overview_: - `Assinger` - the one to whom the job is assigned. -- `Reviewer` – a user assigned to carry out the review, read more in the [review](/docs/for-users/user-guide/advanced/review) section. +- `Reviewer` – a user assigned to carry out the review, + read more in the [review](/docs/manual/advanced/review) section. - `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. @@ -104,7 +105,7 @@ _Annotations statistics_: 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. -#### UI switcher +## UI switcher Switching between user interface modes. diff --git a/site/content/en/docs/for-users/user-guide/basics/track-mode-basics.md b/site/content/en/docs/manual/basics/track-mode-basics.md similarity index 92% rename from site/content/en/docs/for-users/user-guide/basics/track-mode-basics.md rename to site/content/en/docs/manual/basics/track-mode-basics.md index 0a453c71..1a1c8780 100644 --- a/site/content/en/docs/for-users/user-guide/basics/track-mode-basics.md +++ b/site/content/en/docs/manual/basics/track-mode-basics.md @@ -1,7 +1,7 @@ --- -title: "Track mode (basics)" -linkTitle: "Track mode" -weight: 4 +title: 'Track mode (basics)' +linkTitle: 'Track mode' +weight: 11 --- Usage examples: @@ -66,4 +66,4 @@ Usage examples: ![](/images/gif003_detrac.gif) - Read more in the section [track mode (advanced)](/docs/for-users/user-guide/advanced/track-mode-advanced/). + Read more in the section [track mode (advanced)](/docs/manual/advanced/track-mode-advanced/). diff --git a/site/content/en/docs/for-users/user-guide/types-of-shapes.md b/site/content/en/docs/manual/basics/types-of-shapes.md similarity index 88% rename from site/content/en/docs/for-users/user-guide/types-of-shapes.md rename to site/content/en/docs/manual/basics/types-of-shapes.md index 6733ce8e..60ed76a0 100644 --- a/site/content/en/docs/for-users/user-guide/types-of-shapes.md +++ b/site/content/en/docs/manual/basics/types-of-shapes.md @@ -1,7 +1,7 @@ --- -title: "Types of shapes " -linkTitle: "Types of shapes" -weight: 7.5 +title: 'Types of shapes' +linkTitle: 'Types of shapes' +weight: 5 --- There are five shapes which you can annotate your images with: diff --git a/site/content/en/docs/for-users/user-guide/vocabulary.md b/site/content/en/docs/manual/basics/vocabulary.md similarity index 94% rename from site/content/en/docs/for-users/user-guide/vocabulary.md rename to site/content/en/docs/manual/basics/vocabulary.md index bf4a2c43..a27c877c 100644 --- a/site/content/en/docs/for-users/user-guide/vocabulary.md +++ b/site/content/en/docs/manual/basics/vocabulary.md @@ -1,7 +1,7 @@ --- -title: "Vocabulary" -linkTitle: "Vocabulary" -weight: 11 +title: 'Vocabulary' +linkTitle: 'Vocabulary' +weight: 14 --- **Label** is a type of an annotated object (e.g. person, car, vehicle, etc.) diff --git a/site/content/en/docs/for-users/user-guide/workspace.md b/site/content/en/docs/manual/basics/workspace.md similarity index 96% rename from site/content/en/docs/for-users/user-guide/workspace.md rename to site/content/en/docs/manual/basics/workspace.md index a8e57c25..e331e630 100644 --- a/site/content/en/docs/for-users/user-guide/workspace.md +++ b/site/content/en/docs/manual/basics/workspace.md @@ -1,7 +1,7 @@ --- -title: "Workspace" -linkTitle: "Workspace" -weight: 12 +title: 'Workspace' +linkTitle: 'Workspace' +weight: 22 --- This is the main field in which drawing and editing objects takes place. diff --git a/site/content/en/images/create_a_new_task.gif b/site/content/en/images/create_a_new_task.gif new file mode 100644 index 00000000..4ab75145 Binary files /dev/null and b/site/content/en/images/create_a_new_task.gif differ diff --git a/site/content/en/images/image212_mapillary_vistas.jpg b/site/content/en/images/image212_mapillary_vistas.jpg new file mode 100644 index 00000000..57446956 Binary files /dev/null and b/site/content/en/images/image212_mapillary_vistas.jpg differ diff --git a/site/content/en/images/image213_mapillary_vistas.jpg b/site/content/en/images/image213_mapillary_vistas.jpg new file mode 100644 index 00000000..08174d22 Binary files /dev/null and b/site/content/en/images/image213_mapillary_vistas.jpg differ diff --git a/utils/README.md b/utils/README.md index ca5f9722..5e4709b7 100644 --- a/utils/README.md +++ b/utils/README.md @@ -5,4 +5,4 @@ This folder contains some useful utilities for Computer Vision Annotation Tool (CVAT). To read about a certain utility please choose a link: -- [Command line interface for working with CVAT tasks](/site/content/en/docs/for-developers/cli.md) +- [Command line interface for working with CVAT tasks](https://openvinotoolkit.github.io/cvat/docs/manual/advanced/cli/)