Skip to content

Commit bd06036

Browse files
zhangguanheng66fmassa
authored andcommitted
include intended structure of root directory in docstring of Kinetics400 (#3453)
Summary: * include intended structure of root directory in docstring of Kinetics400 * fix syntax Reviewed By: fmassa Differential Revision: D26756276 fbshipit-source-id: 5e94eaff792f4f0ee4e83867bd4d24db66c403e0 Co-authored-by: Francisco Massa <[email protected]>
1 parent a4f3f6d commit bd06036

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

torchvision/datasets/kinetics.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,18 @@ class Kinetics400(VisionDataset):
2323
Internally, it uses a VideoClips object to handle clip creation.
2424
2525
Args:
26-
root (string): Root directory of the Kinetics-400 Dataset.
26+
root (string): Root directory of the Kinetics-400 Dataset. Should be structured as follows:
27+
.. code::
28+
29+
root/
30+
├── class1
31+
│ ├── clip1.avi
32+
│ ├── clip2.avi
33+
│ └── ...
34+
└── class2
35+
├── clipx.avi
36+
└── ...
37+
2738
frames_per_clip (int): number of frames in a clip
2839
step_between_clips (int): number of frames between each clip
2940
transform (callable, optional): A function/transform that takes in a TxHxWxC video

0 commit comments

Comments
 (0)