FrozenLocalStateRequest

class penzai.data_effects.local_state.FrozenLocalStateRequest

Bases: Generic[_T], EffectRequest

Effect request for local state with a frozen value.

This can be used to store the state for a stateful model after it has been initialized and possibly updated. As a convenience, it’s possible to call get on a FrozenLocalStateRequest, but not set.

Variables:

• state (_T) – Frozen version of the state for this effect.

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

• name (str | None) – Optional name for this state. If provided, it will be renamed as if this state was a parameter, and used as the key for this state in the state dictionary. If not provided, a name will be inferred from the PyTree structure.

Methods

__init__(state, category[, name])
effect_protocol()
get()
with_renamed_parameters(rename_fn)

Attributes

name
state
category

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