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

Start documentation for projections. #921

Merged
merged 2 commits into from
Apr 10, 2024

Conversation

mblondel
Copy link
Collaborator

@mblondel mblondel commented Apr 9, 2024

No description provided.

Copy link
Member

@fabianp fabianp left a comment

Choose a reason for hiding this comment

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

one minor suggestion, otherwise looks good to me


For instance, here is an example how we can project parameters to the non-negative orthant::

updates, opt_state = optimizer.update(grads, opt_state)
Copy link
Member

Choose a reason for hiding this comment

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

I suggest to make this a proper doctest (i.e., with lines that start with >>> and code that runs) so that i) users can copy-paste and ii) the code remains tested?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

Copy link
Member

@fabianp fabianp left a comment

Choose a reason for hiding this comment

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

thanks!

@copybara-service copybara-service bot merged commit 437d79c into google-deepmind:main Apr 10, 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