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

Add notes about BoundingBoxes transform utils in ops/boxes docstrings #8197

Merged
merged 7 commits into from
Jan 8, 2024

Conversation

bmmtstb
Copy link
Contributor

@bmmtstb bmmtstb commented Jan 4, 2024

Added documentation to multiple functions in torchvision.ops.boxes as proposed by #8190 .

Updated description of torchvision.ops.boxes.box_convert() to improve user interaction with the more up to date function `torchvision.transforms.v2.functional.convert_bounding_box_format`
Referenced v2 transforms for remove_small_boxes, clip_boxes_to_image, and box_area.
Copy link

pytorch-bot bot commented Jan 4, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/8197

Note: Links to docs will display an error until the docs builds have been completed.

✅ You can merge normally! (9 Unrelated Failures)

As of commit f100194 with merge base 71b27a0 (image):

FLAKY - The following jobs failed but were likely due to flakiness present on trunk:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot
Copy link

Hi @bmmtstb!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the PR @bmmtstb ! It looks great, I just made some minor comments below regarding formatting. LMK what you think

torchvision/ops/boxes.py Outdated Show resolved Hide resolved
torchvision/ops/boxes.py Outdated Show resolved Hide resolved
torchvision/ops/boxes.py Outdated Show resolved Hide resolved
torchvision/ops/boxes.py Outdated Show resolved Hide resolved
torchvision/ops/boxes.py Outdated Show resolved Hide resolved
torchvision/ops/boxes.py Outdated Show resolved Hide resolved
bmmtstb and others added 2 commits January 5, 2024 15:28
Co-authored-by: Nicolas Hug <contact@nicolas-hug.com>
@bmmtstb
Copy link
Contributor Author

bmmtstb commented Jan 5, 2024

I implemented the requested changes.

@bmmtstb bmmtstb requested a review from NicolasHug January 6, 2024 22:24
Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

Thanks a lot @bmmtstb !!

@NicolasHug NicolasHug changed the title Fix Issue 8190 Add notes about BoundingBoxes transform utils in ops/boxes docstrings Jan 8, 2024
@NicolasHug NicolasHug merged commit 2afb7fa into pytorch:main Jan 8, 2024
53 of 62 checks passed
@bmmtstb bmmtstb deleted the issue-8190 branch January 8, 2024 11:42
ahmadsharif1 pushed a commit to ahmadsharif1/vision that referenced this pull request Jan 8, 2024
facebook-github-bot pushed a commit that referenced this pull request Mar 19, 2024
…ocstrings (#8197)

Summary: Co-authored-by: Nicolas Hug <contact@nicolas-hug.com>

Reviewed By: vmoens

Differential Revision: D55062787

fbshipit-source-id: c0dec163f99f42114bb9d71e0ff4e2fb4a80e83e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants