tf.data.experimental.scan

View source on GitHub

A transformation that scans a function across an input dataset.

View aliases

Compat aliases for migration

See Migration guide for more details.

tf.compat.v1.data.experimental.scan, `tf.compat.v2.data.experimental.scan`

tf.data.experimental.scan(
    initial_state, scan_func
)

This transformation is a stateful relative of tf.data.Dataset.map. In addition to mapping scan_func across the elements of the input dataset, scan() accumulates one or more state tensors, whose initial values are initial_state.

Args
initial_state	A nested structure of tensors, representing the initial state of the accumulator.
scan_func	A function that maps (old_state, input_element) to (new_state, output_element). It must take two arguments and return a pair of nested structures of tensors. Thenew_statemust match the structure ofinitial_state`.

Returns
A Dataset transformation function, which can be passed to tf.data.Dataset.apply.