Skip to content

Fix #3186 - create leaf/non-leaf/requires_grad/retain_grad tutorial#3492

Merged
svekars merged 3 commits into
pytorch:mainfrom
j-silv:3186-leaf-nonleaf-tutorial
Sep 4, 2025
Merged

Fix #3186 - create leaf/non-leaf/requires_grad/retain_grad tutorial#3492
svekars merged 3 commits into
pytorch:mainfrom
j-silv:3186-leaf-nonleaf-tutorial

Conversation

@j-silv

@j-silv j-silv commented Jul 25, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

This was originally bundled with PR #3389, but now broken into two separate tutorials after discussing with PyTorch team.

Fixes #3186

Description

Add a tutorial which goes over the subtleties of leaf, non-leaf, and requires_grad vs. retain_grad

Link to preview is here (wait for docs to build it):

Checklist

  • The issue that is being fixed is referred in the description (see above "Fixes #ISSUE_NUMBER")
  • Only one issue is addressed in this pull request
  • Labels from the issue that this PR is fixing are added to this pull request
  • No unnecessary issues are included into this pull request.

@pytorch-bot

pytorch-bot Bot commented Jul 25, 2025 •
edited
Loading

Copy link
Copy Markdown

🔗 Helpful Links

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

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

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

@github-actions github-actions Bot added advanced docathon-h1-2025 A label for the docathon in H1 2025 hard hard label for docathon tutorial-proposal labels Jul 25, 2025
@j-silv j-silv force-pushed the 3186-leaf-nonleaf-tutorial branch from 14255e0 to e2e0d01 Compare July 25, 2025 02:35
@svekars

svekars commented Jul 25, 2025

Copy link
Copy Markdown
Contributor

cc: @soulitzer

@j-silv j-silv force-pushed the 3186-leaf-nonleaf-tutorial branch from e2e0d01 to 3c181eb Compare July 25, 2025 16:28
svekars
svekars reviewed Jul 28, 2025
View reviewed changes
Comment thread index.rst
@svekars

svekars commented Jul 28, 2025

Copy link
Copy Markdown
Contributor

Preview looks pretty good - make sure to add into a toctree since it'll be an orphan otherwise.

@soulitzer - do you mind taking a look?

@j-silv j-silv force-pushed the 3186-leaf-nonleaf-tutorial branch from 3c181eb to 8bac8c8 Compare July 28, 2025 21:19
@j-silv j-silv force-pushed the 3186-leaf-nonleaf-tutorial branch from 25d2fbc to 2771ab7 Compare August 6, 2025 19:14
@j-silv j-silv requested a review from svekars August 6, 2025 19:15
@soulitzer soulitzer self-requested a review August 14, 2025 22:02
soulitzer
soulitzer approved these changes Aug 14, 2025
View reviewed changes

@soulitzer soulitzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay, just got back from PTO.
This looks good to me, thanks for the great work!

@j-silv j-silv force-pushed the 3186-leaf-nonleaf-tutorial branch from df02633 to 3e24aee Compare August 21, 2025 03:05
@j-silv
Fix pytorch#3186 - create leaf/non-leaf/requires_grad/retain_grad tut…
8c1d9bf 
…orial

This was originally bundled with PR pytorch#3389, but now broken into two
separate tutorials after discussing with PyTorch team.
@j-silv j-silv force-pushed the 3186-leaf-nonleaf-tutorial branch from 3e24aee to 8c1d9bf Compare September 4, 2025 04:19
svekars
svekars approved these changes Sep 4, 2025
View reviewed changes

@svekars svekars left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thank you so much and sorry for the delay in reviewing.

@j-silv

j-silv commented Sep 4, 2025

Copy link
Copy Markdown
Contributor Author

Looks great! Thank you so much and sorry for the delay in reviewing.

No worries! I know everyone is super busy :)

@svekars

svekars commented Sep 4, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

The only suggestion for improvement (can be a separate PR) is to have diagrams to be in mermaid format so they are supported in both dark and light mode.

@svekars svekars merged commit 9c2a473 into pytorch:main Sep 4, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@soulitzer soulitzer soulitzer approved these changes
+1 more reviewer
@svekars svekars svekars approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

advanced cla signed docathon-h1-2025 A label for the docathon in H1 2025 hard hard label for docathon tutorial-proposal

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Writing a gradient tutorial, focused on leaf vs non leaf tensors.

4 participants

@j-silv @svekars @soulitzer @facebook-github-bot