From 7069b7e4463103f641e4eb3b9d0abdc1313df1dd Mon Sep 17 00:00:00 2001 From: Roman Donchenko Date: Wed, 27 Mar 2024 17:55:19 +0200 Subject: [PATCH 1/9] Docs: replace all internal links with Hugo references This helps detect broken links. --- .../docs/administration/advanced/analytics.md | 2 +- .../administration/advanced/backup_guide.md | 4 +- .../installation_automatic_annotation.md | 2 +- .../administration/advanced/upgrade_guide.md | 14 +++--- .../docs/administration/advanced/webhooks.md | 4 +- .../basics/AWS-Deployment-Guide.md | 2 +- .../administration/basics/admin-account.md | 2 +- .../administration/basics/installation.md | 10 ++-- site/content/en/docs/api_sdk/cli/_index.md | 6 +-- site/content/en/docs/api_sdk/sdk/_index.md | 8 ++-- .../en/docs/api_sdk/sdk/auto-annotation.md | 2 +- .../contributing/development-environment.md | 2 +- .../contributing/new-annotation-format.md | 28 +++++------ .../en/docs/contributing/running-tests.md | 2 +- .../setup-additional-components.md | 2 +- .../en/docs/enterprise/shapes-converter.md | 2 +- site/content/en/docs/faq.md | 18 +++---- .../en/docs/getting_started/overview.md | 48 +++++++++---------- .../en/docs/getting_started/workflow-org.md | 30 ++++++------ .../advanced/3d-object-annotation-advanced.md | 2 +- .../en/docs/manual/advanced/ai-tools.md | 8 ++-- .../analytics-and-monitoring/auto-qa.md | 4 +- .../analytics-and-monitoring/manual-qa.md | 4 +- .../advanced/annotation-with-brush-tool.md | 22 ++++----- .../editing-the-cuboid.md | 2 +- .../advanced/annotation-with-ellipses.md | 4 +- .../annotation-with-polygons/creating-mask.md | 2 +- .../manual-drawing.md | 2 +- .../track-mode-with-polygons.md | 4 +- .../advanced/annotation-with-rectangles.md | 8 ++-- .../attribute-annotation-mode-advanced.md | 2 +- .../manual/advanced/automatic-annotation.md | 6 +-- .../content/en/docs/manual/advanced/backup.md | 4 +- .../docs/manual/advanced/contextual-images.md | 4 +- .../en/docs/manual/advanced/data_on_fly.md | 4 +- .../docs/manual/advanced/dataset_manifest.md | 6 +-- .../content/en/docs/manual/advanced/filter.md | 16 +++---- .../en/docs/manual/advanced/formats/_index.md | 4 +- .../manual/advanced/formats/format-coco.md | 2 +- .../manual/advanced/formats/format-cvat.md | 2 +- .../manual/advanced/formats/format-voc.md | 2 +- .../manual/advanced/formats/format-yolo.md | 2 +- .../en/docs/manual/advanced/iam_user_roles.md | 4 +- .../docs/manual/advanced/import-datasets.md | 8 ++-- .../content/en/docs/manual/advanced/models.md | 14 +++--- .../en/docs/manual/advanced/organization.md | 2 +- .../en/docs/manual/advanced/projects.md | 14 +++--- .../manual/advanced/shape-mode-advanced.md | 2 +- .../en/docs/manual/advanced/skeletons.md | 16 +++---- .../en/docs/manual/advanced/slice-and-join.md | 4 +- .../manual/advanced/track-mode-advanced.md | 2 +- .../manual/basics/3d-object-annotation.md | 2 +- .../manual/basics/attach-cloud-storage.md | 4 +- .../attribute-annotation-mode-basics.md | 2 +- .../en/docs/manual/basics/cloud-storages.md | 2 +- .../en/docs/manual/basics/controls-sidebar.md | 34 ++++++------- .../docs/manual/basics/create-multi-tasks.md | 6 +-- .../basics/create_an_annotation_task.md | 14 +++--- .../en/docs/manual/basics/interface.md | 12 ++--- .../en/docs/manual/basics/jobs-page.md | 4 +- .../en/docs/manual/basics/objects-sidebar.md | 4 +- .../en/docs/manual/basics/registration.md | 2 +- .../content/en/docs/manual/basics/settings.md | 4 +- .../docs/manual/basics/shape-mode-basics.md | 4 +- .../manual/basics/standard-3d-mode-basics.md | 2 +- .../en/docs/manual/basics/task-details.md | 4 +- .../en/docs/manual/basics/tasks-page.md | 14 +++--- .../en/docs/manual/basics/top-panel.md | 12 ++--- .../docs/manual/basics/track-mode-basics.md | 2 +- .../en/docs/manual/basics/vocabulary.md | 26 +++++----- .../en/docs/manual/basics/workspace.md | 4 +- 71 files changed, 264 insertions(+), 264 deletions(-) diff --git a/site/content/en/docs/administration/advanced/analytics.md b/site/content/en/docs/administration/advanced/analytics.md index e588caf78c84..5a142b0af5ff 100644 --- a/site/content/en/docs/administration/advanced/analytics.md +++ b/site/content/en/docs/administration/advanced/analytics.md @@ -64,7 +64,7 @@ docker compose up -d If you cannot access analytics on development environnement, -see [Analytics Ports](/docs/contributing/development-environment/#cvat-analytics-ports) +see [Analytics Ports]({{< relref "/docs/contributing/development-environment#cvat-analytics-ports" >}}) ### Events log structure diff --git a/site/content/en/docs/administration/advanced/backup_guide.md b/site/content/en/docs/administration/advanced/backup_guide.md index 35c647bb846b..0c49cf935e47 100644 --- a/site/content/en/docs/administration/advanced/backup_guide.md +++ b/site/content/en/docs/administration/advanced/backup_guide.md @@ -23,7 +23,7 @@ Docker volumes are used to store all CVAT data: - `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/administration/advanced/analytics/) +- `cvat_events`: this is an optional volume that is used only when [Analytics component]({{< relref "/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. @@ -62,7 +62,7 @@ it will not work because between CVAT releases the layout of DB can be changed. You always can upgrade CVAT later. It will take care to migrate your data properly internally.** -Note: CVAT containers must exist (if no, please follow the [installation guide](/docs/administration/basics/installation/#quick-installation-guide)). +Note: CVAT containers must exist (if no, please follow the [installation guide]({{< relref "/docs/administration/basics/installation#quick-installation-guide" >}})). Stop all CVAT containers: ```shell diff --git a/site/content/en/docs/administration/advanced/installation_automatic_annotation.md b/site/content/en/docs/administration/advanced/installation_automatic_annotation.md index 1a324c515c0c..438ed5c7317a 100644 --- a/site/content/en/docs/administration/advanced/installation_automatic_annotation.md +++ b/site/content/en/docs/administration/advanced/installation_automatic_annotation.md @@ -77,7 +77,7 @@ description: 'Information about the installation of components needed for semi-a - The number of GPU deployed functions will be limited to your GPU memory. - See [deploy_gpu.sh](https://github.com/cvat-ai/cvat/blob/develop/serverless/deploy_gpu.sh) script for more examples. - - For some models (namely [SiamMask](/docs/manual/advanced/ai-tools#trackers)) you need an [Nvidia driver](https://www.nvidia.com/en-us/drivers/unix/) + - For some models (namely [SiamMask]({{< relref "/docs/manual/advanced/ai-tools#trackers" >}})) you need an [Nvidia driver](https://www.nvidia.com/en-us/drivers/unix/) version greater than or equal to 450.80.02. **Note for Windows users:** diff --git a/site/content/en/docs/administration/advanced/upgrade_guide.md b/site/content/en/docs/administration/advanced/upgrade_guide.md index 9db804310291..3da52cc6453c 100644 --- a/site/content/en/docs/administration/advanced/upgrade_guide.md +++ b/site/content/en/docs/administration/advanced/upgrade_guide.md @@ -15,13 +15,13 @@ upgrading PostgreSQL base image major version. See details [here](#how-to-upgrad To upgrade CVAT, follow these steps: - It is highly recommended backup all CVAT data before updating, follow the - [backup guide](/docs/administration/advanced/backup_guide/) and backup all CVAT volumes. + [backup guide]({{< relref "/docs/administration/advanced/backup_guide" >}}) and backup all CVAT volumes. - Go to the previously cloned CVAT directory and stop all CVAT containers with: ```shell docker compose down ``` - If you have included [additional components](/docs/administration/basics/installation/#additional-components), + If you have included [additional components]({{< relref "/docs/administration/basics/installation#additional-components" >}}), include all compose configuration files that are used, e.g.: ```shell docker compose -f docker-compose.yml -f components/serverless/docker-compose.serverless.yml down @@ -30,16 +30,16 @@ To upgrade CVAT, follow these steps: - Update CVAT source code by any preferable way: clone with git or download zip file from GitHub. Note that you need to download the entire source code, not just the Docker Compose configuration file. Check the - [installation guide](/docs/administration/basics/installation/#how-to-get-cvat-source-code) for details. + [installation guide]({{< relref "/docs/administration/basics/installation#how-to-get-cvat-source-code" >}}) for details. - Verify settings: The installation process is changed/modified from version to version and you may need to export some environment variables, for example - [CVAT_HOST](/docs/administration/basics/installation/#use-your-own-domain). + [CVAT_HOST]({{< relref "/docs/administration/basics/installation#use-your-own-domain" >}}). - Update local CVAT images. Pull or build new CVAT images, see - [How to pull/build/update CVAT images section](/docs/administration/basics/installation/#how-to-pullbuildupdate-cvat-images) + [How to pull/build/update CVAT images section]({{< relref "/docs/administration/basics/installation#how-to-pullbuildupdate-cvat-images" >}}) for details. - Start CVAT with: @@ -101,7 +101,7 @@ docker compose up -d ## How to upgrade PostgreSQL database base image 1. It is highly recommended backup all CVAT data before updating, follow the - [backup guide](/docs/administration/advanced/backup_guide/) and backup CVAT database volume. + [backup guide]({{< relref "/docs/administration/advanced/backup_guide" >}}) and backup CVAT database volume. 1. Run previously used CVAT version as usual @@ -122,7 +122,7 @@ docker compose up -d 1. Update CVAT source code by any preferable way: clone with git or download zip file from GitHub. Check the - [installation guide](/docs/administration/basics/installation/#how-to-get-cvat-source-code) for details. + [installation guide]({{< relref "/docs/administration/basics/installation#how-to-get-cvat-source-code" >}}) for details. 1. Start database container only: ```shell diff --git a/site/content/en/docs/administration/advanced/webhooks.md b/site/content/en/docs/administration/advanced/webhooks.md index a29081fb2069..2b5e4927b1a7 100644 --- a/site/content/en/docs/administration/advanced/webhooks.md +++ b/site/content/en/docs/administration/advanced/webhooks.md @@ -47,7 +47,7 @@ See: To create a webhook for **Project**, do the following: -1. [Create a Project](/docs/manual/advanced/projects/). +1. [Create a Project]({{< relref "/docs/manual/advanced/projects" >}}). 2. Go to the **Projects** and click on the project's widget. 3. In the top right corner, click **Actions** > **Setup Webhooks**. 4. In the top right corner click **+** @@ -60,7 +60,7 @@ To create a webhook for **Project**, do the following: To create a webhook for **Organization**, do the following: -1. [Create Organization](/docs/manual/advanced/organization/) +1. [Create Organization]({{< relref "/docs/manual/advanced/organization" >}}) 2. Go to the **Organization** > **Settings** > **Actions** > **Setup Webhooks**. 3. In the top right corner click **+** diff --git a/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md b/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md index fd7dcf66e829..5cff92d7592d 100644 --- a/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md +++ b/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md @@ -19,7 +19,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/administration/basics/installation/). + [installation instructions]({{< relref "/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 set the `CVAT_HOST` environment variable to the exposed diff --git a/site/content/en/docs/administration/basics/admin-account.md b/site/content/en/docs/administration/basics/admin-account.md index 890ebf92c5a2..e994909d1c55 100644 --- a/site/content/en/docs/administration/basics/admin-account.md +++ b/site/content/en/docs/administration/basics/admin-account.md @@ -16,7 +16,7 @@ to assign groups (roles) to other users. ### Prerequisites Before you register an admin account (superuser), you need to install CVAT locally, -see [Installation Guide](/docs/administration/basics/installation/). +see [Installation Guide]({{< relref "/docs/administration/basics/installation" >}}). Steps of installation are partly different, depending on the type of operation system (OS). diff --git a/site/content/en/docs/administration/basics/installation.md b/site/content/en/docs/administration/basics/installation.md index 4dcb92401d66..b81a94e912a8 100644 --- a/site/content/en/docs/administration/basics/installation.md +++ b/site/content/en/docs/administration/basics/installation.md @@ -126,7 +126,7 @@ For access from China, read [sources for users from China](#sources-for-users-fr - 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 manual](/docs/manual/) for more details. + [CVAT manual]({{< relref "/docs/manual" >}}) for more details. ## Windows 10 @@ -209,7 +209,7 @@ For access from China, read [sources for users from China](#sources-for-users-fr - 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 manual](/docs/manual/) for more details. + [CVAT manual]({{< relref "/docs/manual" >}}) for more details. ## Mac OS Mojave @@ -285,7 +285,7 @@ For access from China, read [sources for users from China](#sources-for-users-fr - 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 manual](/docs/manual/) for more details. + [CVAT manual]({{< relref "/docs/manual" >}}) for more details. ## Advanced Topics @@ -438,7 +438,7 @@ if you want to keep the dashboard in production you should read Traefik's #### Semi-automatic and automatic annotation -Please follow this [guide](/docs/administration/advanced/installation_automatic_annotation/). +Please follow this [guide]({{< relref "/docs/administration/advanced/installation_automatic_annotation" >}}). ### Stop all containers @@ -488,7 +488,7 @@ volumes: You can change the share device path to your actual share. -You can [mount](/docs/administration/advanced/mounting_cloud_storages/) +You can [mount]({{< relref "/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/api_sdk/cli/_index.md b/site/content/en/docs/api_sdk/cli/_index.md index ad44a5175619..5b3ff0989e96 100644 --- a/site/content/en/docs/api_sdk/cli/_index.md +++ b/site/content/en/docs/api_sdk/cli/_index.md @@ -83,10 +83,10 @@ optional arguments: ### Create Description of the options you can find in -[Creating an annotation task](/docs/manual/basics/creating_an_annotation_task/) section. +[Creating an annotation task]({{< relref "/docs/manual/basics/creating_an_annotation_task" >}}) section. For create a task you need file contain labels in the `json` format, you can create a JSON label specification -by using the [label constructor](/docs/manual/basics/creating_an_annotation_task/#labels). +by using the [label constructor]({{< relref "/docs/manual/basics/creating_an_annotation_task#labels" >}}).
Example JSON labels file @@ -227,7 +227,7 @@ by using the [label constructor](/docs/manual/basics/creating_an_annotation_task ### Auto-annotate This command provides a command-line interface -to the [auto-annotation API](/docs/api_sdk/sdk/auto-annotation). +to the [auto-annotation API]({{< relref "/docs/api_sdk/sdk/auto-annotation" >}}). It can auto-annotate using AA functions implemented in one of the following ways: diff --git a/site/content/en/docs/api_sdk/sdk/_index.md b/site/content/en/docs/api_sdk/sdk/_index.md index 025130ba3963..d314ba51c8ff 100644 --- a/site/content/en/docs/api_sdk/sdk/_index.md +++ b/site/content/en/docs/api_sdk/sdk/_index.md @@ -12,10 +12,10 @@ simplify server interaction and provide additional functionality like data valid and serialization. SDK API includes several layers: -- Low-level API with REST API wrappers. Located at `cvat_sdk.api_client`. [Read more](/docs/api_sdk/sdk/lowlevel-api) -- High-level API. Located at `cvat_sdk.core`. [Read more](/docs/api_sdk/sdk/highlevel-api) -- PyTorch adapter. Located at `cvat_sdk.pytorch`. [Read more](/docs/api_sdk/sdk/pytorch-adapter) -- Auto-annotation API. Located at `cvat_sdk.auto_annotation.` [Read more](/docs/api_sdk/sdk/auto-annotation) +- Low-level API with REST API wrappers. Located at `cvat_sdk.api_client`. [Read more]({{< relref "/docs/api_sdk/sdk/lowlevel-api" >}}) +- High-level API. Located at `cvat_sdk.core`. [Read more]({{< relref "/docs/api_sdk/sdk/highlevel-api" >}}) +- PyTorch adapter. Located at `cvat_sdk.pytorch`. [Read more]({{< relref "/docs/api_sdk/sdk/pytorch-adapter" >}}) +- Auto-annotation API. Located at `cvat_sdk.auto_annotation.` [Read more]({{< relref "/docs/api_sdk/sdk/auto-annotation" >}}) In general, the low-level API provides single-request operations, while the high-level one implements composite, multi-request operations, and provides local proxies for server objects. diff --git a/site/content/en/docs/api_sdk/sdk/auto-annotation.md b/site/content/en/docs/api_sdk/sdk/auto-annotation.md index b85ab7b067b9..504b0e411063 100644 --- a/site/content/en/docs/api_sdk/sdk/auto-annotation.md +++ b/site/content/en/docs/api_sdk/sdk/auto-annotation.md @@ -35,7 +35,7 @@ The layer can be divided into several parts: The `auto-annotate` CLI command provides a way to use an AA function from the command line rather than from a Python program. -See [the CLI documentation](/docs/api_sdk/cli/) for details. +See [the CLI documentation]({{< relref "/docs/api_sdk/cli" >}}) for details. ## Example diff --git a/site/content/en/docs/contributing/development-environment.md b/site/content/en/docs/contributing/development-environment.md index d40ea29d97b0..677a8ecf0a3a 100644 --- a/site/content/en/docs/contributing/development-environment.md +++ b/site/content/en/docs/contributing/development-environment.md @@ -219,7 +219,7 @@ description: 'Installing a development environment for different operating syste You have done! Now it is possible to insert breakpoints and debug server and client of the tool. -Instructions for running tests locally are available [here](/docs/contributing/running-tests/). +Instructions for running tests locally are available [here]({{< relref "/docs/contributing/running-tests" >}}). ## Note for Windows users diff --git a/site/content/en/docs/contributing/new-annotation-format.md b/site/content/en/docs/contributing/new-annotation-format.md index 4ced1e15af1e..cb122a3fde16 100644 --- a/site/content/en/docs/contributing/new-annotation-format.md +++ b/site/content/en/docs/contributing/new-annotation-format.md @@ -142,17 +142,17 @@ task_data.add_shape(shape) ## Format specifications -- [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/) -- [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/) +- [CVAT]({{< relref "/docs/manual/advanced/formats/format-cvat" >}}) +- [Datumaro]({{< relref "/docs/manual/advanced/formats/format-datumaro" >}}) +- [LabelMe]({{< relref "/docs/manual/advanced/formats/format-labelme" >}}) +- [MOT]({{< relref "/docs/manual/advanced/formats/format-mot" >}}) +- [MOTS]({{< relref "/docs/manual/advanced/formats/format-mots" >}}) +- [COCO]({{< relref "/docs/manual/advanced/formats/format-coco" >}}) +- [PASCAL VOC and mask]({{< relref "/docs/manual/advanced/formats/format-voc" >}}) +- [YOLO]({{< relref "/docs/manual/advanced/formats/format-yolo" >}}) +- [ImageNet]({{< relref "/docs/manual/advanced/formats/format-imagenet" >}}) +- [CamVid]({{< relref "/docs/manual/advanced/formats/format-camvid" >}}) +- [WIDER Face]({{< relref "/docs/manual/advanced/formats/format-widerface" >}}) +- [VGGFace2]({{< relref "/docs/manual/advanced/formats/format-vggface2" >}}) +- [Market-1501]({{< relref "/docs/manual/advanced/formats/format-market1501" >}}) +- [ICDAR13/15]({{< relref "/docs/manual/advanced/formats/format-icdar" >}}) diff --git a/site/content/en/docs/contributing/running-tests.md b/site/content/en/docs/contributing/running-tests.md index 1a3434b8f00c..38be631bd9c2 100644 --- a/site/content/en/docs/contributing/running-tests.md +++ b/site/content/en/docs/contributing/running-tests.md @@ -46,7 +46,7 @@ yarn run cypress:run:chrome:canvas3d **Initial steps** -1. Follow [this guide](/docs/api_sdk/sdk/developer-guide/) to prepare +1. Follow [this guide]({{< relref "/docs/api_sdk/sdk/developer-guide" >}}) to prepare `cvat-sdk` and `cvat-cli` source code 1. Install all necessary requirements before running REST API tests: ``` diff --git a/site/content/en/docs/contributing/setup-additional-components.md b/site/content/en/docs/contributing/setup-additional-components.md index d425fcfc9927..19d4495e52d2 100644 --- a/site/content/en/docs/contributing/setup-additional-components.md +++ b/site/content/en/docs/contributing/setup-additional-components.md @@ -7,7 +7,7 @@ description: 'Deploying a DL model as a serverless function and Cypress tests.' ## DL models as serverless functions -Follow this [guide](/docs/administration/advanced/installation_automatic_annotation/) to install Nuclio: +Follow this [guide]({{< relref "/docs/administration/advanced/installation_automatic_annotation" >}}) to install Nuclio: - You have to install `nuctl` command line tool to build and deploy serverless functions. diff --git a/site/content/en/docs/enterprise/shapes-converter.md b/site/content/en/docs/enterprise/shapes-converter.md index 69763a76f032..11dcce6affc7 100644 --- a/site/content/en/docs/enterprise/shapes-converter.md +++ b/site/content/en/docs/enterprise/shapes-converter.md @@ -64,7 +64,7 @@ To convert shapes, do the following: ![](/images/shapes-converter-annotated-dataset.jpg) -2. Set up [filters](/docs/manual/advanced/filter/). +2. Set up [filters]({{< relref "/docs/manual/advanced/filter" >}}). ![](/images/shapes-converter-setup-filter.png) diff --git a/site/content/en/docs/faq.md b/site/content/en/docs/faq.md index fdccd161ff31..5094ab589e87 100644 --- a/site/content/en/docs/faq.md +++ b/site/content/en/docs/faq.md @@ -9,12 +9,12 @@ description: 'Answers to frequently asked questions' ## How to migrate data from CVAT.org to CVAT.ai -Please follow the [export tasks and projects guide](/docs/manual/advanced/backup/#backup) to +Please follow the [export tasks and projects guide]({{< relref "/docs/manual/advanced/backup#backup" >}}) to download an archive with data which corresponds to your task or project. The backup for a project will have all tasks which are inside the project. Thus you don't need to export them separately. -Please follow the [import tasks and projects guide](/docs/manual/advanced/backup/#create-from-backup) +Please follow the [import tasks and projects guide]({{< relref "/docs/manual/advanced/backup#create-from-backup" >}}) to upload your backup with a task or project to a CVAT instance. See a quick demo below. It is really a simple process. If your data is huge, it may take some time. @@ -26,10 +26,10 @@ Please be patient. ## How to upgrade CVAT -Before upgrading, please follow the [backup guide](/docs/administration/advanced/backup_guide/) +Before upgrading, please follow the [backup guide]({{< relref "/docs/administration/advanced/backup_guide" >}}) and backup all CVAT volumes. -Follow the [upgrade guide](/docs/administration/advanced/upgrade_guide/). +Follow the [upgrade guide]({{< relref "/docs/administration/advanced/upgrade_guide" >}}). ## How to change default CVAT hostname or port @@ -113,14 +113,14 @@ volumes: ## How to mark job/task as completed -The status is set by the user in the [Info window](/docs/manual/basics/top-panel/#info) +The status is set by the user in the [Info window]({{< relref "/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/administration/basics/installation/#windows-10). +Follow this [guide]({{< relref "/docs/administration/basics/installation#windows-10" >}}). ## I do not have the Analytics tab on the header section. How can I add analytics @@ -151,16 +151,16 @@ To do this, you will need to edit `traefik.http..cvat.rule` docker label ## 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/manual/basics/creating_an_annotation_task/#advanced-configuration) +[Advanced configuration]({{< relref "/docs/manual/basics/creating_an_annotation_task#advanced-configuration" >}}) section. ## How to transfer CVAT to another machine -Follow the [backup/restore guide](/docs/administration/advanced/backup_guide/#how-to-backup-all-cvat-data). +Follow the [backup/restore guide]({{< relref "/docs/administration/advanced/backup_guide#how-to-backup-all-cvat-data" >}}). ## How to load your own DL model into CVAT -See the information here in the [Serverless tutorial](/docs/manual/advanced/serverless-tutorial/#adding-your-own-dl-models). +See the information here in the [Serverless tutorial]({{< relref "/docs/manual/advanced/serverless-tutorial#adding-your-own-dl-models" >}}). ## My server uses a custom SSL certificate and I don't want to check it. diff --git a/site/content/en/docs/getting_started/overview.md b/site/content/en/docs/getting_started/overview.md index 16052001d809..bda68e42b48b 100644 --- a/site/content/en/docs/getting_started/overview.md +++ b/site/content/en/docs/getting_started/overview.md @@ -21,7 +21,7 @@ CVAT offers three versions: **available for free**. You can also choose a [**subscription**](https://www.cvat.ai/pricing/cloud) for **unlimited data**, **collaboration**, **auto-annotations**, and [**more**](https://www.cvat.ai/post/cvat-ai-pricing-plans-choosing-the-right-plan-for-your-needs). -- **Self-hosted CVAT Community Edition**: Follow the [**Self-hosted Installation Guide**](/docs/administration/basics/installation/) +- **Self-hosted CVAT Community Edition**: Follow the [**Self-hosted Installation Guide**]({{< relref "/docs/administration/basics/installation" >}}) for setup. - **Self-hosted CVAT Enterprise Edition**: We provide [**Enterprise-level support**](https://www.cvat.ai/pricing/on-prem) @@ -61,7 +61,7 @@ CVAT's supports the following formats: - **For video**: all formats, supported by ffmpeg, including `MP4`, `AVI`, and `MOV`. For annotation export and import formats, see -[**Export annotations and data from CVAT**](/docs/manual/advanced/formats/) +[**Export annotations and data from CVAT**]({{< relref "/docs/manual/advanced/formats" >}}) ### Annotation tools @@ -72,16 +72,16 @@ image and video labeling: | Annotation Tool | Use Cases | | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | -| [**3D Object Annotation**](/docs/manual/advanced/3d-object-annotation-advanced/) | Ideal for projects that require depth perception and volume estimation, like autonomous vehicle training. | -| [**Attribute Annotation Mode**](/docs/manual/advanced/attribute-annotation-mode-advanced/) | Useful for adding detailed information to objects, like color, size, or other specific characteristics. | -| [**Annotation with Rectangles**](/docs/manual/advanced/annotation-with-rectangles/) | Best for simple object detection where objects have a box-like shape, such as detecting windows in a building. | -| [**Annotation with Polygons**](/docs/manual/advanced/annotation-with-polygons/) | Suited for complex shapes in images, like outlining geographical features in maps or detailed product shapes. | -| [**Annotation with Polylines**](/docs/manual/advanced/annotation-with-polylines/) | Great for annotating linear objects like roads, pathways, or limbs in pose estimation. | -| [**Annotation with Ellipses**](/docs/manual/advanced/annotation-with-ellipses/) | Ideal for objects like plates, balls, or eyes, where a circular or oval annotation is needed. | -| [**Annotation with Cuboids**](/docs/manual/advanced/annotation-with-cuboids/) | Useful for 3D objects in 2D images, like boxes or furniture in room layouts. | -| [**Annotation with Skeletons**](/docs/manual/advanced/skeletons/) | Ideal for human pose estimation, animation, and movement analysis in sports or medical fields. | -| [**Annotation with Brush Tool**](/docs/manual/advanced/annotation-with-brush-tool/) | Perfect for intricate and detailed annotations where precision is key, such as in medical imaging. | -| [**Annotation with Tags**](/docs/manual/advanced/annotation-with-tags/) | Useful for image and video classification tasks, like identifying scenes or themes in a dataset. | +| [**3D Object Annotation**]({{< relref "/docs/manual/advanced/3d-object-annotation-advanced" >}}) | Ideal for projects that require depth perception and volume estimation, like autonomous vehicle training. | +| [**Attribute Annotation Mode**]({{< relref "/docs/manual/advanced/attribute-annotation-mode-advanced" >}}) | Useful for adding detailed information to objects, like color, size, or other specific characteristics. | +| [**Annotation with Rectangles**]({{< relref "/docs/manual/advanced/annotation-with-rectangles" >}}) | Best for simple object detection where objects have a box-like shape, such as detecting windows in a building. | +| [**Annotation with Polygons**]({{< relref "/docs/manual/advanced/annotation-with-polygons" >}}) | Suited for complex shapes in images, like outlining geographical features in maps or detailed product shapes. | +| [**Annotation with Polylines**]({{< relref "/docs/manual/advanced/annotation-with-polylines" >}}) | Great for annotating linear objects like roads, pathways, or limbs in pose estimation. | +| [**Annotation with Ellipses**]({{< relref "/docs/manual/advanced/annotation-with-ellipses" >}}) | Ideal for objects like plates, balls, or eyes, where a circular or oval annotation is needed. | +| [**Annotation with Cuboids**]({{< relref "/docs/manual/advanced/annotation-with-cuboids" >}}) | Useful for 3D objects in 2D images, like boxes or furniture in room layouts. | +| [**Annotation with Skeletons**]({{< relref "/docs/manual/advanced/skeletons" >}}) | Ideal for human pose estimation, animation, and movement analysis in sports or medical fields. | +| [**Annotation with Brush Tool**]({{< relref "/docs/manual/advanced/annotation-with-brush-tool" >}}) | Perfect for intricate and detailed annotations where precision is key, such as in medical imaging. | +| [**Annotation with Tags**]({{< relref "/docs/manual/advanced/annotation-with-tags" >}}) | Useful for image and video classification tasks, like identifying scenes or themes in a dataset. | @@ -96,7 +96,7 @@ potentially speeding it up by up to 10 times. > **Note:** > For more information, -> see [**OpenCV and AI Tools**](/docs/manual/advanced/ai-tools/) +> see [**OpenCV and AI Tools**]({{< relref "/docs/manual/advanced/ai-tools" >}}) Below is a detailed table of the supported algorithms and the platforms they operate on: @@ -135,23 +135,23 @@ Start here if you're unsure where to begin with CVAT. | Name | Description | | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**User Manual**](/docs/manual/) | This comprehensive guide covers all CVAT tools available for work. It includes descriptions of all available tools, quality control methods, and procedures for importing and exporting data. This manual is relevant for both CVAT Cloud and Self-Hosted versions. | -| [**CVAT Complete Workflow Guide for Organizations**](/docs/getting_started/workflow-org/) | This guide provides a comprehensive overview of using CVAT for collaboration in organizations. | -| [**Subscription Management**](/docs/enterprise/subscription-managment/) | Learn how to [**choose a plan**](https://www.cvat.ai/post/cvat-ai-pricing-plans-choosing-the-right-plan-for-your-needs), subscribe, and manage your subscription effectively. | -| [**XML Annotation Format**](/docs/manual/advanced/xml_format/) | Detailed documentation on the XML format used for annotations in CVAT essential for understanding data structure and compatibility. | +| [**User Manual**]({{< relref "/docs/manual" >}}) | This comprehensive guide covers all CVAT tools available for work. It includes descriptions of all available tools, quality control methods, and procedures for importing and exporting data. This manual is relevant for both CVAT Cloud and Self-Hosted versions. | +| [**CVAT Complete Workflow Guide for Organizations**]({{< relref "/docs/getting_started/workflow-org" >}}) | This guide provides a comprehensive overview of using CVAT for collaboration in organizations. | +| [**Subscription Management**]({{< relref "/docs/enterprise/subscription-managment" >}}) | Learn how to [**choose a plan**](https://www.cvat.ai/post/cvat-ai-pricing-plans-choosing-the-right-plan-for-your-needs), subscribe, and manage your subscription effectively. | +| [**XML Annotation Format**]({{< relref "/docs/manual/advanced/xml_format" >}}) | Detailed documentation on the XML format used for annotations in CVAT essential for understanding data structure and compatibility. | ### Self-Hosted | Name | Description | | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**Self-hosted Installation Guide**](/docs/administration/basics/installation/) | Start here to install self-hosted solution on your premises. | +| [**Self-hosted Installation Guide**]({{< relref "/docs/administration/basics/installation" >}}) | Start here to install self-hosted solution on your premises. | | [**Dataset Management Framework**](https://github.com/cvat-ai/datumaro/blob/develop/README.md) | Specifically for the Self-Hosted version, this framework and CLI tool are essential for building, transforming, and analyzing datasets. | -| [**Server API**](/docs/api_sdk/api/) | The CVAT server offers a HTTP REST API for interactions. This section explains how client applications, whether they are command line tools, browsers, or scripts, interact with CVAT through HTTP requests and responses. | -| [**Python SDK**](/docs/api_sdk/sdk/) | The CVAT SDK is a Python library providing access to server interactions and additional functionalities like data validation and serialization. | -| [**Command Line Tool**](/docs/api_sdk/cli/) | This tool offers a straightforward command line interface for managing CVAT tasks. Currently featuring basic functionalities, it has the potential to develop into a more advanced administration tool for CVAT. | -| [**XML Annotation Format**](/docs/manual/advanced/xml_format/) | Detailed documentation on the XML format used for annotations in CVAT essential for understanding data structure and compatibility. | -| [**AWS Deployment Guide**](/docs/administration/basics/aws-deployment-guide/) | A step-by-step guide for deploying CVAT on Amazon Web Services, covering all necessary procedures and tips. | -| [**Frequently Asked Questions**](/docs/faq/) | This section addresses common queries and provides helpful answers and insights about using CVAT. | +| [**Server API**]({{< relref "/docs/api_sdk/api" >}}) | The CVAT server offers a HTTP REST API for interactions. This section explains how client applications, whether they are command line tools, browsers, or scripts, interact with CVAT through HTTP requests and responses. | +| [**Python SDK**]({{< relref "/docs/api_sdk/sdk" >}}) | The CVAT SDK is a Python library providing access to server interactions and additional functionalities like data validation and serialization. | +| [**Command Line Tool**]({{< relref "/docs/api_sdk/cli" >}}) | This tool offers a straightforward command line interface for managing CVAT tasks. Currently featuring basic functionalities, it has the potential to develop into a more advanced administration tool for CVAT. | +| [**XML Annotation Format**]({{< relref "/docs/manual/advanced/xml_format" >}}) | Detailed documentation on the XML format used for annotations in CVAT essential for understanding data structure and compatibility. | +| [**AWS Deployment Guide**]({{< relref "/docs/administration/basics/aws-deployment-guide" >}}) | A step-by-step guide for deploying CVAT on Amazon Web Services, covering all necessary procedures and tips. | +| [**Frequently Asked Questions**]({{< relref "/docs/faq" >}}) | This section addresses common queries and provides helpful answers and insights about using CVAT. | diff --git a/site/content/en/docs/getting_started/workflow-org.md b/site/content/en/docs/getting_started/workflow-org.md index 005d50b553b4..92cc522360da 100644 --- a/site/content/en/docs/getting_started/workflow-org.md +++ b/site/content/en/docs/getting_started/workflow-org.md @@ -29,28 +29,28 @@ The workflow diagram presents an overview of the general process at a high level To use CVAT within your organization, please follow these steps: -1. [Create an account in CVAT](/docs/manual/basics/registration/). -2. [Create **Organization**](/docs/manual/advanced/organization/). +1. [Create an account in CVAT]({{< relref "/docs/manual/basics/registration" >}}). +2. [Create **Organization**]({{< relref "/docs/manual/advanced/organization" >}}). 3. Switch to the **Organization** that you've - created and [subscribe to the **Team plan**](/docs/enterprise/subscription-managment/#team-plan). -4. [Invite members to **Organization**](/docs/manual/advanced/organization/#invite-members-into-organization) and - assign [User roles](/docs/manual/advanced/iam_user_roles/) to invited members. -5. [Create **Project**](/docs/manual/advanced/projects/). -6. (Optional) Attach [**Cloud storages**](/docs/manual/basics/attach-cloud-storage/) to the **Project**. -7. Create [**Task**](/docs/manual/basics/create_an_annotation_task/) or [ + created and [subscribe to the **Team plan**]({{< relref "/docs/enterprise/subscription-managment#team-plan" >}}). +4. [Invite members to **Organization**]({{< relref "/docs/manual/advanced/organization#invite-members-into-organization" >}}) and + assign [User roles]({{< relref "/docs/manual/advanced/iam_user_roles" >}}) to invited members. +5. [Create **Project**]({{< relref "/docs/manual/advanced/projects" >}}). +6. (Optional) Attach [**Cloud storages**]({{< relref "/docs/manual/basics/attach-cloud-storage" >}}) to the **Project**. +7. Create [**Task**]({{< relref "/docs/manual/basics/create_an_annotation_task" >}}) or [ **Multitask**](/docs/manual/basics/create-multi-tasks/).
At this step the CVAT platform will automatically create jobs. -8. (Optional) Create [**Ground truth job**](/docs/manual/advanced/analytics-and-monitoring/auto-qa/). +8. (Optional) Create [**Ground truth job**]({{< relref "/docs/manual/advanced/analytics-and-monitoring/auto-qa" >}}).
This step can be skipped if you're employing a manual QA approach. -9. (Optional) Add [**Instructions for annotators**](/docs/manual/advanced/specification/). -10. (Optional) Configure [**Webhooks**](/docs/administration/advanced/webhooks/). +9. (Optional) Add [**Instructions for annotators**]({{< relref "/docs/manual/advanced/specification" >}}). +10. (Optional) Configure [**Webhooks**]({{< relref "/docs/administration/advanced/webhooks" >}}). 11. Assign jobs to annotators by adding the annotator name to **Assignee** and changing the [**Job stage**](https://opencv.github.io/cvat/docs/manual/advanced/iam_user_roles/#job-stage) to **Annotation**. 12. Annotator will see assigned jobs and annotate them. 13. (Optional) In case you've created - a [**Ground truth job**](/docs/manual/advanced/analytics-and-monitoring/auto-qa/) + a [**Ground truth job**]({{< relref "/docs/manual/advanced/analytics-and-monitoring/auto-qa" >}}) give the CVAT platform some time to accumulate the data and check the accuracy of the annotation. 14. If you are using the manual validation, @@ -59,11 +59,11 @@ To use CVAT within your organization, please follow these steps: to **Validation**. 15. Validator will see assigned jobs and report issues.
Note, that validators can correct issues, - see [**Manual QA and Review**](/docs/manual/advanced/analytics-and-monitoring/manual-qa/) + see [**Manual QA and Review**]({{< relref "/docs/manual/advanced/analytics-and-monitoring/manual-qa" >}}) 16. Check issues and if there is a need for additional improvement, reassign jobs to either the Validator or Annotator. -17. (Optional) Check [**Analytics**](/docs/manual/advanced/analytics-and-monitoring/analytics-in-cloud/). -18. [**Export Data**](/docs/manual/advanced/formats/). +17. (Optional) Check [**Analytics**]({{< relref "/docs/manual/advanced/analytics-and-monitoring/analytics-in-cloud" >}}). +18. [**Export Data**]({{< relref "/docs/manual/advanced/formats" >}}). ## Complete Workflow Guide video tutorial diff --git a/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md b/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md index f040a0f0af8f..bf1ffcca0d6b 100644 --- a/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md +++ b/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md @@ -6,7 +6,7 @@ description: 'Overview of advanced operations available when annotating 3D objec --- As well as 2D-task objects, 3D-task objects support the ability to change appearance, attributes, -properties and have an action menu. Read more in [objects sidebar](/docs/manual/basics/objects-sidebar/) section. +properties and have an action menu. Read more in [objects sidebar]({{< relref "/docs/manual/basics/objects-sidebar" >}}) section. ## Moving an object diff --git a/site/content/en/docs/manual/advanced/ai-tools.md b/site/content/en/docs/manual/advanced/ai-tools.md index feab483e901d..4d68d283986a 100644 --- a/site/content/en/docs/manual/advanced/ai-tools.md +++ b/site/content/en/docs/manual/advanced/ai-tools.md @@ -7,7 +7,7 @@ description: 'Overview of semi-automatic and automatic annotation tools availabl Label and annotate your data in semi-automatic and automatic mode with the help of **AI** and **OpenCV** tools. -While [interpolation](/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons/) +While [interpolation]({{< relref "/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons" >}}) is good for annotation of the videos made by the security cameras, **AI** and **OpenCV** tools are good for both: videos where the camera is stable and videos, where it @@ -130,10 +130,10 @@ During the drawing process, you can remove the last point by clicking on it with ### Settings - On how to adjust the polygon, - see [Objects sidebar](/docs/manual/basics/objects-sidebar/#appearance). + see [Objects sidebar]({{< relref "/docs/manual/basics/objects-sidebar#appearance" >}}). - For more information about polygons in general, see - [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/). + [Annotation with polygons]({{< relref "/docs/manual/advanced/annotation-with-polygons" >}}). ### Interactors models @@ -193,7 +193,7 @@ To annotate with detectors, do the following: This action will automatically annotate one frame. For automatic annotation of multiple frames, -see [Automatic annotation](/docs/manual/advanced/automatic-annotation/). +see [Automatic annotation]({{< relref "/docs/manual/advanced/automatic-annotation" >}}). ### Detectors models diff --git a/site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md b/site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md index 99cc4df35891..0b4836a6aa4e 100644 --- a/site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md +++ b/site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md @@ -59,7 +59,7 @@ we need more samples to estimate quality reliably. To create a **Ground truth** job, do the following: -1. Create a [task](/docs/manual/basics/create_an_annotation_task/), and open the task page. +1. Create a [task]({{< relref "/docs/manual/basics/create_an_annotation_task" >}}), and open the task page. 2. Click **+**. ![Create job](/images/honeypot01.jpg) @@ -156,7 +156,7 @@ The Analytics page has the following fields: | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Mean annotation quality | Displays the average quality of annotations, which includes: the count of accurate annotations, total task annotations, ground truth annotations, accuracy rate, precision rate, and recall rate. | | GT Conflicts | Conflicts identified during quality assessment, including extra or missing annotations. Mouse over the **?** icon for a detailed conflict report on your dataset. | -| Issues | Number of [opened issues](/docs/manual/advanced/review/). If no issues were reported, will show 0. | +| Issues | Number of [opened issues]({{< relref "/docs/manual/advanced/review" >}}). If no issues were reported, will show 0. | | Quality report | Quality report in JSON format. | | Ground truth job data | "Information about ground truth job, including date, time, and number of issues. | | List of jobs | List of all the jobs in the task | diff --git a/site/content/en/docs/manual/advanced/analytics-and-monitoring/manual-qa.md b/site/content/en/docs/manual/advanced/analytics-and-monitoring/manual-qa.md index 05868b88dee6..5fad9e845445 100644 --- a/site/content/en/docs/manual/advanced/analytics-and-monitoring/manual-qa.md +++ b/site/content/en/docs/manual/advanced/analytics-and-monitoring/manual-qa.md @@ -48,7 +48,7 @@ To assign a reviewer to the job, do the following: 1. Log in to the Owner or Maintainer account. 2. (Optional) If the person you wish to assign as a reviewer is not a member of **Organization**, you - need to [Invite this person to the **Organization**](/docs/manual/advanced/organization/#invite-members-into-organization). + need to [Invite this person to the **Organization**]({{< relref "/docs/manual/advanced/organization#invite-members-into-organization" >}}). 3. Click on the **Assignee** field and select the reviewer. 4. From the **Stage** drop-down list, select **Validation**. @@ -96,7 +96,7 @@ To assign a corrector to the job, do the following: 1. Log in to the Owner or Maintainer account. 2. (Optional) If the person you wish to assign as a corrector is not a member of **Organization**, you - need to [Invite this person to the **Organization**](/docs/manual/advanced/organization/#invite-members-into-organization). + need to [Invite this person to the **Organization**]({{< relref "/docs/manual/advanced/organization#invite-members-into-organization" >}}). 3. Click on the **Assignee** field and select the reviewer. 4. From the **Stage** drop-down list, select **Annotation**. diff --git a/site/content/en/docs/manual/advanced/annotation-with-brush-tool.md b/site/content/en/docs/manual/advanced/annotation-with-brush-tool.md index a262ba5fc2e1..1a28b7d16a09 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-brush-tool.md +++ b/site/content/en/docs/manual/advanced/annotation-with-brush-tool.md @@ -10,7 +10,7 @@ such as a house hiding behind trees, a car behind a pedestrian, or a pillar behi traffic sign. The brush tool has several modes, for example: erase pixels, change brush shapes, and polygon-to-mask mode. -Use brush tool for Semantic (Panoptic) and Instance Image Segmentation tasks.
For more information about segmentation masks in CVAT, see [Creating masks](/docs/manual/advanced/annotation-with-polygons/creating-mask/). +Use brush tool for Semantic (Panoptic) and Instance Image Segmentation tasks.
For more information about segmentation masks in CVAT, see [Creating masks]({{< relref "/docs/manual/advanced/annotation-with-polygons/creating-mask" >}}). See: @@ -49,7 +49,7 @@ It has the following elements: To annotate with brush, do the following: -1. From the [controls sidebar](/docs/manual/basics/controls-sidebar/), select **Brush** ![Brush icon](/images/brushing_tools_icon.png). +1. From the [controls sidebar]({{< relref "/docs/manual/basics/controls-sidebar" >}}), select **Brush** ![Brush icon](/images/brushing_tools_icon.png). 2. In the **Draw new mask** menu, select label for your mask, and click **Shape**.
The **Brush**![Brush](/images/brushing_tools_icon.png) tool will be selected by default. ![BT context menu](/images/brushing_tools_context_menu.png) @@ -59,10 +59,10 @@ To annotate with brush, do the following: ![Brushing](/images/brushing_tools.gif) 4. After you applied the mask, on the top menu bar click **Save mask** ![Tick icon](/images/tick_icon.png)
to finish the process (or **N** on the keyboard). -5. Added object will appear on the [objects sidebar](/docs/manual/basics/objects-sidebar/). +5. Added object will appear on the [objects sidebar]({{< relref "/docs/manual/basics/objects-sidebar" >}}). To add the next object, repeat steps 1 to 5. -All added objects will be visible on the image and the [objects sidebar](/docs/manual/basics/objects-sidebar/). +All added objects will be visible on the image and the [objects sidebar]({{< relref "/docs/manual/basics/objects-sidebar" >}}). To save the job with all added objects, on the top menu click **Save** ![Save](/images/brushing_tools_save.png). @@ -72,7 +72,7 @@ To save the job with all added objects, on the top menu click **Save** ![Save](/ To annotate with polygon-to-mask, do the following: -1. From the [controls sidebar](/docs/manual/basics/controls-sidebar/), select **Brush** ![Brush icon](/images/brushing_tools_icon.png). +1. From the [controls sidebar]({{< relref "/docs/manual/basics/controls-sidebar" >}}), select **Brush** ![Brush icon](/images/brushing_tools_icon.png). 2. In the **Draw new mask** menu, select label for your mask, and click **Shape**. ![BT context menu](/images/brushing_tools_context_menu.png) @@ -84,11 +84,11 @@ To annotate with polygon-to-mask, do the following: ![Brushing](/images/brushing_tools_polygon.gif) 6. After you added the polygon selection, on the top menu bar click **Save mask** ![Tick icon](/images/tick_icon.png)
to finish the process (or **N** on the keyboard). -7. Click **Save mask** ![Tick icon](/images/tick_icon.png) again (or **N** on the keyboard).
The added object will appear on the [objects sidebar](/docs/manual/basics/objects-sidebar/). +7. Click **Save mask** ![Tick icon](/images/tick_icon.png) again (or **N** on the keyboard).
The added object will appear on the [objects sidebar]({{< relref "/docs/manual/basics/objects-sidebar" >}}). To add the next object, repeat steps 1 to 5. -All added objects will be visible on the image and the [objects sidebar](/docs/manual/basics/objects-sidebar/). +All added objects will be visible on the image and the [objects sidebar]({{< relref "/docs/manual/basics/objects-sidebar" >}}). To save the job with all added objects, on the top menu click **Save** ![Save](/images/brushing_tools_save.png). @@ -102,8 +102,8 @@ Use **Remove underlying pixels** tool when you want to add a mask and simultaneo ## AI Tools -You can convert [AI tool](/docs/manual/advanced/ai-tools/) masks to polygons. -To do this, use the following [AI tool](/docs/manual/advanced/ai-tools/) menu: +You can convert [AI tool]({{< relref "/docs/manual/advanced/ai-tools" >}}) masks to polygons. +To do this, use the following [AI tool]({{< relref "/docs/manual/advanced/ai-tools" >}}) menu: ![Save](/images/brushing_tool_ai.jpg) @@ -114,9 +114,9 @@ To do this, use the following [AI tool](/docs/manual/advanced/ai-tools/) menu: ## Import and export -For export, see [Export dataset](/docs/manual/advanced/export-import-datasets/) +For export, see [Export dataset]({{< relref "/docs/manual/advanced/export-import-datasets" >}}) -Import follows the general [import dataset](/docs/manual/advanced/export-import-datasets/) procedure, +Import follows the general [import dataset]({{< relref "/docs/manual/advanced/export-import-datasets" >}}) procedure, with the additional option of converting masks to polygons. >**Note:** This option is available for formats that work with masks only. diff --git a/site/content/en/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid.md b/site/content/en/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid.md index b1ebb09962ce..6ecdc3c8971a 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid.md +++ b/site/content/en/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid.md @@ -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/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/) +You can also use cuboids in track mode, similar to rectangles in track mode ([basics]({{< relref "/docs/manual/basics/track-mode-basics" >}}) and [advanced]({{< relref "/docs/manual/advanced/track-mode-advanced" >}})) or [Track mode with polygons]({{< relref "/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons" >}}) diff --git a/site/content/en/docs/manual/advanced/annotation-with-ellipses.md b/site/content/en/docs/manual/advanced/annotation-with-ellipses.md index 528fb2227542..61bbf380f34a 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-ellipses.md +++ b/site/content/en/docs/manual/advanced/annotation-with-ellipses.md @@ -12,14 +12,14 @@ First of all you need to select the `ellipse` on the controls sidebar. ![](/images/image239.jpg) Choose a `Label` and click `Shape` or `Track` to start drawing. An ellipse can be created the same way as -a [rectangle](/docs/manual/advanced/annotation-with-rectangles/), you need to specify two opposite points, +a [rectangle]({{< relref "/docs/manual/advanced/annotation-with-rectangles" >}}), you need to specify two opposite points, and the ellipse will be inscribed in an imaginary rectangle. Press `N` or click the `Done` button on the top panel to complete the shape. ![](/images/image240_mapillary_vistas.jpg) You can rotate ellipses using a rotation point in the same way as - [rectangles](/docs/manual/advanced/annotation-with-rectangles/#rotation-rectangle). + [rectangles]({{< relref "/docs/manual/advanced/annotation-with-rectangles#rotation-rectangle" >}}). ## Annotation with ellipses video tutorial diff --git a/site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md index 7ec1a13d0586..7827187f1f13 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md @@ -32,7 +32,7 @@ There are several formats in CVAT that can be used to export masks: - `CamVid` - `MOTS` - `ICDAR` -- `COCO` (RLE-encoded instance masks, [guide](/docs/manual/advanced/formats/format-coco)) +- `COCO` (RLE-encoded instance masks, [guide]({{< relref "/docs/manual/advanced/formats/format-coco" >}})) - `Datumaro` An example of exported masks (in the `Segmentation Mask` format): diff --git a/site/content/en/docs/manual/advanced/annotation-with-polygons/manual-drawing.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/manual-drawing.md index 5a5f2370c2cf..7b0ce0ea21fc 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-polygons/manual-drawing.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polygons/manual-drawing.md @@ -21,7 +21,7 @@ Before starting, you need to select `Polygon` on the controls sidebar and choose wheel) and move (when clicking the mouse wheel and moving the mouse), you can also delete the previous point by right-clicking on it. - You can use the `Selected opacity` slider in the `Objects sidebar` to change the opacity of the polygon. - You can read more in the [Objects sidebar](/docs/manual/basics/objects-sidebar/#appearance) section. + You can read more in the [Objects sidebar]({{< relref "/docs/manual/basics/objects-sidebar#appearance" >}}) section. - Press `N` again or click the `Done` button on the top panel for completing the shape. - After creating the polygon, you can move the points or delete them by right-clicking and selecting `Delete point` or clicking with pressed `Alt` key in the context menu. diff --git a/site/content/en/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons.md index 5a74c72d2e73..f0a45206a3ec 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons.md @@ -5,13 +5,13 @@ weight: 5 --- Polygons in the track mode allow you to mark moving objects more accurately other than using a rectangle -([Tracking mode (basic)](/docs/manual/basics/track-mode-basics/); [Tracking mode (advanced)](/docs/manual/advanced/track-mode-advanced/)). +([Tracking mode (basic)]({{< relref "/docs/manual/basics/track-mode-basics" >}}); [Tracking mode (advanced)]({{< relref "/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/manual/advanced/annotation-with-polygons/). +1. Create a polygon the same way as in the case of [Annotation with polygons]({{< relref "/docs/manual/advanced/annotation-with-polygons" >}}). Press `N` or click the `Done` button on the top panel 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/manual/advanced/annotation-with-rectangles.md b/site/content/en/docs/manual/advanced/annotation-with-rectangles.md index 01fa88c7b1c3..61664175207c 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-rectangles.md +++ b/site/content/en/docs/manual/advanced/annotation-with-rectangles.md @@ -5,10 +5,10 @@ weight: 7 --- To learn more about annotation using a rectangle, see the sections: -- [Shape mode (basics)](/docs/manual/basics/shape-mode-basics/) -- [Track mode (basics)](/docs/manual/basics/track-mode-basics/) -- [Shape mode (advanced)](/docs/manual/advanced/shape-mode-advanced/) -- [Track mode (advanced)](/docs/manual/advanced/track-mode-advanced/) +- [Shape mode (basics)]({{< relref "/docs/manual/basics/shape-mode-basics" >}}) +- [Track mode (basics)]({{< relref "/docs/manual/basics/track-mode-basics" >}}) +- [Shape mode (advanced)]({{< relref "/docs/manual/advanced/shape-mode-advanced" >}}) +- [Track mode (advanced)]({{< relref "/docs/manual/advanced/track-mode-advanced" >}}) ## Rotation rectangle diff --git a/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md b/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md index 2100451cd632..b316be7fce7b 100644 --- a/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md +++ b/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md @@ -5,7 +5,7 @@ weight: 6 description: 'Advanced operations available in attribute annotation mode.' --- -Basic operations in the mode were described in section [attribute annotation mode (basics)](/docs/manual/basics/attribute-annotation-mode-basics/). +Basic operations in the mode were described in section [attribute annotation mode (basics)]({{< relref "/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/manual/advanced/automatic-annotation.md b/site/content/en/docs/manual/advanced/automatic-annotation.md index 9f3c7955fad1..8d6fb75832e6 100644 --- a/site/content/en/docs/manual/advanced/automatic-annotation.md +++ b/site/content/en/docs/manual/advanced/automatic-annotation.md @@ -12,7 +12,7 @@ CVAT can use models from the following sources: - [Pre-installed models](#models). - Models integrated from [Hugging Face and Roboflow](#adding-models-from-hugging-face-and-roboflow). -- [Self-hosted models deployed with Nuclio](/docs/manual/advanced/serverless-tutorial/). +- [Self-hosted models deployed with Nuclio]({{< relref "/docs/manual/advanced/serverless-tutorial" >}}). The following table describes the available options: @@ -80,8 +80,8 @@ papers and official documentation. Automatic annotation uses pre-installed and added models. > For self-hosted solutions, -> you need to [install Automatic Annotation first](/docs/administration/advanced/installation_automatic_annotation/) -> and [add models](/docs/manual/advanced/models/). +> you need to [install Automatic Annotation first]({{< relref "/docs/administration/advanced/installation_automatic_annotation" >}}) +> and [add models]({{< relref "/docs/manual/advanced/models" >}}). List of pre-installed models: diff --git a/site/content/en/docs/manual/advanced/backup.md b/site/content/en/docs/manual/advanced/backup.md index d3a6f7d47e0e..3c0446235e53 100644 --- a/site/content/en/docs/manual/advanced/backup.md +++ b/site/content/en/docs/manual/advanced/backup.md @@ -15,7 +15,7 @@ To backup a task or project, open the action menu and select `Backup Task` or `B ![](/images/image219.jpg) -You can backup a project or a task locally on your PC or using an [attached cloud storage](/docs/manual/basics/attach-cloud-storage/). +You can backup a project or a task locally on your PC or using an [attached cloud storage]({{< relref "/docs/manual/basics/attach-cloud-storage" >}}). (Optional) Specify the name in the `Custom name` text field for backup, otherwise the file of backup name will be given by the mask `project__backup__