Skip to content
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

Format NNX flatten docs in graph.py #4403

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

Format NNX flatten docs in graph.py #4403

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
9 changes: 5 additions & 4 deletions flax/nnx/graph.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def is_node_leaf(x: tp.Any) -> tpe.TypeGuard[NodeLeaf]:


class RefMap(tp.MutableMapping[A, B], reprlib.MappingReprMixin[A, B]):
"""A mapping that uses object id as the hash for the keys."""
"""A mapping that uses object ``id`` as the hash for the keys."""

def __init__(
self, mapping: tp.Mapping[A, B] | tp.Iterable[tuple[A, B]] = (), /
Expand Down Expand Up @@ -391,11 +391,12 @@ def _apply(
def flatten(
node: Node, /, ref_index: RefMap[tp.Any, Index] | None = None
) -> tuple[GraphDef[Node], GraphState]:
"""Flattens a graph node into a (graphdef, state) pair.
"""Flattens a graph node into a ``(GraphDef, State)`` pair.
(:class:`flax.nnx.GraphDef`, :class:`flax.nnx.State`)

Args:
x: A graph node.
ref_index: A mapping from nodes to indexes, defaults to None. If not provided, a new
ref_index: A mapping from nodes to indexes. Defaults to ``None``. If it's not provided, a new
empty dictionary is created. This argument can be used to flatten a sequence of graph
nodes that share references.
"""
Expand Down Expand Up @@ -1856,4 +1857,4 @@ def _unflatten_pytree(
type(None),
flatten=lambda x: ([], None),
unflatten=lambda _, __: None, # type: ignore
)
)
Loading