Skip to content

include intended structure of root directory in docstring of Kinetics400 #3453

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
Mar 1, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion torchvision/datasets/kinetics.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,18 @@ class Kinetics400(VisionDataset):
Internally, it uses a VideoClips object to handle clip creation.

Args:
root (string): Root directory of the Kinetics-400 Dataset.
root (string): Root directory of the Kinetics-400 Dataset. Should be structured as follows:
.. code::

root/
├── class1
│ ├── clip1.avi
│ ├── clip2.avi
│ └── ...
└── class2
├── clipx.avi
└── ...

frames_per_clip (int): number of frames in a clip
step_between_clips (int): number of frames between each clip
transform (callable, optional): A function/transform that takes in a TxHxWxC video
Expand Down