# tf.data.experimental.scan

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/data/experimental/scan) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.1.0/tensorflow/python/data/experimental/ops/scan_ops.py#L159-L183) |

A transformation that scans a function across an input dataset.

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.data.experimental.scan`](https://www.tensorflow.org/api_docs/python/tf/data/experimental/scan)

<br />

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

This transformation is a stateful relative of [`tf.data.Dataset.map`](https://www.tensorflow.org/versions/r2.1/api_docs/python/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`.

<br />

<br />

<br />

| ## 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. The`new_state`must match the structure of`initial_state\`. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A `Dataset` transformation function, which can be passed to [`tf.data.Dataset.apply`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Dataset#apply). ||

<br />