Skip to content

Commit

Permalink
Update UCF101 docstring (#4275)
Browse files Browse the repository at this point in the history
* Update UCF101 docstring

* addressing @NicolasHugs comments

* Fixed flake8 error

Co-authored-by: Prabhat Roy <prabhatroy@fb.com>
  • Loading branch information
bjuncek and prabhat00155 authored Aug 27, 2021
1 parent a3d9c41 commit 5ef75d7
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions torchvision/datasets/ucf101.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ class UCF101(VisionDataset):
UCF101 is an action recognition video dataset.
This dataset consider every video as a collection of video clips of fixed size, specified
by ``frames_per_clip``, where the step in frames between each clip is given by
``step_between_clips``.
``step_between_clips``. The dataset itself can be downloaded from the dataset website;
annotations that ``annotation_path`` should be pointing to can be downloaded from `here
<https://www.crcv.ucf.edu/data/UCF101/UCF101TrainTestSplits-RecognitionTask.zip>`.
To give an example, for 2 videos with 10 and 15 frames respectively, if ``frames_per_clip=5``
and ``step_between_clips=5``, the dataset size will be (2 + 3) = 5, where the first two
Expand All @@ -26,7 +28,8 @@ class UCF101(VisionDataset):
Args:
root (string): Root directory of the UCF101 Dataset.
annotation_path (str): path to the folder containing the split files
annotation_path (str): path to the folder containing the split files;
see docstring above for download instructions of these files
frames_per_clip (int): number of frames in a clip.
step_between_clips (int, optional): number of frames between each clip.
fold (int, optional): which fold to use. Should be between 1 and 3.
Expand Down

0 comments on commit 5ef75d7

Please sign in to comment.