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.

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

[Enhancement] Add YOLOv8 OBB Models Directly to Zoo and Document #4238

Merged
merged 2 commits into from
Apr 6, 2024

Conversation

jacobmarks
Copy link
Contributor

@jacobmarks jacobmarks commented Apr 5, 2024

Recent community PR #4230 extended FiftyOne's Ultralytics integration to support oriented bounding box prediction models.

This PR adds those models directly to the FiftyOne Model Zoo, and documents these additions to the integration on the Ultralytics integration doc page.

(Please fill in changes proposed in this fix)

How is this patch tested? If it is not, please explain why.

(Details)

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • New Features
    • Added support for integrating Ultralytics YOLO oriented bounding box models with FiftyOne's apply_model() function.
    • Introduced the ability to load YOLOv8 oriented bounding box models from the FiftyOne Model Zoo, specifically tailored for drone imagery datasets like DOTA.
  • Refactor
    • Renamed FiftyOneYOLOOBBConfig to FiftyOneYOLOOBBModelConfig to better reflect its purpose in configuring YOLO object detection models.

@jacobmarks jacobmarks requested a review from brimoor April 5, 2024 23:33
Copy link
Contributor

coderabbitai bot commented Apr 5, 2024

Walkthrough

The update introduces direct support for Ultralytics YOLO oriented bounding box models in FiftyOne's apply_model() function, including the ability to load YOLOv8 oriented bounding box models from the FiftyOne Model Zoo. This enhancement is particularly noted for use with the DOTA dataset for drone imagery. Additionally, a class within the codebase has been renamed for clarity in configuring YOLO object detection models.

Changes

Files Change Summary
docs/source/integrations/ultralytics.rst Added documentation for YOLO oriented bounding box model support.
.../utils/ultralytics.py Renamed FiftyOneYOLOOBBConfig to FiftyOneYOLOOBBModelConfig.

Possibly related issues

Poem

In the code where rabbits hop,
A change was made, a gentle swap.
YOLO models, now embraced,
With bounding boxes, finely traced.
🐰 Through fields of data, wide and vast,
FiftyOne's vision, now recast.
A leap towards understanding, with every pass.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Apr 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.22%. Comparing base (fd624fa) to head (04344ae).
Report is 321 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff              @@
##           develop    #4238       +/-   ##
============================================
- Coverage    99.24%   28.22%   -71.02%     
============================================
  Files           35      814      +779     
  Lines        15236   101898    +86662     
  Branches         0     1215     +1215     
============================================
+ Hits         15121    28761    +13640     
- Misses         115    73137    +73022     
Flag Coverage Δ
app 15.73% <ø> (?)
python 99.24% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 4277d83 and 04344ae.
Files ignored due to path filters (1)
  • fiftyone/zoo/models/manifest-torch.json is excluded by !**/*.json
Files selected for processing (2)
  • docs/source/integrations/ultralytics.rst (1 hunks)
  • fiftyone/utils/ultralytics.py (2 hunks)
Additional comments not posted (2)
docs/source/integrations/ultralytics.rst (1)

244-293: The new documentation section on oriented bounding boxes (OBB) is clear and informative. It correctly explains how to use Ultralytics YOLO OBB models with FiftyOne, including loading models from the FiftyOne Model Zoo and applying them to datasets. The note about the DOTA dataset and the specific use case for bird's eye view images is particularly helpful for users.

fiftyone/utils/ultralytics.py (1)

437-443: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [440-506]

The renaming of FiftyOneYOLOOBBConfig to FiftyOneYOLOOBBModelConfig is consistent and aligns with the naming conventions used for other model configurations in FiftyOne. This change improves clarity and makes the purpose of the class more explicit.

Copy link
Contributor

@brimoor brimoor left a comment

Choose a reason for hiding this comment

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

LGTM!

@brimoor brimoor merged commit aff97ce into develop Apr 6, 2024
10 checks passed
@brimoor brimoor deleted the yolo-obb-inference branch April 6, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants