Skip to content

Commit

Permalink
Change docstrings and comments to 'YOLO 1.1' as an example format, in…
Browse files Browse the repository at this point in the history
…stead of the non existent 'YOLO ZIP 1.0'
  • Loading branch information
Gordon Böer committed Nov 28, 2024
1 parent 9581b07 commit 9d62260
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion cvat-cli/README.md
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
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
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
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
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
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/api_sdk/cli/_index.md
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')
- Export and download a whole task
- Import a task

Expand Down

0 comments on commit 9d62260

Please sign in to comment.