# tf.keras.preprocessing.image.NumpyArrayIterator

<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/image/NumpyArrayIterator) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.0.0/tensorflow/python/keras/preprocessing/image.py#L231-L291) |

Iterator yielding data from a Numpy array.

Inherits From: [`Iterator`](https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/keras/preprocessing/image/Iterator)

#### View aliases


**Compat aliases for migration**

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

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

<br />

    tf.keras.preprocessing.image.NumpyArrayIterator(
        x, y, image_data_generator, batch_size=32, shuffle=False, sample_weight=None,
        seed=None, data_format=None, save_to_dir=None, save_prefix='',
        save_format='png', subset=None, dtype=None
    )

<br />

<br />

<br />

| ## Arguments ||
|---|---|
| `x` | Numpy array of input data or tuple. If tuple, the second elements is either another numpy array or a list of numpy arrays, each of which gets passed through as an output without any modifications. |
| `y` | Numpy array of targets data. |
| `image_data_generator` | Instance of `ImageDataGenerator` to use for random transformations and normalization. |
| `batch_size` | Integer, size of a batch. |
| `shuffle` | Boolean, whether to shuffle the data between epochs. |
| `sample_weight` | Numpy array of sample weights. |
| `seed` | Random seed for data shuffling. |
| `data_format` | String, one of `channels_first`, `channels_last`. |
| `save_to_dir` | Optional directory where to save the pictures being yielded, in a viewable format. This is useful for visualizing the random transformations being applied, for debugging purposes. |
| `save_prefix` | String prefix to use for saving sample images (if `save_to_dir` is set). |
| `save_format` | Format to use for saving sample images (if `save_to_dir` is set). |
| `subset` | Subset of data (`"training"` or `"validation"`) if validation_split is set in ImageDataGenerator. |
| `dtype` | Dtype to use for the generated arrays. |

<br />

## Methods

### `next`

    next()

For python 2.x.

# Returns

    The next batch.

### `on_epoch_end`

    on_epoch_end()

Method called at the end of every epoch.

### `reset`

    reset()

### `__getitem__`

    __getitem__(
        idx
    )

Gets batch at position `index`.

<br />

<br />

<br />

| Arguments ||
|---|---|
| `index` | position of the batch in the Sequence. |

<br />

<br />

<br />

<br />

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

<br />

### `__iter__`

    __iter__()

Create a generator that iterate over the Sequence.

### `__len__`

    __len__()

Number of batch in the Sequence.

<br />

<br />

<br />

| Returns ||
|---|---|
| The number of batches in the Sequence. ||

<br />

## Class Variables

- `white_list_formats`