meta-pytorch / meta-pytorch/data

Documentation Improvements Tracker

Open
#195 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

todo
Dominant language
Python
Stars
1.3k
Forks
179
Avg merge
6d 1h
Merged PRs (30d)
2

Description

Here are some improvements that we should make to the documentation. Some of these likely should be completed before beta release.

Crucial:

Nice-to-have:

  • Update issue form for documentation related issues
    https://github.com/pytorch/data/pull/215
  • Add links to domain usage examples onto individual DataPipe pages (see how TorchVision does this)
  • Remove tutorial from README.md and link it to the documentation tutorial
  • Make a functional equivalent table in documentation (in a separate page?)

cc: @VitalyFedyunin @ejguan @wenleix @dongreenberg @NivekT

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 by reviewing the remaining unchecked items: domain-example links on individual DataPipe pages and the functional-equivalent table. Check the existing documentation pages, README.md, and the TorchVision approach referenced in the issue. Done means both documentation improvements are added and the relevant documentation builds or renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
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.