Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added mathematical description to AdaBelief docstring #869

Merged
merged 2 commits into from
Mar 16, 2024

Conversation

hmludwig
Copy link
Contributor

I took the Adam docstring and adjusted it to match the implementation of AdaBelief.

The resulting doc entry
Screenshot 2024-03-15 at 18 07 29

Copy link
Collaborator

@vroulet vroulet left a comment

Choose a reason for hiding this comment

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

That's perfect (just a tiny typo and I'll approve).
Thank you very much @hmludwig. Having simple docstrings like that to understand the algorithm mathematically in a few seconds is really great, in particular to understand how they all differ. So thank you very much! (and your docs are extremely well detailed :).

optax/_src/alias.py Outdated Show resolved Hide resolved
@copybara-service copybara-service bot merged commit 46d6d0b into google-deepmind:main Mar 16, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants