Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Fix clear spelling mistakes and change docstrings and comments to 'YOLO 1.1' instead of the non-existing 'YOLO ZIP 1.0' #8754

Merged
merged 3 commits into from
Dec 11, 2024
Merged

[doc] Fix clear spelling mistakes and change docstrings and comments to 'YOLO 1.1' instead of the non-existing 'YOLO ZIP 1.0' #8754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d62260
Change docstrings and comments to 'YOLO 1.1' as an example format, in…
Nov 28, 2024
5171deb
[doc] fix clear spelling typos and mistakes
Nov 28, 2024
fe16be0
Update site/content/en/docs/administration/advanced/backup_guide.md
zhiltsov-max Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cvat-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions cvat-cli/src/cvat_cli/_internal/commands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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').
"""
)

Expand Down Expand Up @@ -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').
"""
)

Expand Down
2 changes: 1 addition & 1 deletion cvat-sdk/cvat_sdk/core/proxies/jobs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion cvat-sdk/cvat_sdk/core/proxies/model_proxy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion cvat-sdk/cvat_sdk/core/proxies/projects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion cvat-sdk/cvat_sdk/core/proxies/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/administration/advanced/analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/administration/advanced/backup_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 the supervisord service.
Mounted into `cvat` container by `/home/django/logs` path.

- `cvat_events_db`: this volume is used to store Clickhouse database files.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/administration/advanced/custom_certificates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/api_sdk/cli/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Found additional instances of YOLO ZIP 1.0 format that need to be updated

Several instances of YOLOv8 formats with version '1.0' were found in cvat/apps/dataset_manager/formats/yolo.py:

  • YOLOv8 Detection (both importer and exporter)
  • YOLOv8 Oriented Bounding Boxes (both importer and exporter)
  • YOLOv8 Segmentation (both importer and exporter)
  • YOLOv8 Pose (both importer and exporter)
  • YOLOv8 Classification (both importer and exporter)
🔗 Analysis chain

LGTM! Format string updated correctly.

The change from 'YOLO ZIP 1.0' to 'YOLO 1.1' aligns with the PR objectives and maintains consistency with other format strings in the documentation.

Let's verify if there are any remaining instances of the old format string in the codebase:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for any remaining instances of the old format string
# Expected: No occurrences of 'YOLO ZIP 1.0' should be found

echo "Searching for 'YOLO ZIP 1.0'..."
rg -i "YOLO ZIP 1.0"

echo "Searching for similar variations..."
rg -i "YOLO.*ZIP.*1\.0"

Length of output: 1272

- Export and download a whole task
- Import a task

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/api_sdk/sdk/auto-annotation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/api_sdk/sdk/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ usage patterns and simpler/faster ways to achieve results.
default `<api>/<object>_<method>`.

- 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.
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/api_sdk/sdk/pytorch-adapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/enterprise/shapes-converter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions site/content/en/docs/enterprise/social-accounts-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ To enable authentication, do the following:
configure: **Application name**, **Authorized JavaScript origins**, **Authorized redirect URIs**.
<br> 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:

Expand Down Expand Up @@ -81,7 +81,7 @@ There are 2 basic steps to enable GitHub account authentication.
<br>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:

Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/manual/advanced/annotation-with-polygons/creating-mask.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/manual/advanced/contextual-images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <p>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. <p>![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. <p>Click on one to select. |
| 4 | **Select contextual image**. Click to open a horizontal listview of all available contextual images. <p>Click on one to select. |
| 5 | **Close**. Click to remove image from contextual images menu. |
| 6 | **Extend** Hold and pull to extend the image. |

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/manual/advanced/formats/format-coco.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/manual/advanced/single-shape.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <br> - Click **Skip** for frames without required annotations. <br> - Hold the **Alt** button to avoid unintentional drawing (e.g. when you want only move the image). <br> - Use the **Ctrl+Z** combination to undo the last action if needed. <br> - 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: <br> - **Automatically go to the next frame**. <br> - **Automatically save when finish**. <br> - **Navigate only empty frames**. <br> - **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. |

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/manual/basics/CVAT-annotation-Interface/controls-sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br/> the possibility of editing.|
|![](/images/image102.jpg)|`Rotate`- two buttons to rotate the current frame<br/> a clockwise (`Ctrl+R`) and anticlockwise (`Ctrl+Shift+R`).<br/> You can enable `Rotate all images` in the settings to rotate all the images in the job|

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/manual/basics/CVAT-annotation-Interface/navbar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,6 @@ toggle between different annotation and QA modes.
| **Fullscreen**<br><br>![Fullscreen](/images/image143.jpg) | The fullscreen player mode. The keyboard shortcut is **F11**.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **Info**<br><br>![Info](/images/image143_2.png)     | Open the job info. <br><br>![](/images/image144_detrac.png)<br><br>Overview:<ul><li>**Assignee** - the individual to whom the job is assigned.</li> <li>**Reviewer**– the user tasked with conducting the review. For more information, see [**Manual QA**](/docs/manual/advanced/analytics-and-monitoring/manual-qa")</li><li>**Start frame** - the number of the first frame in this job.</li><li>**Stop frame** - the number of the last frame in this job.</li><li>**Frames** - the total number of frames in the job.</li></ul><br>**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**<br><br>![](/images/image143_3.png)   | Switches on [**Filters**](/docs/manual/advanced/filter/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| **Workplace Switcher** | The drop-down list to swithc between different annotation modes: <br><br>![](/images/ui-swithcer.png)<br><br>Overview:<ul><li>**Standart** -- default mode.</li><li>**Attribute** -- annotation with [**Attributes**](docs/manual/advanced/attribute-annotation-mode-advanced/)</li><li>**Single Shape** -- [**Single shape**](/docs/manual/advanced/single-shape/) annotation mode.</li><li>**Tag annotation**- annotation with [Tags](/docs/manual/advanced/annotation-with-tags/)</li><li>**Review** -- [**Manual QA**](/manual/advanced/analytics-and-monitoring/manual-qa/) mode.                                                                                                                                                                               |
| **Workplace Switcher** | The drop-down list to switch between different annotation modes: <br><br>![](/images/ui-swithcer.png)<br><br>Overview:<ul><li>**Standard** -- default mode.</li><li>**Attribute** -- annotation with [**Attributes**](docs/manual/advanced/attribute-annotation-mode-advanced/)</li><li>**Single Shape** -- [**Single shape**](/docs/manual/advanced/single-shape/) annotation mode.</li><li>**Tag annotation**- annotation with [Tags](/docs/manual/advanced/annotation-with-tags/)</li><li>**Review** -- [**Manual QA**](/manual/advanced/analytics-and-monitoring/manual-qa/) mode.                                                                                                                                                                               |

<!--lint enable maximum-line-length-->
6 changes: 3 additions & 3 deletions site/content/en/docs/manual/basics/attach-cloud-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ aws s3 cp <s3://bucket-name> <yourfolder> --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 <cvat repository>/utils/dataset_manifest/create.py --output-dir <yourfolder> <yourfolder>
Expand Down Expand Up @@ -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>**.

Expand Down Expand Up @@ -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.
Expand Down
Loading
Loading