# tf.data.IteratorSpec

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.6.0/tensorflow/python/data/ops/iterator_ops.py#L846-L897) |

Type specification for [`tf.data.Iterator`](https://www.tensorflow.org/versions/r2.6/api_docs/python/tf/data/Iterator).

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

    tf.data.IteratorSpec(
        element_spec
    )

For instance, [`tf.data.IteratorSpec`](https://www.tensorflow.org/versions/r2.6/api_docs/python/tf/data/IteratorSpec) can be used to define a tf.function that
takes [`tf.data.Iterator`](https://www.tensorflow.org/versions/r2.6/api_docs/python/tf/data/Iterator) as an input argument:

    @tf.function(input_signature=[tf.data.IteratorSpec(
      tf.TensorSpec(shape=(), dtype=tf.int32, name=None))])
    def square(iterator):
      x = iterator.get_next()
      return x * x
    dataset = tf.data.Dataset.from_tensors(5)
    iterator = iter(dataset)
    print(square(iterator))
    tf.Tensor(25, shape=(), dtype=int32)

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `element_spec` | A (nested) structure of [`tf.TypeSpec`](https://www.tensorflow.org/versions/r2.6/api_docs/python/tf/TypeSpec) objects that represents the type specification of the iterator elements. |
| `value_type` | The Python type for values that are compatible with this TypeSpec. <br /> In particular, all values that are compatible with this TypeSpec must be an instance of this type. |

<br />

## Methods

### `from_value`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.6.0/tensorflow/python/data/ops/iterator_ops.py#L895-L897)

    @staticmethod
    from_value(
        value
    )

### `is_compatible_with`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.6.0/tensorflow/python/framework/type_spec.py#L103-L118)

    is_compatible_with(
        spec_or_value
    )

Returns true if `spec_or_value` is compatible with this TypeSpec.

### `most_specific_compatible_type`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.6.0/tensorflow/python/framework/type_spec.py#L120-L142)

    most_specific_compatible_type(
        other
    )

Returns the most specific TypeSpec compatible with `self` and `other`.

<br />

<br />

<br />

| Args ||
|---|---|
| `other` | A `TypeSpec`. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If there is no TypeSpec that is compatible with both `self` and `other`. |

<br />

### `__eq__`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.6.0/tensorflow/python/framework/type_spec.py#L320-L323)

    __eq__(
        other
    )

Return self==value.

### `__ne__`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.6.0/tensorflow/python/framework/type_spec.py#L325-L326)

    __ne__(
        other
    )

Return self!=value.