Fix typo in Part1 tutorial notebook - #349
Draft
rootkiller6788 wants to merge 1 commit into
Draft
Conversation
The MomentumOptimizer.update example populates the `momentums` field of MomentumOptState from `output_params` instead of `output_momentums`, so the returned state carries the updated parameters as its momentum. Use `output_momentums` to match the intended momentum update.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes a typo in the
MomentumOptimizerexample indocs/notebooks/Part1_Introduction.ipynb(issue #296).In the
updatemethod, theMomentumOptStateis constructed with:but it should use
output_momentums. As written, the returned optimizer state'smomentumsfield is populated with the updated parameters rather than the updated momentum accumulators, so the momentum update shown in the tutorial is silently incorrect (the notebook's own output confirms this:momentumsequalsparams).Change
One-line fix:
Testing
Verified the notebook still parses as valid JSON (nbformat 4, 40 cells). No runtime environment changes; the fix only corrects which accumulator list is passed to
tree_unflattenfor themomentumsfield.