Fix retain_grad() documentation for leaf vs non-leaf tensors #3657
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation incorrectly stated that calling retain_grad() on a non-leaf node results in a no-op. This is misleading because: - retain_grad() on a non-leaf tensor with requires_grad=True correctly retains gradients (not a no-op) - retain_grad() on a leaf tensor is a no-op (already retains by default) - retain_grad() on a tensor with requires_grad=False throws an error Updated the documentation and summary table to accurately reflect this behavior.
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3657
Note: Links to docs will display an error until the docs builds have been completed. ❗ 1 Active SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below: ✅ No FailuresAs of commit 744741c with merge base bc79723 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
Contributor
|
cc: @j-silv |
svekars
added
the
core
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation incorrectly stated that calling retain_grad() on a non-leaf node results in a no-op. This is misleading because:
Updated the documentation and summary table to accurately reflect this behavior.
Fixes #3652
Description
Checklist
cc @jbschlosser