# tf.contrib.data.sliding_window_batch

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/data/python/ops/sliding.py#L66-L129) |

A sliding window over a dataset. (deprecated) (deprecated arguments)

    tf.contrib.data.sliding_window_batch(
        window_size, stride=None, window_shift=None, window_stride=1
    )

> [!WARNING]
> **Warning:** SOME ARGUMENTS ARE DEPRECATED: `(stride)`. They will be removed in a future version. Instructions for updating: stride is deprecated, use window_shift instead

> [!WARNING]
> **Warning:** THIS FUNCTION IS DEPRECATED. It will be removed in a future version. Instructions for updating: Use `tf.data.Dataset.window(size=window_size, shift=window_shift, stride=window_stride).flat_map(lambda x: x.batch(window_size))` instead.

This transformation passes a sliding window over this dataset. The window size
is `window_size`, the stride of the input elements is `window_stride`, and the
shift between consecutive windows is `window_shift`. If the remaining elements
cannot fill up the sliding window, this transformation will drop the final
smaller element. For example:

    # NOTE: The following examples use `{ ... }` to represent the
    # contents of a dataset.
    a = { [1], [2], [3], [4], [5], [6] }

    a.apply(sliding_window_batch(window_size=3)) ==
    { [[1], [2], [3]], [[2], [3], [4]], [[3], [4], [5]], [[4], [5], [6]] }

    a.apply(sliding_window_batch(window_size=3, window_shift=2)) ==
    { [[1], [2], [3]], [[3], [4], [5]] }

    a.apply(sliding_window_batch(window_size=3, window_stride=2)) ==
    { [[1], [3], [5]], [[2], [4], [6]] }

<br />

<br />

<br />

| ## Args ||
|---|---|
| `window_size` | A [`tf.int64`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf#int64) scalar [`tf.Tensor`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Tensor), representing the number of elements in the sliding window. It must be positive. |
| `stride` | (Optional.) A [`tf.int64`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf#int64) scalar [`tf.Tensor`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Tensor), representing the forward shift of the sliding window in each iteration. The default is `1`. It must be positive. Deprecated alias for `window_shift`. |
| `window_shift` | (Optional.) A [`tf.int64`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf#int64) scalar [`tf.Tensor`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Tensor), representing the forward shift of the sliding window in each iteration. The default is `1`. It must be positive. |
| `window_stride` | (Optional.) A [`tf.int64`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf#int64) scalar [`tf.Tensor`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/Tensor), representing the stride of the input elements in the sliding window. The default is `1`. It must be positive. |

<br />

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | if invalid arguments are provided. |

<br />