Uh oh!
There was an error while loading. Please reload this page.
fix(contrib): correct momo and momo_adam docstring examples to use apply_updates - #1745
Open
wahid18-maqs wants to merge 2 commits into
Open
fix(contrib): correct momo and momo_adam docstring examples to use apply_updates#1745wahid18-maqs wants to merge 2 commits into
wahid18-maqs wants to merge 2 commits into
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
Sign up for freeto 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
This PR corrects the usage examples in the
momo()andmomo_adam()docstrings to follow the standard Optax optimizer update pattern and adds doctest coverage to keep the examples executable.Changes
momo()andmomo_adam()docstring examples to:updatesfromsolver.update(...),optax.apply_updates(...), andoptax/contrib/_momo_test.pyto execute the examples as part of the test suite.Why
The previous examples assigned the return value of
solver.update()directly toparams, even thoughupdate()returns(updates, state). Users copying the examples would end up treating updates as parameters, leading to incorrect optimization behavior.Adding doctest coverage also ensures the examples remain valid and synchronized with the implementation.
The doctest suite passes successfully