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

[WIP] Dense Mask IoU #5283

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

[WIP] Dense Mask IoU #5283

wants to merge 3 commits into from

Conversation

mwoodson1
Copy link
Contributor

What changes are proposed in this pull request?

Now when calling fo.utils.iou.compute_ious(preds, gts, tolerance=None) with pixel masks, the IoU will be computed using pixels instead of converting to contours. This is especially needed when trying to evaluate segmentation models which typically use dense IoU as a metric instead of one computed on contours.

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

@mwoodson1 mwoodson1 self-assigned this Dec 16, 2024
Copy link
Contributor

coderabbitai bot commented Dec 16, 2024

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (3)
  • WIP
  • DO NOT MERGE
  • DRAFT

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@mwoodson1
Copy link
Contributor Author

@ehofesmann I know you mentioned there would be some edge cases regarding different pred and ground truth resolutions. Do you think my implementation covers this sufficiently? If not can you provide a small test case I can use?

@ehofesmann
Copy link
Member

@ehofesmann I know you mentioned there would be some edge cases regarding different pred and ground truth resolutions. Do you think my implementation covers this sufficiently? If not can you provide a small test case I can use?

Very nice work! I haven't run this myself, but I do believe that this todo would need to be addressed in order to support preds and gts with different resolutions. You could try to test it with something like:

gt_mask = np.zeros((90,90))
gt_mask[:60,:] = 1
pred_mask = np.zeros((50,50))
pred_mask[25:,:] = 1

gt = fo.Detection(bounding_box=[0.1,0.1,0.1,0.1], label="test", mask=gt_mask)
pred = fo.Detection(bounding_box=[0.1,0.1,0.1,0.1], label="test", mask=pred_mask)
fo.utils.iou._dense_iou(pred, gt) 

@mwoodson1
Copy link
Contributor Author

I'm not sure I understand the use case here. When do we have predictions and ground truths of different resolutions? And for the example you shared what is the expected behaviour

@ehofesmann
Copy link
Member

I'm not sure I understand the use case here. When do we have predictions and ground truths of different resolutions? And for the example you shared what is the expected behaviour

I could definitely imagine a case where the ground truth labels were annotated on higher res images than what a segmentation model results. And also that 2 segmentation models might have resulting masks of different resolutions and you want to compare one with the other.

For the example I would expect there to be an overlap of 1/6 (one mask covers the bottom 2/3 of a square image and the other mask the top 1/2)

@mwoodson1
Copy link
Contributor Author

Got it, this should be handled correctly now.

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.

Code LGTM from a static review standpoint.

Note: I haven't run this myself; relying on you for implementation correctness.

Just to double confirm: as @ehofesmann pointed out, FO does not enforce nor assume that the masks for each object have the same resolution, so the IoU implementations must gracefully handle two Detection instances whose masks are different sizes.

I added some documentation for this change here: 79080ff

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.

3 participants