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. The new_state must match the
structure of initial_state.
[null,null,["Last updated 2024-04-26 UTC."],[],[],null,["# tf.data.experimental.scan\n\n\u003cbr /\u003e\n\n|--------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.16.1/tensorflow/python/data/experimental/ops/scan_ops.py#L20-L45) |\n\nA transformation that scans a function across an input dataset. (deprecated)\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.data.experimental.scan`](https://www.tensorflow.org/api_docs/python/tf/data/experimental/scan)\n\n\u003cbr /\u003e\n\n tf.data.experimental.scan(\n initial_state, scan_func\n )\n\n| **Deprecated:** THIS FUNCTION IS DEPRECATED. It will be removed in a future version. Instructions for updating: Use \\`tf.data.Dataset.scan(...) instead\n\nThis transformation is a stateful relative of [`tf.data.Dataset.map`](../../../tf/data/Dataset#map).\nIn addition to mapping `scan_func` across the elements of the input dataset,\n`scan()` accumulates one or more state tensors, whose initial values are\n`initial_state`.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `initial_state` | A nested structure of tensors, representing the initial state of the accumulator. |\n| `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`. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A `Dataset` transformation function, which can be passed to [`tf.data.Dataset.apply`](../../../tf/data/Dataset#apply). ||\n\n\u003cbr /\u003e"]]
View source on GitHub