# tf.data.DatasetSpec

<br />

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

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

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

#### View aliases


**Compat aliases for migration**

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

[`tf.compat.v1.data.DatasetSpec`](https://www.tensorflow.org/api_docs/python/tf/data/DatasetSpec), [`tf.compat.v1.data.experimental.DatasetStructure`](https://www.tensorflow.org/api_docs/python/tf/data/DatasetSpec)

<br />

    tf.data.DatasetSpec(
        element_spec, dataset_shape=()
    )

See [`tf.TypeSpec`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/TypeSpec) for more information about TensorFlow type specifications.

    dataset = tf.data.Dataset.range(3)
    tf.data.DatasetSpec.from_value(dataset)
    DatasetSpec(TensorSpec(shape=(), dtype=tf.int64, name=None), TensorShape([]))

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `element_spec` | The inner element spec. |
| `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.7.4/tensorflow/python/data/ops/dataset_ops.py#L4316-L4319)

    @staticmethod
    from_value(
        value
    )

Creates a `DatasetSpec` for the given [`tf.data.Dataset`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/data/Dataset) value.

### `is_compatible_with`

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

    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.7.4/tensorflow/python/framework/type_spec.py#L119-L141)

    most_specific_compatible_type(
        other: 'TypeSpec'
    ) -> 'TypeSpec'

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.7.4/tensorflow/python/framework/type_spec.py#L321-L324)

    __eq__(
        other
    ) -> bool

Return self==value.

### `__ne__`

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

    __ne__(
        other
    ) -> bool

Return self!=value.