Skip to content

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

Merged
merged 4 commits into from
Feb 24, 2023
Merged

add docs for datapoints #7312

merged 4 commits into from
Feb 24, 2023

Conversation

pmeier
Copy link
Collaborator

@pmeier pmeier commented Feb 23, 2023

I only added the skeleton and added proper docstrings for BoundingBox and BoundingBoxFormat. 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.

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.

We can easily review the structure later but the current docstrings LGTM

@pmeier
Copy link
Collaborator Author

pmeier commented Feb 24, 2023

@NicolasHug sphinx fails to add cross links for int and type in dtype (WTF?), leaving us with this mess:

Screenshot from 2023-02-24 10-10-05

Any idea how to get around that?

@NicolasHug
Copy link
Member

for int just use int instead of ints, for dtype I'll add it as a todo later

@pmeier pmeier marked this pull request as ready for review February 24, 2023 10:22
@pmeier
Copy link
Collaborator Author

pmeier commented Feb 24, 2023

for int just use int instead of ints,

Doesn't work 😞

Screenshot from 2023-02-24 11-27-47

@pmeier
Copy link
Collaborator Author

pmeier commented Feb 24, 2023

As discussed offline, this is a more general issue and not related to this PR.

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 Philip

@NicolasHug NicolasHug merged commit a376f79 into pytorch:main Feb 24, 2023
@github-actions
Copy link

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

@pmeier pmeier deleted the datapoint-doc branch February 24, 2023 12:15
NicolasHug added a commit to NicolasHug/vision that referenced this pull request Feb 24, 2023
facebook-github-bot pushed a commit that referenced this pull request Mar 30, 2023
Summary: Co-authored-by: Nicolas Hug <[email protected]>

Reviewed By: vmoens

Differential Revision: D44416598

fbshipit-source-id: 22edbeefe525cd728cc8a1de97e996f9c946b282
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