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

Update NNX Variable class docs in variablelib.py #4448

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

Update NNX Variable class docs in variablelib.py #4448

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/variablelib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ class VariableMetadata(tp.Generic[A]):


class Variable(tp.Generic[A], reprlib.Representable):
"""The base class for all ``Variable`` types. Create custom ``Variable``
types by subclassing this class. Numerous NNX graph functions can filter
for specific ``Variable`` types, for example, :func:`split`, :func:`state`,
:func:`pop`, and :func:`State.filter`.
"""The base class for all :class:`flax.nnx.Variable` types. Creates custom
``nnx.Variable`` types by subclassing this class. Numerous NNX graph functions
can filter for specific ``nnx.Variable`` types, for example, :func:`flax.nnx.split`,
:func:`flax.nnx.state`, :func:`flax.nnx.pop`, and :func:`flax.nnx.State.filter`.

Example usage::

Expand Down
Loading