pytorch / pytorch/vision

Consistent argument names for video datasets and VideoClips class

Open
#1,227 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted module: io module: video
Dominant language
Python
Stars
17.9k
Forks
7.3k
Avg merge
1d 15h
Merged PRs (30d)
13

Description

First of all, the new support for Video data is amazing. Really useful. 😃

Just when I was going through the code of the video datasets and utilities, I found this a bit confusing.

Sample Dataset:
https://github.com/pytorch/vision/blob/8635be94d1216f10fb8302da89233bd86445e449/torchvision/datasets/ucf101.py#L27-L36

VideoClips class:
https://github.com/pytorch/vision/blob/8635be94d1216f10fb8302da89233bd86445e449/torchvision/datasets/video_utils.py#L43-L49

From what I understand, the argument frames_per_clip from the dataset is the same as clip_length_in_frames from the VideoClips class.

Similarly, step_between_clips <-> frames_between_clips.

Is there a reason for this difference. Or did I understand it wrong?

Would it be better if both, the video datasets and the VideoClips class had consistent arguments?

In my opinion, frames_per_clip looks better than clip_length_in_frames.
And frames_between_clips can be favored over step_between_clips since the former feels more intuitive.

Any suggestions? @fmassa

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked argument definitions in torchvision/datasets/ucf101.py and torchvision/datasets/video_utils.py, then compare how the video datasets and VideoClips class name the same concepts. Decide on consistent names for clip length and spacing, and update the affected interfaces so the terminology matches across the video dataset utilities.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
computer-vision
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.