SideInputRequest

Contents

SideInputRequest#

class penzai.data_effects.side_input.SideInputRequest[source]#

Bases: Generic[_T], EffectRequest

Effect request for a side input.

Every side input must be associated with a unique identifier.

Variables:

tag (Tag) – A tag for this side input, identifying what it is.

Methods

__init__(tag)

effect_protocol()

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