-
Notifications
You must be signed in to change notification settings - Fork 7.1k
add docs for datapoints #7312
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 docs for datapoints #7312
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can easily review the structure later but the current docstrings LGTM
@NicolasHug sphinx fails to add cross links for Any idea how to get around that? |
for |
As discussed offline, this is a more general issue and not related to this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Philip
Hey @NicolasHug! You merged this PR, but no labels were added. The list of valid labels is available at https://github.com/pytorch/vision/blob/main/.github/process_commit.py |
Co-authored-by: Nicolas Hug <[email protected]>
Summary: Co-authored-by: Nicolas Hug <[email protected]> Reviewed By: vmoens Differential Revision: D44416598 fbshipit-source-id: 22edbeefe525cd728cc8a1de97e996f9c946b282
I only added the skeleton and added proper docstrings for
BoundingBox
andBoundingBoxFormat
. The other ones have just copy-pasted docstrings since sphinx wouldn't build without.Given that we are going to copy paste for all other datapoints, this can already be reviewed. I'll send proper docstrings for everything when we have reached consensus on what it should look like.