StateVariableSlot

StateVariableSlot#

class penzai.core.variables.StateVariableSlot[source]#

Bases: AbstractVariableSlot

A slot for a parameter in a model.

A StateVariableSlot identifies a place in a model (or other pytree) where a Penzai state variable should be substituted.

Variables:

label (VariableLabel) – A label that identifies this slot.

Methods

__init__(label)

treescope_color()

Attributes

value

Raises an error when accessed.

label

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.

property value: Any#

Raises an error when accessed.