CheckStructure

final class penzai.nn.grouping.CheckStructure

Bases: Layer

A layer that checks the structure of the value passing through it.

Variables:

expected (Any) – An expected structure, represented as a PyTree of pz.chk.ArraySpec nodes. This defines the type of input this layer expects to receive. Passing anything else will raise an error.

Methods

__init__(expected)
treescope_color()
__call__(value)	Checks the structure of the value, then returns it.

Attributes

expected

Inherited Methods

(expand to view inherited methods)

attributes_dict()	Constructs a dictionary with all of the fields in the class.
from_attributes(**field_values)	Directly instantiates a struct given all of its fields.
input_structure()	Returns the input structure of this layer.
key_for_field(field_name)	Generates a JAX PyTree key for a given field name.
output_structure()	Returns the output structure of this layer.
select()	Wraps this struct in a selection, enabling functional-style mutations.
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.

__call__(value: Any) → Any

Checks the structure of the value, then returns it.