renaming yolov8 to ultralytics yolo #8863
Conversation
Eldies
requested review from
azhavoro,
zhiltsov-max and
Marishka17
as code owners
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis pull request introduces a comprehensive rebranding of YOLOv8 annotation formats to Ultralytics YOLO formats across multiple files in the Computer Vision Annotation Tool (CVAT). The changes involve renaming various annotation format references, updating documentation, modifying test cases, and adjusting dependencies. The modifications ensure consistent terminology and alignment with the latest naming conventions for YOLO formats. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
cvat/apps/dataset_manager/tests/test_formats.py (3)
Line range hint
414-414: Ultralytics YOLO Pose condition.
Line 414 includes a condition checking for'Ultralytics YOLO Pose 1.0'. Ensure the correct dimension (2D or otherwise) is tested for pose tasks.
Line range hint
472-472: Import condition for Pose.
Similar logic. Ensuring consistent dimension checks or specialized attribute checks for pose data is recommended.
Line range hint
849-849: Video dimension checks for Pose.
Same pattern of dimension checks. If future expansions are planned (e.g., 3D data), consider an extended format check here.docker-compose.dev.yml (1)
32-33: Consider making Python version configurable and reducing duplication.The volume mappings have two potential issues:
- The Python version (3.10) is hardcoded in the path, which could break if the Python version changes.
- The same volume mapping is repeated across multiple services.
Consider these improvements:
- Make Python version configurable:
- - ../datumaro/datumaro:/opt/venv/lib/python3.10/site-packages/datumaro + - ../datumaro/datumaro:/opt/venv/lib/python${PYTHON_VERSION}/site-packages/datumaro
- Use YAML anchors to reduce duplication:
x-datumaro-volume: &datumaro-volume - ../datumaro/datumaro:/opt/venv/lib/python${PYTHON_VERSION}/site-packages/datumaro services: cvat_server: volumes: - *datumaro-volume cvat_worker_export: volumes: - *datumaro-volume # ... other servicesAlso applies to: 46-47, 60-61
site/content/en/docs/manual/advanced/formats/format-yolo-ultralytics.md (1)
130-139: Enhance the import section with more details.The import section could benefit from additional information about:
- Required file naming conventions
- Supported annotation formats for each type (Detection, Segmentation, etc.)
- Validation rules for the annotations
site/content/en/docs/manual/advanced/formats/_index.md (1)
49-53: Consider expanding the models column for Ultralytics YOLO formats.The models column for Ultralytics YOLO formats only mentions YOLOv8. Consider listing other compatible models or frameworks that can work with these formats to provide users with more options.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
README.md(1 hunks)cvat/apps/dataset_manager/formats/yolo.py(2 hunks)cvat/apps/dataset_manager/tests/assets/annotations.json(5 hunks)cvat/apps/dataset_manager/tests/assets/tasks.json(1 hunks)cvat/apps/dataset_manager/tests/test_formats.py(3 hunks)cvat/apps/dataset_manager/tests/test_rest_api_formats.py(8 hunks)cvat/apps/engine/tests/test_rest_api.py(2 hunks)cvat/requirements/base.in(1 hunks)cvat/requirements/base.txt(1 hunks)docker-compose.dev.yml(3 hunks)site/content/en/docs/manual/advanced/formats/_index.md(1 hunks)site/content/en/docs/manual/advanced/formats/format-yolo-ultralytics-classification.md(1 hunks)site/content/en/docs/manual/advanced/formats/format-yolo-ultralytics.md(4 hunks)tests/python/rest_api/test_projects.py(2 hunks)tests/python/rest_api/test_tasks.py(2 hunks)
✅ Files skipped from review due to trivial changes (6)
- cvat/requirements/base.txt
- site/content/en/docs/manual/advanced/formats/format-yolo-ultralytics-classification.md
- tests/python/rest_api/test_projects.py
- cvat/apps/engine/tests/test_rest_api.py
- cvat/apps/dataset_manager/tests/assets/annotations.json
- tests/python/rest_api/test_tasks.py
🔇 Additional comments (21)
cvat/requirements/base.in (1)
15-15: Confirm the stability of the new commit reference.
This line pins datumaro to a new commit. Please ensure this commit is tested and stable, and consider referencing a release tag if available to reduce unforeseen breakage.
cvat/apps/dataset_manager/formats/yolo.py (10)
80-82: Consistent naming for detection exporter.
Renaming _export_yolo_ultralytics_detection aligns with new Ultralytics YOLO nomenclature. The structure is good; no functional issues are apparent.
85-87: Consistent naming for oriented bounding boxes exporter.
Similar approach as detection exporter. Ensures uniform naming convention across the codebase.
90-95: Segmentation exporter transformation check.
Applying dataset.transform('masks_to_polygons') before export is correct for polygon-based YOLO formats. Everything else looks consistent with the new naming.
100-102: Consistent naming for pose exporter.
Renamed function properly references Ultralytics YOLO for pose tasks. Looks good.
105-107: Consistent naming for classification exporter.
No logical issues. Follows the rebranding to Ultralytics YOLO.
110-112: Consistent naming for detection importer.
Properly mirrors the exporter naming for detection. No immediate concerns.
115-117: Consistent naming for segmentation importer.
No functional changes other than name alignment. Looks fine.
120-122: Consistent naming for oriented bounding boxes importer.
Mirrors the exporter naming. Implementation remains the same.
125-126: Pose importer skeleton handling.
These lines add the proper format name for Ultralytics YOLO Pose. The usage of skeleton_sub_labels for the downstream import appears correct.
Also applies to: 138-138
144-146: Consistent naming for classification importer.
No functional regressions detected. Reflects the new naming scheme.
cvat/apps/dataset_manager/tests/test_formats.py (7)
295-299: Updated export formats to Ultralytics YOLO.
These new entries replace the old YOLOv8 references. Ensure coverage in test scenarios that rely on the old names.
332-336: Updated import formats to Ultralytics YOLO.
Mirrors the export updates. Double-check any external references or docs to prevent mismatch.
386-390: Empty image export for Ultralytics YOLO.
This test block includes checks for empty tasks/images. Confirm that the new formats handle empty sets gracefully.
Line range hint 516-516: Pose tasks on videos.
Here, 'Ultralytics YOLO Pose 1.0' is again included for test coverage. Good practice to confirm the code handles track-based or frame-based pose data.
Line range hint 572-572: Import condition for Pose in Job-based tests.
Matches the approach used elsewhere. Continue verifying final coverage in job-level tests.
Line range hint 950-950: Ultralytics YOLO Pose fallback.
Ensure that transformations (like shape merges or mask expansions) are correct for pose tasks.
Line range hint 1061-1061: Additional reference to Ultralytics YOLO Pose
Retests the import/export integration. Keep an eye on potential multi-skeleton scenarios.
cvat/apps/dataset_manager/tests/test_rest_api_formats.py (1)
58-58: Renamed YOLOv8 entries to Ultralytics YOLO.
These changes reflect the rebranding. Ensure no references to YOLOv8 remain in related test data or documentation.
Also applies to: 60-63
README.md (1)
178-182: LGTM! Documentation links are valid.
The format names have been consistently updated from "YOLOv8" to "Ultralytics YOLO" while maintaining the same documentation links.
✅ Verification successful
Documentation links are valid and accessible
All Ultralytics documentation links return HTTP 200 status codes, confirming they are accessible and working correctly. The format name changes from "YOLOv8" to "Ultralytics YOLO" are properly documented with valid links.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the documentation links are accessible
# Test: Check if the Ultralytics documentation links are valid
for url in \
"https://docs.ultralytics.com/datasets/detect/" \
"https://docs.ultralytics.com/datasets/obb/" \
"https://docs.ultralytics.com/datasets/segment/" \
"https://docs.ultralytics.com/datasets/pose/" \
"https://docs.ultralytics.com/datasets/classify/"; do
curl -sL -w "%{http_code}" "$url" -o /dev/null
done
Length of output: 1708
cvat/apps/dataset_manager/tests/assets/tasks.json (1)
637-638: LGTM! Format name consistently updated.
The format name and task name have been properly updated to use "Ultralytics YOLO" while maintaining the same configuration structure.
✅ Verification successful
Format name consistency verified across the codebase
The search results confirm that the format name "Ultralytics YOLO" is consistently used throughout the codebase. The occurrences of "YOLOv8" in the documentation are appropriate as they refer to the underlying framework rather than the format name itself. The format names in code, tests, and configuration files all follow the standardized pattern of "Ultralytics YOLO [Type] 1.0".
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify format name consistency across the codebase
# Test: Check for any remaining references to "YOLOv8" that should have been updated
# Search for any remaining YOLOv8 references that might have been missed
rg -i "yolov8" --type py --type json --type md
# Search for the new format name to ensure consistent usage
rg -i "ultralytics.+yolo" --type py --type json --type md
Length of output: 16155
Eldies
force-pushed
the
dl/yolov8-renaming
branch
from
8a76a6d to
b866068
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #8863 +/- ##
===========================================
- Coverage 73.90% 73.89% -0.02%
===========================================
Files 408 408
Lines 44131 44131
Branches 3986 3986
===========================================
- Hits 32617 32612 -5
- Misses 11514 11519 +5
|
|
@Eldies, please resolve the conflict. |
# Conflicts: # site/content/en/docs/manual/advanced/formats/format-yolo-ultralytics.md
|
Motivation and context
depends on cvat-ai/datumaro#68
How has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit
Release Notes
New Features
Bug Fixes
Documentation
Chores
datumaropackage.