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.

Sign up for GitHub

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

Jump to bottom

[DOC] Add docs for missing datasets #3536

Merged
merged 8 commits into from
Mar 12, 2021
Merged

[DOC] Add docs for missing datasets #3536

merged 8 commits into from
Mar 12, 2021

Conversation

oke-aditya
Copy link
Contributor

@oke-aditya oke-aditya commented Mar 9, 2021 •
edited
Loading

Fixes #3535 .

I think there are few indentation errors in docs as well.

  • Add docs for Caltech
  • Add docs for WIDERFace
  • Add docs for SEMION
  • Check Locally with Sphinx.

@oke-aditya oke-aditya changed the title Add docs for missing datasets [WIP][DOC] Add docs for missing datasets Mar 9, 2021
fmassa
fmassa reviewed Mar 10, 2021
View reviewed changes
Copy link
Member

@fmassa fmassa left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

FYI doc building is currently failing for WiderFace, can you have a look?

@oke-aditya
Copy link
Contributor Author

Ah yes. I'm having look. The section containing root is confusing Sphinx. I will fix it soon 😀

@pmeier
Copy link
Collaborator

pmeier commented Mar 10, 2021

Maybe try something like we did in Kinetics400

vision/torchvision/datasets/kinetics.py

Lines 26 to 37 in 797fd26

root (string): Root directory of the Kinetics-400 Dataset. Should be structured as follows:
.. code::
root/
├── class1
│ ├── clip1.avi
│ ├── clip2.avi
│ └── ...
└── class2
├── clipx.avi
└── ...

@oke-aditya oke-aditya changed the title [WIP][DOC] Add docs for missing datasets [DOC] Add docs for missing datasets Mar 10, 2021
@oke-aditya
Copy link
Contributor Author

oke-aditya commented Mar 10, 2021 •
edited
Loading

I fixed it like the above mentioned. It sadly shoes .. code in docs page. This happens even in Kinetics case.

Also, I don't have any workaround currently.

@oke-aditya oke-aditya requested a review from fmassa March 10, 2021 17:44
@oke-aditya oke-aditya requested a review from pmeier March 11, 2021 13:57
@oke-aditya
Copy link
Contributor Author

I hope everything looks fine now. I tested it locally and it looked well. Let me know if I miss something!

pmeier
pmeier approved these changes Mar 12, 2021
View reviewed changes
Copy link
Collaborator

@pmeier pmeier left a comment

Choose a reason for hiding this comment

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

LGTM, thanks a lot @oke-aditya!

@datumbox datumbox merged commit 0e80296 into pytorch:master Mar 12, 2021
@oke-aditya oke-aditya deleted the add_dset_docs branch March 12, 2021 15:18
facebook-github-bot pushed a commit that referenced this pull request Mar 18, 2021
@vincentqb @datumbox @facebook-github-bot
[fbsync] [DOC] Add docs for missing datasets (#3536)
68c1c22 
Summary:
* add missing docs

* tries fixing docs

* fixes docs

* fixes ..code

Reviewed By: fmassa

Differential Revision: D27127991

fbshipit-source-id: 305a1695d6339df5f10ed03df4f96dcc07cbecac

Co-authored-by: Vasilis Vryniotis <datumbox@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pmeier pmeier pmeier approved these changes

@fmassa fmassa Awaiting requested review from fmassa

Assignees
No one assigned
Labels
cla signed enhancement module: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing Documentation for few datasets
5 participants
@oke-aditya @pmeier @fmassa @datumbox @facebook-github-bot