Skip to content

Add out_sharding docstrings to linear layer call methods #5154

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
jackopenn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add out_sharding docstrings to linear layer call methods #5154

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
15 changes: 15 additions & 0 deletions flax/nnx/nn/linear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,11 @@ def __call__(self, inputs: Array, out_sharding = None) -> Array:

Args:
inputs: The nd-array to be transformed.
out_sharding: Optional sharding specification (e.g.,
``jax.sharding.PartitionSpec``) for the output array. When using JAX's
explicit sharding mode with a mesh context with ``AxisType.Explicit``.
If ``None`` (default), the compiler automatically determines output
sharding.

Returns:
The transformed input.
Expand Down Expand Up @@ -398,6 +403,11 @@ def __call__(self, inputs: Array, out_sharding = None) -> Array:

Args:
inputs: The nd-array to be transformed.
out_sharding: Optional sharding specification (e.g.,
``jax.sharding.PartitionSpec``) for the output array. When using JAX's
explicit sharding mode with a mesh context with ``AxisType.Explicit``.
If ``None`` (default), the compiler automatically determines output
sharding.

Returns:
The transformed input.
Expand Down Expand Up @@ -532,6 +542,11 @@ def __call__(
the rhs being the learnable kernel. Exactly one of ``einsum_str``
in the constructor argument and call argument must be not None,
while the other must be None.
out_sharding: Optional sharding specification (e.g.,
``jax.sharding.PartitionSpec``) for the output array. When using JAX's
explicit sharding mode with a mesh context with ``AxisType.Explicit``.
If ``None`` (default), the compiler automatically determines output
sharding.

Returns:
The transformed input.
Expand Down