Improved docstring for optax.centralize with explanation and example #1220
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.
This PR enhances the docstring for optax.centralize by:
Expanding the explanation of gradient centralization and its benefits.
Clarifying that gradients are centralized along the feature dimension.
Adding an example demonstrating how to apply optax.centralize.
Motivation:
The previous docstring was minimal and lacked details on how gradient centralization works. This update provides a clearer explanation and a practical example, making it easier for users to understand and apply the transformation.
Changes Made:
Updated the docstring with a more detailed description of gradient centralization.
Added a code example demonstrating usage with jax.numpy.
Formatted the reference section properly for better readability.
Checklist:
The docstring follows the project's documentation style.
The example is correctly formatted and functional.
The update does not introduce any breaking changes.