# tf.keras.preprocessing.sequence.TimeseriesGenerator

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/keras/preprocessing/sequence/TimeseriesGenerator) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/keras-team/keras/tree/master/keras/preprocessing/sequence.py#L30-L85) |

Utility class for generating batches of temporal data.

Inherits From: [`Sequence`](https://www.tensorflow.org/versions/r2.6/api_docs/python/tf/keras/utils/Sequence)

#### View aliases


**Compat aliases for migration**

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

[`tf.compat.v1.keras.preprocessing.sequence.TimeseriesGenerator`](https://www.tensorflow.org/api_docs/python/tf/keras/preprocessing/sequence/TimeseriesGenerator)

<br />

    tf.keras.preprocessing.sequence.TimeseriesGenerator(
        data, targets, length, sampling_rate=1, stride=1, start_index=0, end_index=None,
        shuffle=False, reverse=False, batch_size=128
    )

This class takes in a sequence of data-points gathered at
equal intervals, along with time series parameters such as
stride, length of history, etc., to produce batches for
training/validation.
Arguments:
data: Indexable generator (such as list or Numpy array)
containing consecutive data points (timesteps).
The data should be at 2D, and axis 0 is expected
to be the time dimension.
targets: Targets corresponding to timesteps in `data`.
It should have same length as `data`.
length: Length of the output sequences (in number of timesteps).
sampling_rate: Period between successive individual timesteps
within sequences. For rate `r`, timesteps
`data[i]`, `data[i-r]`, ... `data[i - length]`
are used for create a sample sequence.
stride: Period between successive output sequences.
For stride `s`, consecutive output samples would
be centered around `data[i]`, `data[i+s]`, `data[i+2*s]`, etc.
start_index: Data points earlier than `start_index` will not be used
in the output sequences. This is useful to reserve part of the
data for test or validation.
end_index: Data points later than `end_index` will not be used
in the output sequences. This is useful to reserve part of the
data for test or validation.
shuffle: Whether to shuffle output samples,
or instead draw them in chronological order.
reverse: Boolean: if `true`, timesteps in each output sample will be
in reverse chronological order.
batch_size: Number of timeseries samples in each batch
(except maybe the last one).
Returns:
A [Sequence](https://www.tensorflow.org/api_docs/python/tf/keras/utils/Sequence) instance.
Examples:

    from keras.preprocessing.sequence import TimeseriesGenerator
    import numpy as np
    data = np.array([[i] for i in range(50)])
    targets = np.array([[i] for i in range(50)])
    data_gen = TimeseriesGenerator(data, targets,
                                   length=10, sampling_rate=2,
                                   batch_size=2)
    assert len(data_gen) == 20
    batch_0 = data_gen[0]
    x, y = batch_0
    assert np.array_equal(x,
                          np.array([[[0], [2], [4], [6], [8]],
                                    [[1], [3], [5], [7], [9]]]))
    assert np.array_equal(y,
                          np.array([[10], [11]]))

## Methods

### `get_config`

[View source](https://github.com/keras-team/keras-preprocessing/tree/master/keras_preprocessing/sequence.py#L380-L413)

    get_config()

Returns the TimeseriesGenerator configuration as Python dictionary.

<br />

<br />

<br />

| Returns ||
|---|---|
| A Python dictionary with the TimeseriesGenerator configuration. ||

<br />

### `on_epoch_end`

[View source](https://github.com/keras-team/keras/tree/master/keras/utils/data_utils.py#L476-L479)

    on_epoch_end()

Method called at the end of every epoch.

### `to_json`

[View source](https://github.com/keras-team/keras-preprocessing/tree/master/keras_preprocessing/sequence.py#L415-L432)

    to_json(
        **kwargs
    )

Returns a JSON string containing the timeseries generator
configuration. To load a generator from a JSON string, use
`keras.preprocessing.sequence.timeseries_generator_from_json(json_string)`.

<br />

<br />

<br />

| Arguments ||
|---|---|
| `**kwargs` | Additional keyword arguments to be passed to `json.dumps()`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A JSON string containing the tokenizer configuration. ||

<br />

### `__getitem__`

[View source](https://github.com/keras-team/keras-preprocessing/tree/master/keras_preprocessing/sequence.py#L363-L378)

    __getitem__(
        index
    )

### `__iter__`

[View source](https://github.com/keras-team/keras/tree/master/keras/utils/data_utils.py#L481-L484)

    __iter__()

Create a generator that iterate over the Sequence.

### `__len__`

[View source](https://github.com/keras-team/keras-preprocessing/tree/master/keras_preprocessing/sequence.py#L359-L361)

    __len__()