pytorch / pytorch/tutorials

💡 [REQUEST] - Making the tutorial more coherent

Open
#3,211 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

nlp
Dominant language
Python
Stars
9.3k
Forks
4.4k
Avg merge
1d 21h
Merged PRs (30d)
4

Description

🚀 Describe the improvement or the new tutorial

The 3-series tutorial set (linked in existing tutorial set) is disconnected in term of concepts being introduced and reused; like the

  • "Dataset" which is introduced in first tutorial but is not leveraged in next;
  • Intricate details like explanation of use of torch.LongTensor is skipped in part 2 (generating)

I wish to modify the tutorials content by:

  • adding a linear flow of concepts and then updating the code in follow up concepts such that the end-user is aware of what is different from last time.
  • Add details in explanation of what we are doing and why
  • Add pictures that reinforce what is we are doing and how is it related to big picture we wish to do.
Existing tutorials on this topic

Tutorials with the issue

Additional context

Hey,
I love tech-writing and wish to make tech adoption easier for all.

Bit of my works you can find.

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

Compare the three linked tutorials: char_rnn_classification_tutorial.html, char_rnn_generation_tutorial.html, and seq2seq_translation_tutorial.html. Trace which concepts are introduced and reused, including Dataset and torch.LongTensor, then define a coherent progression with explanatory text and pictures. Done means the tutorial set clearly connects each follow-up concept to the previous one.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.