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

CVAT: Upload detection rotation attribute #5457

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

ehofesmann
Copy link
Member

@ehofesmann ehofesmann commented Feb 1, 2025

What changes are proposed in this pull request?

CVAT allows for annotating rotated bounding boxes. If a "rotation" attribute exists on a Detection in FiftyOne, then it should be uploaded to CVAT in a way to set the rotation of bounding boxes to that angle.

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

import fiftyone.zoo as foz
dataset = foz.load_zoo_dataset("quickstart")
sample = dataset.first()
sample.ground_truth.detections[0].rotation = 10.5
sample.ground_truth.detections[1].rotation = 70.0
sample.ground_truth.detections[2].rotation = 170.1
sample.save()

results = dataset[:1].annotate("test", label_field="ground_truth", launch_editor=True)
# See the rotation of the uploaded labels

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.

Updated the CVAT integration to support setting the rotation of bounding boxes uploaded to new tasks in CVAT from FiftyOne based on the rotation attribute of the detections in FiftyOne.

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
    • Enhanced the annotation system to support rotated bounding boxes, ensuring object detections accurately reflect object orientation.

Copy link
Contributor

coderabbitai bot commented Feb 1, 2025

Walkthrough

A new line has been added to the _create_detection_shapes method in the CVATShape class of the fiftyone/utils/cvat.py file. This modification introduces logic to check for a rotation attribute in each detection, applying a default value of 0.0 when the attribute is missing, thereby enabling rotated bounding boxes in CVAT annotations.

Changes

File Changes
fiftyone/.../cvat.py Added handling of the rotation attribute in the _create_detection_shapes method to support rotated bounding boxes.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant CVATShape
    participant Detection as "Detection Object"
    
    Caller->>CVATShape: call _create_detection_shapes(detections, ...)
    CVATShape->>Detection: Check for 'rotation' attribute
    alt Rotation exists
        Detection-->>CVATShape: Return rotation value
    else Rotation absent
        Detection-->>CVATShape: Use default rotation (0.0)
    end
    CVATShape-->>Caller: Return detection shape with rotation info
Loading

Poem

I'm a coding bunny on a hopping spree,
With twists and turns in boxes, you see!
Rotation now dances in each detection's heart,
Bringing art to code—a fresh new start.
Hop along with joy, let the changes impart!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@ehofesmann ehofesmann marked this pull request as ready for review February 1, 2025 18:01
@ehofesmann ehofesmann self-assigned this Feb 1, 2025
@ehofesmann ehofesmann added the annotation Issues related to FiftyOne's annotation API label Feb 1, 2025
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

🧹 Nitpick comments (1)
fiftyone/utils/cvat.py (1)

6444-6444: Approve rotation attribute support with a minor improvement suggestion

The addition of rotation attribute support for bounding boxes is good. However, the rotation value extraction can be written more concisely.

Apply this diff to simplify the rotation value extraction:

-                rotation = det["rotation"] if "rotation" in det else 0.0 or 0.0
+                rotation = det.get("rotation", 0.0)

The suggested change:

  • Uses the more idiomatic dict.get() method with a default value
  • Maintains the same functionality of defaulting to 0.0 for no rotation
  • Reduces code complexity

Also applies to: 6451-6451

🧰 Tools
🪛 Ruff (0.8.2)

6444-6444: Use det.get("rotation", 0.0 or 0.0) instead of an if block

Replace with det.get("rotation", 0.0 or 0.0)

(SIM401)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 847015e and fb90f43.

📒 Files selected for processing (1)
  • fiftyone/utils/cvat.py (1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
fiftyone/utils/cvat.py

6444-6444: Use det.get("rotation", 0.0 or 0.0) instead of an if block

Replace with det.get("rotation", 0.0 or 0.0)

(SIM401)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test / test-python (ubuntu-latest-m, 3.11)
  • GitHub Check: test / test-python (ubuntu-latest-m, 3.10)
  • GitHub Check: test / test-python (ubuntu-latest-m, 3.9)
  • GitHub Check: e2e / test-e2e
  • GitHub Check: build / build
  • GitHub Check: build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
annotation Issues related to FiftyOne's annotation API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant