KEMBAR78
Removes confusing note, addresses #38006 by janeyx99 · Pull Request #137535 · pytorch/pytorch · GitHub
Skip to content

Conversation

@janeyx99
Copy link
Contributor

@janeyx99 janeyx99 commented Oct 8, 2024

Fixes #38006

The note was originally added in #30257, which tried to ensure that the gradient wasn't modified in the optimizer. This note creates more confusion than is helpful, so removing it is better than leaving it in, especially because most uses of closure that I know does modify the grads.

Stack from ghstack (oldest at bottom):

@janeyx99 janeyx99 requested a review from albanD as a code owner October 8, 2024 21:40
@pytorch-bot
Copy link

pytorch-bot bot commented Oct 8, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/137535

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 8479065 with merge base 76ab1ab (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

janeyx99 added a commit that referenced this pull request Oct 8, 2024
ghstack-source-id: 0be7d73
Pull Request resolved: #137535
@janeyx99 janeyx99 added the topic: docs topic category label Oct 8, 2024
@janeyx99
Copy link
Contributor Author

janeyx99 commented Oct 8, 2024

@pytorchbot merge

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Oct 8, 2024
@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@janeyx99 janeyx99 linked an issue Oct 8, 2024 that may be closed by this pull request
@github-actions github-actions bot deleted the gh/janeyx99/191/head branch November 9, 2024 02:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ciflow/trunk Trigger trunk jobs on your pull request Merged release notes: optim topic: docs topic category

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Inconsistent Documentation about Optimizer.step(closure)

3 participants