SideOutputRequest

class penzai.data_effects.side_output.SideOutputRequest

Bases: Generic[_T], EffectRequest

Effect request for a side output.

Since side outputs do not change the behavior of the model, SideOutputRequest implements tell (but in a way that it doesn’t do anything).

Variables:

tag (SideOutputTag) – A tag for this side output, identifying what it is.

Methods

__init__(tag)
effect_protocol()
tell(value, /)

Attributes

tag

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