HandledLocalStateRef

class penzai.data_effects.local_state.HandledLocalStateRef

Bases: HandledEffectRef

Marker for a handled local state effect.

Variables:

• handler_id (effect_base.HandlerId) – The ID of the handler that is responsible for handling this effect.

• category (Category) – Category tag identifying the kind of state.

• name (str) – Name of this state variable. Used to identify it in the state dict.

• was_explicitly_named (bool) – True if this name was provided explicitly by the user and should be preserved as-is.

Methods

__init__(handler_id, category, name, ...)
effect_protocol()

Attributes

handler_id
category
name
was_explicitly_named

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.
treescope_color()