pytorch/vision

VideoClips object needs documentation

Open

#1,582 opened on Nov 15, 2019

View on GitHub
 (5 comments) (2 reactions) (0 assignees)Python (6,858 forks)batch import
enhancementhelp wantedmodule: documentation

Repository metrics

Stars
 (15,050 stars)
PR merge metrics
 (Avg merge 12d 8h) (14 merged PRs in 30d)

Description

The recent 0.4.2 update on VideoClips seems to bring lots of new functionality with video_reader backend without many explanations.

I think VideoClips need documentation, it's a very useful tool. Thanks!

Contributor guide

Research direction
Review the VideoClips class source code and document its methods and parameters.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85