TreefyState

class brainstate.TreefyState(type, value, **metadata)

The state as a pytree.

copy()

Copy the state reference.

Return type:

TreefyState[TypeVar(A)]

get_metadata()

Get the metadata of the state reference

Return type:

Dict[str, Any]

property name: str | None

The name of the state.

replace(value)

Replace the value of the state reference.

Return type:

TreefyState[TypeVar(B)]

to_state()

Convert the state reference to the state.

Return type:

State[TypeVar(A)]