pytorch / pytorch/vision

Add new illustrations of transforms

Open
#3,688 10 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement module: documentation module: transforms
Dominant language
Python
Stars
17.9k
Forks
7.3k
Avg merge
1d 15h
Merged PRs (30d)
13

Description

With https://github.com/pytorch/vision/pull/3652 merged, we can now illustrate how each transforms affects an image via a sphinx-gallery example:

https://519065-73328905-gh.circle-artifacts.com/0/docs/auto_examples/plot_transforms.html#sphx-glr-auto-examples-plot-transforms-py

The goal of this issue is to add more transforms to this file: https://github.com/pytorch/vision/blob/master/gallery/plot_transforms.py

Instructions:

  • pick you favourite transform that isn't already present in the example (after checking below that no one is already working on it)
  • comment below "I'm working on <the transform>" so that others don't pick the same one
  • edit the example file with something that properly illustrate the transform, taking inspiration from the already present transforms
  • Build the docs following the instructions here, check that everything is fine, then submit a PR.

You can pick more than one transform in the same PR if you feel like it.

cc @vfdev-5

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 gallery/plot_transforms.py and compare the existing transform illustrations, then read the documentation build instructions in CONTRIBUTING.md. Choose a transform not already shown, add an appropriate illustration to the example, build the docs, and confirm the generated example renders correctly before submitting a PR.

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
Half a day
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.