LabeledVariableValue#
- class penzai.core.variables.LabeledVariableValue[source]#
Bases:
AbstractVariableValue,Generic[T]The value of a basic labeled variable, as a frozen JAX pytree.
- Variables:
label (VariableLabel) – The unique label for this variable.
value (T) – A snapshot of the value stored in the variable. Should be a JAX pytree.
metadata (dict[Any, Any]) – A dictionary of metadata associated with this variable.
Methods
__init__(label, value[, metadata])Attributes
labelvaluemetadataInherited 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.
get_slot()Returns the slot that this variable is replaced with when unbound.
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.
treescope_color()Computes a CSS color to display for this object in treescope.
unfreeze_as_copy()Returns a new mutable copy of this variable.