SideOutputValue

Contents

SideOutputValue#

class penzai.data_effects.side_output.SideOutputValue[source]#

Bases: Struct

A value written to a side output.

Variables:
  • keypath (tuple[Any, ...]) – The keypath of the side output.

  • tag (SideOutputTag) – The tag of the side output.

  • value (Any) – The value written to the side output.

Methods

__init__(keypath, tag, value)

Attributes

keypath

tag

value

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

Computes a CSS color to display for this object in treescope.