pytorch / pytorch/tutorials

Feedback about Optimizing Model Parameters Page

Open Beginner friendly
#3,507 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

There is the following issue on this page: https://docs.pytorch.org/tutorials/beginner/basics/optimization_tutorial.html

Within the section Full implementation, the loop does not contain the zero_grad function on top of the backward propagation block as is recommended in the paragraph preceding this section.

Actual code:

# Backpropagation
loss.backward()
optimizer.step()
optimizer.zero_grad()

Recommended code:

optimizer.zero_grad()
loss.backward()
optimizer.step()

If you could instruct me how to make this change on the documentation, I would be glad to do that.

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

Open the linked optimization tutorial and locate the “Full implementation” section. Update the example so optimizer.zero_grad() appears before loss.backward(), then verify the rendered code matches the recommendation in the preceding paragraph.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.