Update flax.nnx.grad docstring
#4368
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8bitmp3
changed the title
flax.nnx.grad docstring
cgarciae
reviewed
Nov 15, 2024
flax/nnx/transforms/autodiff.py
Outdated
| @@ -233,14 +233,19 @@ def grad( | |||
| tp.Callable[..., tp.Any] | |||
| | tp.Callable[[tp.Callable[..., tp.Any]], tp.Callable[..., tp.Any]] | |||
| ): | |||
| """Lifted version of ``jax.grad`` that can handle Modules / graph nodes as | |||
| arguments. | |||
| """A "lifted" version of `jax.grad <https://jax.readthedocs.io/en/latest/_autosummary/jax.grad.html#jax.grad>`_ | |||
There was a problem hiding this comment.
I know this was there but we can improve this while we are at it... can you remove this "lifted" terminology. I think "reference-aware" or something like that is better.
There was a problem hiding this comment.
Yes! SGTM. We have discussed not using "lifted" with you and team (cc @levskaya) before.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
@IvyZX @cgarciae