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

add docs for tree_utils module #724

Merged
merged 5 commits into from
Jan 22, 2024

Conversation

amosyou
Copy link
Contributor

@amosyou amosyou commented Jan 19, 2024

Added documentation for tree utilities which fixes #685

@fabianp
Copy link
Member

fabianp commented Jan 19, 2024

this is great, thank you so much @amosyou !

Small request: instead of putting these in a new file docs/api/tree_utilities.rst, would you mind putting them in the file docs/api/general_utilities.rst and then rename that file to docs/api/utilities.rst ?

We're trying to reduce the number of items under API documentation.

@amosyou
Copy link
Contributor Author

amosyou commented Jan 19, 2024

sure thing @fabianp ! and then would it be cool if I also put the utilities for numerical stability and second order optimization in the utilities.rst?

@fabianp
Copy link
Member

fabianp commented Jan 19, 2024

+100 that would be just perfect

@amosyou
Copy link
Contributor Author

amosyou commented Jan 19, 2024

@fabianp combined everything into one utilities.rst, let me know if there's any other changes you'd see fit

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.

Perfection, thanks!!!

@vroulet
Copy link
Collaborator

vroulet commented Jan 20, 2024

Thank you @amosyou ! A tiny little detail: could you order the Tree functions alphabetically? The rest of the doc is ordered that way, even though your order made sense too. Thanks again!

@amosyou
Copy link
Contributor Author

amosyou commented Jan 20, 2024

sounds good @vroulet ! should we also reorder the types of util functions to be alphabetical (ie. general, numerical stability, second order, tree) or is the current ordering fine?

@vroulet
Copy link
Collaborator

vroulet commented Jan 20, 2024

Yes, let's be systematic. Thanks again!

@copybara-service copybara-service bot merged commit d6fc6ae into google-deepmind:main Jan 22, 2024
6 checks passed
@fabianp
Copy link
Member

fabianp commented Jan 22, 2024

merged, thanks @amosyou !

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.

Add the tree_util module to the API documentation
3 participants