Skip to content

Update NNX merge docs in graph.py #4411

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

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Update NNX merge docs in graph.py #4411

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
30 changes: 19 additions & 11 deletions flax/nnx/graph.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1297,10 +1297,18 @@ def merge(
/,
*states: tp.Mapping[KeyT, tp.Any],
) -> A:
"""The inverse of :func:`split`.
"""The inverse of :func:`flax.nnx.split`.

``merge`` takes a :class:`GraphDef` and one or more :class:`State`'s and creates
a new node with the same structure as the original node.
``nnx.merge`` takes a :class:`flax.nnx.GraphDef` and one or more :class:`flax.nnx.State`'s
and creates a new node with the same structure as the original node.

Recall: :func:`flax.nnx.split` is used to represent a :class:`flax.nnx.Module`
by: 1) a static ``nnx.GraphDef`` that captures its Pythonic static information;
and 2) one or more :class:`flax.nnx.Variable` ``nnx.State``'(s) that capture
its ``jax.Array``'s in the form of JAX pytrees.

``nnx.merge`` is used in conjunction with ``nnx.split`` to switch seamlessly
between stateful and stateless representations of the graph.

Example usage::

Expand All @@ -1320,17 +1328,17 @@ def merge(
>>> assert isinstance(new_node.batch_norm, nnx.BatchNorm)
>>> assert isinstance(new_node.linear, nnx.Linear)

:func:`split` and :func:`merge` are primarily used to interact directly with JAX
transformations, see
`Functional API <https://flax.readthedocs.io/en/latest/nnx/nnx_basics.html#the-functional-api>`__
``nnx.split`` and ``nnx.merge`` are primarily used to interact directly with JAX
transformations (refer to
`Functional API <https://flax.readthedocs.io/en/latest/nnx_basics.html#the-flax-functional-api>`__
for more information.

Args:
graphdef: A :class:`GraphDef` object.
state: A :class:`State` object.
*states: Additional :class:`State` objects.
graphdef: A :class:`flax.nnx.GraphDef` object.
state: A :class:`flax.nnx.State` object.
*states: Additional :class:`flax.nnx.State` objects.
Returns:
The merged :class:`Module`.
The merged :class:`flax.nnx.Module`.
"""
state = State.merge(state, *states)
node = unflatten(graphdef, state)
Expand Down Expand Up @@ -1852,4 +1860,4 @@ def _unflatten_pytree(
type(None),
flatten=lambda x: ([], None),
unflatten=lambda _, __: None, # type: ignore
)
)
Loading