Add jax.tree_util.register_simple #21245
Closed
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 proposes a new API,
jax.tree_util.register_simple
that will simplify pytree registration and promote best practices in the most common of cases. Example usage withdataclass
, although this will work on any class that can be flattened and unflattened via simple attribute access:One benefit of this is that it's somewhat self-documenting: we mention in the documentation that
children
should contain dynamic data, andaux_data
should contain static data, but in practice users often miss this detail (e.g. we've had several questions in recent weeks about problems arising after including arrays inaux_data
). Calling thesestatic_attributes
anddynamic_attributes
should hopefully point people in the right direction.