[docs] torchvision.io.read_video docs do not (but should) specify image scale format
Open
Nobody has claimed this yet.
module: documentation
module: io
module: video
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
Is it int8, uint8, float32 from 0 to 1, -1/1? Is the format always same or input-file dependent? What happens for grayscale single-channel input videos? Will it still produce 3 channels?
cc @bjuncek
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the torchvision.io.read_video entry point and review how its returned video frames are described. Update the documentation to specify image scale and dtype, whether the format depends on the input file, and the channel behavior for grayscale videos; the issue is done when these cases are explicitly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-vision, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100