Skip to content

Update NNX State class docs in statelib.py #4450

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update NNX State class docs in statelib.py #4450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions flax/nnx/statelib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ def _flat_state_pytree_unflatten(


class State(MutableMapping[K, V], reprlib.Representable):
"""A pytree-like structure that contains a ``Mapping`` from hashable and
comparable keys to leaves. Leaves can be of any type but :class:`VariableState`
and :class:`Variable` are the most common.
"""A JAX pytree-like structure that contains a ``Mapping`` from hashable
and comparable keys to pytree leaves. Pytree leaves can be of any type
but :class:`flax.nnx.VariableState` and :class:`flax.nnx.Variable` are the most common.
"""

def __init__(
Expand Down Expand Up @@ -492,4 +492,4 @@ def create_path_filters(state: State):
if isinstance(value, (variablelib.Variable, variablelib.VariableState)):
value = value.value
value_paths.setdefault(value, set()).add(path)
return {filterlib.PathIn(*value_paths[value]): value for value in value_paths}
return {filterlib.PathIn(*value_paths[value]): value for value in value_paths}
Loading