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

explain what optax.centralize does #1080

Open
fabianp opened this issue Oct 1, 2024 · 2 comments
Open

explain what optax.centralize does #1080

fabianp opened this issue Oct 1, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@fabianp
Copy link
Member

fabianp commented Oct 1, 2024

Its docstring is extremely poor: https://optax.readthedocs.io/en/latest/api/transformations.html#optax.centralize

  • Explain what centralize means
  • Add a usage example
  • Put reference in correct RST format
@fabianp fabianp added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 1, 2024
@miguelcsx
Copy link
Contributor

Hi @fabianp , I'm going to start working on this issue, could you assign it to me?

@fabianp
Copy link
Member Author

fabianp commented Oct 4, 2024

thanks for picking this up @miguelcsx !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants