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

Jump to bottom

Add flax.nnx.eval_shape docstring #4374

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Add flax.nnx.eval_shape docstring #4374

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b5b300
Add flax.nnx.eval_shape docstring
8bitmp3 Nov 11, 2024
ddd7847
Add flax.nnx.eval_shape docstring
8bitmp3 Nov 11, 2024
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: 8 additions & 1 deletion flax/nnx/transforms/transforms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,14 @@ def _eval_shape_fn(*args, **kwargs):

out = jax.eval_shape(_eval_shape_fn, *args, **kwargs)
return extract.from_tree(out)

"""A "lifted" version of `jax.eval_shape <https://jax.readthedocs.io/en/latest/_autosummary/jax.eval_shape.html#jax.eval_shape>`_
that can handle `flax.nnx.Module <https://flax.readthedocs.io/en/latest/api_reference/flax.nnx/module.html#flax.nnx.Module>`_
/ graph nodes as arguments.

Similar to ``jax.eval_shape``, it computes the shape/dtype of a function `f` without
performing any floating point operations (FLOPs) which can be expensive. This can be
useful for performing shape inference, for example.
"""

# -------------------------------
# cond and switch
Expand Down
Loading