<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/legacy/preprocessing/sequence.py#L12-L184) |

Utility class for generating batches of temporal data.

Inherits From: [`PyDataset`](https://www.tensorflow.org/api_docs/python/tf/keras/utils/PyDataset)

    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,
        **kwargs
    )

DEPRECATED.

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.

<br />

<br />

<br />

| ## 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). |
| `**kwargs` | Additional keyword arguments for the `PyDataset` base class, such as `workers`, `use_multiprocessing`, and `max_queue_size`. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A PyDataset instance. ||

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `max_queue_size` | <br /> <br /> |
| `num_batches` | Number of batches in the PyDataset. |
| `use_multiprocessing` | <br /> <br /> |
| `workers` | <br /> <br /> |

<br />

## Methods

### `get_config`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/legacy/preprocessing/sequence.py#L130-L167)

    get_config()

Returns the TimeseriesGenerator configuration as Python dictionary.

<br />

<br />

<br />

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

<br />

### `on_epoch_begin`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/trainers/data_adapters/py_dataset_adapter.py#L189-L191)

    on_epoch_begin()

Method called at the beginning of every epoch.

### `on_epoch_end`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/trainers/data_adapters/py_dataset_adapter.py#L193-L195)

    on_epoch_end()

Method called at the end of every epoch.

### `to_json`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/legacy/preprocessing/sequence.py#L169-L184)

    to_json(
        **kwargs
    )

Returns a JSON string containing the generator's configuration.

<br />

<br />

<br />

| Args ||
|---|---|
| `**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/tree/v3.15.1/keras/src/legacy/preprocessing/sequence.py#L105-L128)

    __getitem__(
        index
    )

Gets batch at position `index`.

<br />

<br />

<br />

| Args ||
|---|---|
| `index` | position of the batch in the PyDataset. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A batch ||

<br />

### `__iter__`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/trainers/data_adapters/py_dataset_adapter.py#L158-L171)

    __iter__()

### `__len__`

[View source](https://github.com/keras-team/keras/tree/v3.15.1/keras/src/legacy/preprocessing/sequence.py#L100-L103)

    __len__()