From 9d62260ae0b4f270aa74e83b9680d45c5d215769 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gordon=20B=C3=B6er?= Date: Thu, 28 Nov 2024 13:39:39 +0100 Subject: [PATCH 1/3] Change docstrings and comments to 'YOLO 1.1' as an example format, instead of the non existent 'YOLO ZIP 1.0' --- cvat-cli/README.md | 2 +- cvat-cli/src/cvat_cli/_internal/commands.py | 4 ++-- cvat-sdk/cvat_sdk/core/proxies/jobs.py | 2 +- cvat-sdk/cvat_sdk/core/proxies/model_proxy.py | 2 +- cvat-sdk/cvat_sdk/core/proxies/projects.py | 2 +- cvat-sdk/cvat_sdk/core/proxies/tasks.py | 2 +- site/content/en/docs/api_sdk/cli/_index.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/cvat-cli/README.md b/cvat-cli/README.md index 71c19b79d908..7ac382b2a95e 100644 --- a/cvat-cli/README.md +++ b/cvat-cli/README.md @@ -11,7 +11,7 @@ Overview of functionality: - List all tasks (supports basic CSV or JSON output) - Download JPEG frames (supports a list of frame IDs) - Dump annotations (supports all formats via format string) -- Upload annotations for a task in the specified format (e.g. 'YOLO ZIP 1.0') +- Upload annotations for a task in the specified format (e.g. 'YOLO 1.1') - Export and download a whole task - Import a task diff --git a/cvat-cli/src/cvat_cli/_internal/commands.py b/cvat-cli/src/cvat_cli/_internal/commands.py index 324d427a64b8..73a2405920d9 100644 --- a/cvat-cli/src/cvat_cli/_internal/commands.py +++ b/cvat-cli/src/cvat_cli/_internal/commands.py @@ -295,7 +295,7 @@ def execute( class TaskDump: description = textwrap.dedent( """\ - Download annotations for a task in the specified format (e.g. 'YOLO ZIP 1.0'). + Download annotations for a task in the specified format (e.g. 'YOLO 1.1'). """ ) @@ -348,7 +348,7 @@ class TaskUpload: description = textwrap.dedent( """\ Upload annotations for a task in the specified format - (e.g. 'YOLO ZIP 1.0'). + (e.g. 'YOLO 1.1'). """ ) diff --git a/cvat-sdk/cvat_sdk/core/proxies/jobs.py b/cvat-sdk/cvat_sdk/core/proxies/jobs.py index 5eb3e6767477..4dde676179b7 100644 --- a/cvat-sdk/cvat_sdk/core/proxies/jobs.py +++ b/cvat-sdk/cvat_sdk/core/proxies/jobs.py @@ -53,7 +53,7 @@ def import_annotations( pbar: Optional[ProgressReporter] = None, ): """ - Upload annotations for a job in the specified format (e.g. 'YOLO ZIP 1.0'). + Upload annotations for a job in the specified format (e.g. 'YOLO 1.1'). """ filename = Path(filename) diff --git a/cvat-sdk/cvat_sdk/core/proxies/model_proxy.py b/cvat-sdk/cvat_sdk/core/proxies/model_proxy.py index 1557a61861ae..f1609909ff1b 100644 --- a/cvat-sdk/cvat_sdk/core/proxies/model_proxy.py +++ b/cvat-sdk/cvat_sdk/core/proxies/model_proxy.py @@ -300,7 +300,7 @@ def export_dataset( cloud_storage_id: Optional[int] = None, ) -> None: """ - Export a dataset in the specified format (e.g. 'YOLO ZIP 1.0'). + Export a dataset in the specified format (e.g. 'YOLO 1.1'). By default, a result file will be downloaded based on the default configuration. To force file downloading, pass `location=Location.LOCAL`. To save a file to a specific cloud storage, use the `location` and `cloud_storage_id` arguments. diff --git a/cvat-sdk/cvat_sdk/core/proxies/projects.py b/cvat-sdk/cvat_sdk/core/proxies/projects.py index 3e0eddc00e36..203a9d60fc85 100644 --- a/cvat-sdk/cvat_sdk/core/proxies/projects.py +++ b/cvat-sdk/cvat_sdk/core/proxies/projects.py @@ -52,7 +52,7 @@ def import_dataset( pbar: Optional[ProgressReporter] = None, ): """ - Import dataset for a project in the specified format (e.g. 'YOLO ZIP 1.0'). + Import dataset for a project in the specified format (e.g. 'YOLO 1.1'). """ filename = Path(filename) diff --git a/cvat-sdk/cvat_sdk/core/proxies/tasks.py b/cvat-sdk/cvat_sdk/core/proxies/tasks.py index e0db111f8511..33947ec7e9e8 100644 --- a/cvat-sdk/cvat_sdk/core/proxies/tasks.py +++ b/cvat-sdk/cvat_sdk/core/proxies/tasks.py @@ -168,7 +168,7 @@ def import_annotations( pbar: Optional[ProgressReporter] = None, ): """ - Upload annotations for a task in the specified format (e.g. 'YOLO ZIP 1.0'). + Upload annotations for a task in the specified format (e.g. 'YOLO 1.1'). """ filename = Path(filename) diff --git a/site/content/en/docs/api_sdk/cli/_index.md b/site/content/en/docs/api_sdk/cli/_index.md index 541e29f30611..9f0034a437ce 100644 --- a/site/content/en/docs/api_sdk/cli/_index.md +++ b/site/content/en/docs/api_sdk/cli/_index.md @@ -18,7 +18,7 @@ Overview of functionality: - List all tasks (supports basic CSV or JSON output) - Download JPEG frames (supports a list of frame IDs) - Dump annotations (supports all formats via format string) -- Upload annotations for a task in the specified format (e.g. 'YOLO ZIP 1.0') +- Upload annotations for a task in the specified format (e.g. 'YOLO 1.1') - Export and download a whole task - Import a task From 5171deb6d8d97e6dbb5a18b3e7959e3566f160a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gordon=20B=C3=B6er?= Date: Thu, 28 Nov 2024 14:42:22 +0100 Subject: [PATCH 2/3] [doc] fix clear spelling typos and mistakes --- site/content/en/docs/administration/advanced/analytics.md | 2 +- .../content/en/docs/administration/advanced/backup_guide.md | 2 +- .../en/docs/administration/advanced/custom_certificates.md | 2 +- site/content/en/docs/api_sdk/sdk/auto-annotation.md | 2 +- site/content/en/docs/api_sdk/sdk/developer-guide.md | 2 +- site/content/en/docs/api_sdk/sdk/pytorch-adapter.md | 2 +- site/content/en/docs/enterprise/shapes-converter.md | 2 +- .../en/docs/enterprise/social-accounts-configuration.md | 6 +++--- .../advanced/annotation-with-polygons/creating-mask.md | 2 +- site/content/en/docs/manual/advanced/contextual-images.md | 2 +- site/content/en/docs/manual/advanced/formats/format-coco.md | 2 +- site/content/en/docs/manual/advanced/single-shape.md | 2 +- .../basics/CVAT-annotation-Interface/controls-sidebar.md | 2 +- .../docs/manual/basics/CVAT-annotation-Interface/navbar.md | 2 +- site/content/en/docs/manual/basics/attach-cloud-storage.md | 6 +++--- .../en/docs/manual/basics/create_an_annotation_task.md | 2 +- site/content/en/docs/manual/basics/registration.md | 2 +- 17 files changed, 21 insertions(+), 21 deletions(-) diff --git a/site/content/en/docs/administration/advanced/analytics.md b/site/content/en/docs/administration/advanced/analytics.md index b99ca0a824c2..6d26e1a75cb3 100644 --- a/site/content/en/docs/administration/advanced/analytics.md +++ b/site/content/en/docs/administration/advanced/analytics.md @@ -69,7 +69,7 @@ docker compose up -d ### Ports settings If you cannot access analytics on -development environnement, +development environment, see {{< ilink "/docs/contributing/development-environment#cvat-analytics-ports" "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 2ebac212420d..9a33c4a0ebe3 100644 --- a/site/content/en/docs/administration/advanced/backup_guide.md +++ b/site/content/en/docs/administration/advanced/backup_guide.md @@ -20,7 +20,7 @@ Docker volumes are used to store all CVAT data: - `cvat_keys`: used to store the [Django secret key](https://docs.djangoproject.com/en/4.2/ref/settings/#std-setting-SECRET_KEY). Mounted into `cvat` container by `/home/django/keys` path. -- `cvat_logs`: used to store logs of CVAT backend processes managed by supervisord. +- `cvat_logs`: used to store logs of CVAT backend processes managed by supervisor. Mounted into `cvat` container by `/home/django/logs` path. - `cvat_events_db`: this volume is used to store Clickhouse database files. diff --git a/site/content/en/docs/administration/advanced/custom_certificates.md b/site/content/en/docs/administration/advanced/custom_certificates.md index 3ea9367974f9..780602a816f1 100644 --- a/site/content/en/docs/administration/advanced/custom_certificates.md +++ b/site/content/en/docs/administration/advanced/custom_certificates.md @@ -48,7 +48,7 @@ tls: keyFile: /certs/key.pem ``` -Edit the `docker-compose.https.yml` file and change the traefik servise configuration as follows: +Edit the `docker-compose.https.yml` file and change the traefik service configuration as follows: ```yaml traefik: 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 d8401955da7f..b50a680c7364 100644 --- a/site/content/en/docs/api_sdk/sdk/auto-annotation.md +++ b/site/content/en/docs/api_sdk/sdk/auto-annotation.md @@ -163,7 +163,7 @@ The same logic is used for sub-label IDs. ### Helper factory functions The CVAT API model types used in the AA function protocol are somewhat unwieldy to work with, -so it's recommented to use the helper factory functions provided by this layer. +so it's recommended to use the helper factory functions provided by this layer. These helpers instantiate an object of their corresponding model type, passing their arguments to the model constructor and sometimes setting some attributes to fixed values. diff --git a/site/content/en/docs/api_sdk/sdk/developer-guide.md b/site/content/en/docs/api_sdk/sdk/developer-guide.md index 65047488df34..67605b676c5a 100644 --- a/site/content/en/docs/api_sdk/sdk/developer-guide.md +++ b/site/content/en/docs/api_sdk/sdk/developer-guide.md @@ -124,7 +124,7 @@ usage patterns and simpler/faster ways to achieve results. default `/_`. - Server operations have different types for input and output values. - While it can be expected that an endopint with POST/PUT methods available + While it can be expected that an endpoint with POST/PUT methods available (like `create` or `partial_update`) has the same type for input and output (because it looks natural), it also leads to the situation, in which there are lots of read-/write-only fields, and it becomes hard for understanding. diff --git a/site/content/en/docs/api_sdk/sdk/pytorch-adapter.md b/site/content/en/docs/api_sdk/sdk/pytorch-adapter.md index 65dff955e4c6..57090e0c38d7 100644 --- a/site/content/en/docs/api_sdk/sdk/pytorch-adapter.md +++ b/site/content/en/docs/api_sdk/sdk/pytorch-adapter.md @@ -203,7 +203,7 @@ You can change this using the following constructor parameters: will be included. Both parameters can be set, -in which case tasks must fulfull both criteria to be included. +in which case tasks must fulfill both criteria to be included. ### Caching diff --git a/site/content/en/docs/enterprise/shapes-converter.md b/site/content/en/docs/enterprise/shapes-converter.md index fbceb757c3f1..43caf0e122eb 100644 --- a/site/content/en/docs/enterprise/shapes-converter.md +++ b/site/content/en/docs/enterprise/shapes-converter.md @@ -50,7 +50,7 @@ With the following fields: If unsaved changes are detected, a prompt will advise to save these changes to avoid any potential loss of data. -- **Disabу auto-save:** Prior to running the annotation action, disabling the auto-save feature +- **Disable auto-save:** Prior to running the annotation action, disabling the auto-save feature is advisable. A notification will suggest this action if auto-save is currently active. - **Committing changes:** Changes applied during the annotation session diff --git a/site/content/en/docs/enterprise/social-accounts-configuration.md b/site/content/en/docs/enterprise/social-accounts-configuration.md index 19e1a6b78367..b69726144f76 100644 --- a/site/content/en/docs/enterprise/social-accounts-configuration.md +++ b/site/content/en/docs/enterprise/social-accounts-configuration.md @@ -51,7 +51,7 @@ To enable authentication, do the following: configure: **Application name**, **Authorized JavaScript origins**, **Authorized redirect URIs**.
For example, if you plan to deploy CVAT instance on `https://localhost:8080`, add `https://localhost:8080` to authorized JS origins and `https://localhost:8080/api/auth/social/goolge/login/callback/` to redirect URIs. -8. Create conпiguration file in CVAT: +8. Create configuration file in CVAT: 1. Create the `auth_config.yml` file with the following content: @@ -81,7 +81,7 @@ There are 2 basic steps to enable GitHub account authentication.
For more information, see [Creating an OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) 3. Fill in the name field, set the homepage URL (for example: `https://localhost:8080`), and authentication callback URL (for example: `https://localhost:8080/api/auth/social/github/login/callback/`). -4. Create conпiguration file in CVAT: +4. Create configuration file in CVAT: 1. Create the `auth_config.yml` file with the following content: @@ -114,7 +114,7 @@ To enable authentication, do the following: see [Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) 2. Fill in the name field, set the homepage URL (for example: `https://localhost:8080`), and authentication callback URL (for example: `https://localhost:8080/api/auth/social/amazon-cognito/login/callback/`). -3. Create conпiguration file in CVAT: +3. Create configuration file in CVAT: 1. Create the `auth_config.yml` file with the following content: 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 047c10605a05..5920c1c76ec8 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 @@ -7,7 +7,7 @@ weight: 6 ### Cutting holes in polygons Currently, CVAT does not support cutting transparent holes in polygons. However, -it is poissble to generate holes in exported instance and class masks. +it is possible to generate holes in exported instance and class masks. To do this, one needs to define a background class in the task and draw holes with it as additional shapes above the shapes needed to have holes: diff --git a/site/content/en/docs/manual/advanced/contextual-images.md b/site/content/en/docs/manual/advanced/contextual-images.md index 4dcdf6d178ce..fb5eda39b52f 100644 --- a/site/content/en/docs/manual/advanced/contextual-images.md +++ b/site/content/en/docs/manual/advanced/contextual-images.md @@ -148,7 +148,7 @@ Each context image has the following elements: | 1 | **Full screen**. Click to expand the contextual image in to the full screen mode.

Click again to revert contextual image to windowed mode. | | 2 | **Move contextual image**. Hold and move contextual image to the other place on the screen.

![contex_images_3](/images/context_img_03.gif) | | 3 | **Name**. Unique contextual image name | -| 4 | **Select contextual image**. Click to open a horisontal listview of all available contextual images.

Click on one to select. | +| 4 | **Select contextual image**. Click to open a horizontal listview of all available contextual images.

Click on one to select. | | 5 | **Close**. Click to remove image from contextual images menu. | | 6 | **Extend** Hold and pull to extend the image. | diff --git a/site/content/en/docs/manual/advanced/formats/format-coco.md b/site/content/en/docs/manual/advanced/formats/format-coco.md index 4b467dff3f11..72193d440be5 100644 --- a/site/content/en/docs/manual/advanced/formats/format-coco.md +++ b/site/content/en/docs/manual/advanced/formats/format-coco.md @@ -57,7 +57,7 @@ such as `instances`, `panoptic`, `image_info`, `labels`, `captions`, or `stuff`. ## COCO import -Uplod format: a single unpacked `*.json` or a zip archive with the structure described above or +Upload format: a single unpacked `*.json` or a zip archive with the structure described above or [here](https://openvinotoolkit.github.io/datumaro/latest/docs/data-formats/formats/coco.html#import-coco-dataset) (without images). diff --git a/site/content/en/docs/manual/advanced/single-shape.md b/site/content/en/docs/manual/advanced/single-shape.md index e6d02c994976..78fea012f8a8 100644 --- a/site/content/en/docs/manual/advanced/single-shape.md +++ b/site/content/en/docs/manual/advanced/single-shape.md @@ -50,7 +50,7 @@ The **Single Shape** annotation mode has the following fields: | **Skip Button** | Enables moving to the next frame without annotating the current one, particularly useful when the frame does not have anything to be annotated. | | **List of Hints** | Offers guidance on using the interface effectively, including:
- Click **Skip** for frames without required annotations.
- Hold the **Alt** button to avoid unintentional drawing (e.g. when you want only move the image).
- Use the **Ctrl+Z** combination to undo the last action if needed.
- Use the **Esc** button to completely reset the current drawing progress. | | **Label selector** | Allows for the selection of different labels (`cat`, or `dog` in our example) for annotation within the interface. | -| **Label type selector** | A drop-down list to select type of the label (rectangle, ellipce, etc). Only visible when the type of the shape is **Any**. | +| **Label type selector** | A drop-down list to select type of the label (rectangle, ellipse, etc). Only visible when the type of the shape is **Any**. | | **Options to Enable or Disable** | Provides configurable options to streamline the annotation process, such as:
- **Automatically go to the next frame**.
- **Automatically save when finish**.
- **Navigate only empty frames**.
- **Predefined number of points** - Specific to polyshape annotations, enabling this option auto-completes a shape once a predefined number of points is reached. Otherwise, pressing **N** is required to finalize the shape. | | **Number of Points** | Applicable for polyshape annotations, indicating the number of points to use for image annotation. | diff --git a/site/content/en/docs/manual/basics/CVAT-annotation-Interface/controls-sidebar.md b/site/content/en/docs/manual/basics/CVAT-annotation-Interface/controls-sidebar.md index 07a7d957b47f..775ab3c5dbaa 100644 --- a/site/content/en/docs/manual/basics/CVAT-annotation-Interface/controls-sidebar.md +++ b/site/content/en/docs/manual/basics/CVAT-annotation-Interface/controls-sidebar.md @@ -10,7 +10,7 @@ description: 'Offers tools for navigating within the image, annotation tools, an **Navigation block** - contains tools for moving and rotating images. |Icon |Description | |-- |-- | -|![](/images/image148.jpg)|`Cursor` (`Esc`)- a basic annotation pedacting tool. | +|![](/images/image148.jpg)|`Cursor` (`Esc`)- a basic annotation editing tool. | |![](/images/image149.jpg)|`Move the image`- a tool for moving around the image without
the possibility of editing.| |![](/images/image102.jpg)|`Rotate`- two buttons to rotate the current frame
a clockwise (`Ctrl+R`) and anticlockwise (`Ctrl+Shift+R`).
You can enable `Rotate all images` in the settings to rotate all the images in the job| diff --git a/site/content/en/docs/manual/basics/CVAT-annotation-Interface/navbar.md b/site/content/en/docs/manual/basics/CVAT-annotation-Interface/navbar.md index 74a6af04120b..034f6b9aad3f 100644 --- a/site/content/en/docs/manual/basics/CVAT-annotation-Interface/navbar.md +++ b/site/content/en/docs/manual/basics/CVAT-annotation-Interface/navbar.md @@ -82,6 +82,6 @@ toggle between different annotation and QA modes. | **Fullscreen**

![Fullscreen](/images/image143.jpg) | The fullscreen player mode. The keyboard shortcut is **F11**.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | | **Info**

![Info](/images/image143_2.png)     | Open the job info.

![](/images/image144_detrac.png)

Overview:

  • **Assignee** - the individual to whom the job is assigned.
  • **Reviewer**– the user tasked with conducting the review. For more information, see [**Manual QA**](/docs/manual/advanced/analytics-and-monitoring/manual-qa")
  • **Start frame** - the number of the first frame in this job.
  • **Stop frame** - the number of the last frame in this job.
  • **Frames** - the total number of frames in the job.

**Annotations Statistics** table displays the number of created shapes, categorized by labels (e.g., vehicle, person) and the type of annotation (shape, track), as well as the count of manual and interpolated frames. | | **Filters**

![](/images/image143_3.png)   | Switches on [**Filters**](/docs/manual/advanced/filter/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | -| **Workplace Switcher** | The drop-down list to swithc between different annotation modes:

![](/images/ui-swithcer.png)

Overview:
  • **Standart** -- default mode.
  • **Attribute** -- annotation with [**Attributes**](docs/manual/advanced/attribute-annotation-mode-advanced/)
  • **Single Shape** -- [**Single shape**](/docs/manual/advanced/single-shape/) annotation mode.
  • **Tag annotation**- annotation with [Tags](/docs/manual/advanced/annotation-with-tags/)
  • **Review** -- [**Manual QA**](/manual/advanced/analytics-and-monitoring/manual-qa/) mode.                                                                                                                                                                               | +| **Workplace Switcher** | The drop-down list to switch between different annotation modes:

    ![](/images/ui-swithcer.png)

    Overview:
    • **Standard** -- default mode.
    • **Attribute** -- annotation with [**Attributes**](docs/manual/advanced/attribute-annotation-mode-advanced/)
    • **Single Shape** -- [**Single shape**](/docs/manual/advanced/single-shape/) annotation mode.
    • **Tag annotation**- annotation with [Tags](/docs/manual/advanced/annotation-with-tags/)
    • **Review** -- [**Manual QA**](/manual/advanced/analytics-and-monitoring/manual-qa/) mode.                                                                                                                                                                               | diff --git a/site/content/en/docs/manual/basics/attach-cloud-storage.md b/site/content/en/docs/manual/basics/attach-cloud-storage.md index 4bc3e14e8c16..075b9a2d1a71 100644 --- a/site/content/en/docs/manual/basics/attach-cloud-storage.md +++ b/site/content/en/docs/manual/basics/attach-cloud-storage.md @@ -159,7 +159,7 @@ aws s3 cp --recursive ``` 4. After copying the files, you can create a manifest file as described in - {{< ilink "/docs/manual/advanced/dataset_manifest" "preapair manifest file section" >}}: + {{< ilink "/docs/manual/advanced/dataset_manifest" "prepare manifest file section" >}}: ```bash python /utils/dataset_manifest/create.py --output-dir @@ -329,7 +329,7 @@ To create bucket, do the following: - **Storage account name**: to access container from CVAT. - Select a region closest to you. - - Select **Performance** > **Standart**. + - Select **Performance** > **Standard**. - Select **Local-redundancy storage (LRS)**. - Click **next: Advanced>**. @@ -387,7 +387,7 @@ Use the SAS token or connection string to grant secure access to the container. To configure the credentials: -1. Go to **Home** > **Resourse groups** > You resource name > Your storage account. +1. Go to **Home** > **Resource groups** > You resource name > Your storage account. 2. On the left menu, click **Shared access signature**. 3. Change the following fields: - **Allowed services**: Enable **Blob** . Disable all other fields. diff --git a/site/content/en/docs/manual/basics/create_an_annotation_task.md b/site/content/en/docs/manual/basics/create_an_annotation_task.md index b9501a110765..1e4c84a941f3 100644 --- a/site/content/en/docs/manual/basics/create_an_annotation_task.md +++ b/site/content/en/docs/manual/basics/create_an_annotation_task.md @@ -260,7 +260,7 @@ The following parameters are available: | Use zip/video chunks | Use this parameter to divide your video or image dataset for annotation into short video clips a zip file of frames.
      Zip files are larger but do not require decoding on the client side, and video clips are smaller but require decoding.
      It is recommended to turn off this parameter for video tasks to reduce traffic between the client side and the server. | | Use cache | Select checkbox, to enable _on-the-fly_ data processing to reduce task creation time and store data in a cache with a policy of
      evicting less popular items.

      For more information, see {{< ilink "/docs/manual/advanced/data_on_fly" "Data preparation on the fly" >}}. | | Image Quality | CVAT has two types of data: original quality and compressed. Original quality images are used for dataset export
      and automatic annotation. Compressed images are used only for annotations to reduce traffic between the server
      and client side.
      It is recommended to adjust the compression level only if the images contain small objects that are not
      visible in the original quality.
      Values range from `5` (highly compressed images) to `100` (not compressed | -| Overlap Size | Use this parameter to create overlapped segments, making tracking continuous from one segment to another.

      **Note** that this functionality only works for bounding boxes.

      This parameter has the following options:

      **Interpolation task** (video sequence). If you annotate with a bounding box on two adjacent segments, they will be
      merged into a single bounding box. In case the overlap is zero or the bounding box is inaccurate (not enclosing the object
      properly, misaligned or distorted) on the adjacent segments, it may be difficult to accurately interpole the object's
      movement between the segments. As a result, multiple tracks will be created for the same object.

      **Annotation task** (independent images). If an object exists on overlapped segments with overlap greater than zero,
      and the annotation of these segments is done properly, then the segments will be automatically merged into a single
      object. If the overlap is zero or the annotation is inaccurate (not enclosing the object properly, misaligned, distorted) on the
      adjacent segments, it may be difficult to accurately track the object. As a result, multiple bounding boxes will be
      created for the same object.

      If the annotations on different segments (on overlapped frames) are very different, you will have two shapes
      for the same object.

      To avoid this, accurately annotate the object on the first segment and the same object on the second segment to create a track
      between two annotations. | +| Overlap Size | Use this parameter to create overlapped segments, making tracking continuous from one segment to another.

      **Note** that this functionality only works for bounding boxes.

      This parameter has the following options:

      **Interpolation task** (video sequence). If you annotate with a bounding box on two adjacent segments, they will be
      merged into a single bounding box. In case the overlap is zero or the bounding box is inaccurate (not enclosing the object
      properly, misaligned or distorted) on the adjacent segments, it may be difficult to accurately interpolate the object's
      movement between the segments. As a result, multiple tracks will be created for the same object.

      **Annotation task** (independent images). If an object exists on overlapped segments with overlap greater than zero,
      and the annotation of these segments is done properly, then the segments will be automatically merged into a single
      object. If the overlap is zero or the annotation is inaccurate (not enclosing the object properly, misaligned, distorted) on the
      adjacent segments, it may be difficult to accurately track the object. As a result, multiple bounding boxes will be
      created for the same object.

      If the annotations on different segments (on overlapped frames) are very different, you will have two shapes
      for the same object.

      To avoid this, accurately annotate the object on the first segment and the same object on the second segment to create a track
      between two annotations. | | Segment size | Use this parameter to divide a dataset into smaller parts. For example, if you want to share a dataset among multiple
      annotators, you can split it into smaller sections and assign each section to a separate job.
      This allows annotators to work on the same dataset concurrently. | | Start frame | Defines the first frame of the video. | | Stop frame | Defines the last frame of the video. | diff --git a/site/content/en/docs/manual/basics/registration.md b/site/content/en/docs/manual/basics/registration.md index a56876d79554..8d3a282b1ae7 100644 --- a/site/content/en/docs/manual/basics/registration.md +++ b/site/content/en/docs/manual/basics/registration.md @@ -40,7 +40,7 @@ To register, do the following:
      A username generates from the email automatically. You can edit it if needed. -![Usernname generation](/images/filling_email.gif) +![Username generation](/images/filling_email.gif) ## User registration with social accounts From fe16be0e43b70e8a7b6d26087a3a7b5f131686c9 Mon Sep 17 00:00:00 2001 From: Maxim Zhiltsov Date: Wed, 11 Dec 2024 13:59:21 +0300 Subject: [PATCH 3/3] Update site/content/en/docs/administration/advanced/backup_guide.md --- site/content/en/docs/administration/advanced/backup_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/en/docs/administration/advanced/backup_guide.md b/site/content/en/docs/administration/advanced/backup_guide.md index 9a33c4a0ebe3..b773e5e24681 100644 --- a/site/content/en/docs/administration/advanced/backup_guide.md +++ b/site/content/en/docs/administration/advanced/backup_guide.md @@ -20,7 +20,7 @@ Docker volumes are used to store all CVAT data: - `cvat_keys`: used to store the [Django secret key](https://docs.djangoproject.com/en/4.2/ref/settings/#std-setting-SECRET_KEY). Mounted into `cvat` container by `/home/django/keys` path. -- `cvat_logs`: used to store logs of CVAT backend processes managed by supervisor. +- `cvat_logs`: used to store logs of CVAT backend processes managed by the supervisord service. Mounted into `cvat` container by `/home/django/logs` path. - `cvat_events_db`: this volume is used to store Clickhouse database files.