StateVariableValue

class penzai.core.variables.StateVariableValue

Bases: LabeledVariableValue[T]

The value of a StateVariable, as a frozen JAX pytree.

Variables:

• value (T) – A snapshot of the value stored in the variable. Should be a JAX pytree.

• label (VariableLabel) – The unique label for this variable.

• metadata (dict[Any, Any]) – A dictionary of metadata associated with this Variable.

Methods

__init__(label, value[, metadata])
get_slot()
treescope_color()
unfreeze_as_copy()

Attributes

label
value
metadata

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.
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.
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.