ConstrainSharding

ConstrainSharding#

class penzai.toolshed.sharding_util.ConstrainSharding[source]#

Bases: Layer

A layer that constrains the sharding of a tree of arrays.

Note: Defined using the experimental v2 API, but compatible with both v1 and v2 APIs (due to not having any parameters or state variables).

Variables:

sharding (PyTreeOfShardings) – A PyTree of shardings. The PyTree structure must match the structure of the tree of arrays that will be passed to this layer.

Methods

__init__(sharding)

__call__(tree, **_unused_side_inputs)

Attributes

sharding

Inherited Methods

(expand to view inherited methods)

attributes_dict()

Constructs a dictionary with all of the fields in the class.

bind_variables(variables[, allow_unused])

Convenience function to bind variables to a layer.

from_attributes(**field_values)

Directly instantiates a struct given all of its fields.

key_for_field(field_name)

Generates a JAX PyTree key for a given field name.

select()

Wraps this struct in a selection, enabling functional-style mutations.

stateless_call(variable_values, argument, /, ...)

Calls a layer with temporary variables, without modifying its state.

tree_flatten()

Flattens this tree node.

tree_flatten_with_keys()

Flattens this tree node with keys.

tree_unflatten(aux_data, children)

Unflattens this tree node.

treescope_color()

Computes a CSS color to display for this object in treescope.