add warning for CelebA bbox data#9339
Conversation
Until [Issue 9008](pytorch#9008) is fixed, CelebA bbox data is broken, and a warning should be included so future people don't waste time trying to get the math correct to display the bboxes on the the faces.
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/9339
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
Hi @ribbon-otter! Thank you for your pull request and welcome to our community. Action RequiredIn 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. ProcessIn 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 If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
since I didn't get docs to build on my computer and IC seems to also not run. I plan on abandoning this pull request, unless someone has a suggestion for what I should do. |
|
@ribbon-otter Thanks a lot for your contribution! Your PR gets the docs built in preview mode. You can view the built docs by accessing the pytorch-bot comment: #9339 (comment) There is a link called “ Preview Python docs built from this PR” And you can go do the “Datasets” on the left and search the keyword “CelebA” to check the rendering. The issue was that the warning was written using Markdown syntax but TorchVision documentation requires reStructuredText (RST) format. Thus I will suggest that we can add a warning message in the correct format: - ``bbox`` (Tensor shape=(4,) dtype=int): bounding box (x, y, width, height)
.. warning::
These bounding box coordinates correspond to the original uncropped
CelebA images, not the cropped and aligned images returned by this
dataset. As a result, the coordinates will not match and may fall
outside the image boundaries.
See `Issue #9008 <https://github.com/pytorch/vision/issues/9008>`_ for
details and potential workarounds.Note: The indentation matters for RST - the Feel free to let us know if you have any questions. |
|
oh thank you so much for you help. My issue was that I underestimating how long it would take for the tests to run, and apparently misinterpreted their in progress status as an error. And thank you for telling me about RST. I had looked in the pytorch dev documentation but I didn't find any hints for what the formatting language was, and so guessed at markdown. Looking up what was common python documentation formats would have been a good idea. |
NicolasHug
left a comment
There was a problem hiding this comment.
Thanks a lot for the PR @ribbon-otter and @zy1git for the review
|
Hey @zy1git! You merged this PR, but no labels were added. |
Until Issue 9008 is fixed, CelebA bbox data is broken, and a warning should be included so future people don't waste time trying to get the math correct to display the bboxes on the the faces.
I struggled trying to build the documentation locally (
sphinx/config.pycomplains that there is no module named torchvision), so I plan on looking at the build artifact of the CI, to see if my formatting worked.