# tf.TensorSpec

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/tensor_spec.py#L101-L225) |

Describes a tf.Tensor.

Inherits From: [`TypeSpec`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/TypeSpec), [`TraceType`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/types/experimental/TraceType)

#### View aliases


**Compat aliases for migration**

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

[`tf.compat.v1.TensorSpec`](https://www.tensorflow.org/api_docs/python/tf/TensorSpec)

<br />

    tf.TensorSpec(
        shape,
        dtype=https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/dtypes#float32,
        name=None
    )

Metadata for describing the [`tf.Tensor`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/Tensor) objects accepted or returned
by some TensorFlow APIs.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `shape` | Value convertible to [`tf.TensorShape`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/TensorShape). The shape of the tensor. |
| `dtype` | Value convertible to [`tf.DType`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/dtypes/DType). The type of the tensor values. |
| `name` | Optional name for the Tensor. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `TypeError` | If shape is not convertible to a [`tf.TensorShape`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/TensorShape), or dtype is not convertible to a [`tf.DType`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/dtypes/DType). |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `dtype` | Returns the `dtype` of elements in the tensor. |
| `name` | Returns the (optionally provided) name of the described tensor. |
| `shape` | Returns the `TensorShape` that represents the shape of the tensor. |
| `value_type` | The Python type for values that are compatible with this TypeSpec. |

<br />

## Methods

### `from_spec`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/tensor_spec.py#L126-L138)

    @classmethod
    from_spec(
        spec, name=None
    )

Returns a `TensorSpec` with the same shape and dtype as `spec`.

    spec = tf.TensorSpec(shape=[8, 3], dtype=tf.int32, name="OriginalName")
    tf.TensorSpec.from_spec(spec, "NewName")
    TensorSpec(shape=(8, 3), dtype=tf.int32, name='NewName')

<br />

<br />

<br />

| Args ||
|---|---|
| `spec` | The `TypeSpec` used to create the new `TensorSpec`. |
| `name` | The name for the new `TensorSpec`. Defaults to `spec.name`. |

<br />

### `from_tensor`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/tensor_spec.py#L140-L160)

    @classmethod
    from_tensor(
        tensor, name=None
    )

Returns a `TensorSpec` that describes `tensor`.

    tf.TensorSpec.from_tensor(tf.constant([1, 2, 3]))
    TensorSpec(shape=(3,), dtype=tf.int32, name=None)

<br />

<br />

<br />

| Args ||
|---|---|
| `tensor` | The [`tf.Tensor`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/Tensor) that should be described. |
| `name` | A name for the `TensorSpec`. Defaults to `tensor.op.name`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A `TensorSpec` that describes `tensor`. ||

<br />

### `is_compatible_with`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/tensor_spec.py#L112-L124)

    is_compatible_with(
        spec_or_tensor
    )

Returns True if spec_or_tensor is compatible with this TensorSpec.

Two tensors are considered compatible if they have the same dtype
and their shapes are compatible (see [`tf.TensorShape.is_compatible_with`](https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/TensorShape#is_compatible_with)).

<br />

<br />

<br />

| Args ||
|---|---|
| `spec_or_tensor` | A tf.TensorSpec or a tf.Tensor |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| True if spec_or_tensor is compatible with self. ||

<br />

### `is_subtype_of`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/type_spec.py#L100-L137)

    is_subtype_of(
        other: https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/types/experimental/TraceType
    ) -> bool

Returns True if `self` is a subtype of `other`.

Implements the tf.types.experimental.func.TraceType interface.

If not overridden by a subclass, the default behavior is to assume the
TypeSpec is covariant upon attributes that implement TraceType and
invariant upon rest of the attributes as well as the structure and type
of the TypeSpec.

<br />

<br />

<br />

| Args ||
|---|---|
| `other` | A TraceType object. |

<br />

### `most_specific_common_supertype`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/type_spec.py#L139-L185)

    most_specific_common_supertype(
        others: Sequence[https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/types/experimental/TraceType]
    ) -> Optional['TypeSpec']

Returns the most specific supertype TypeSpec of `self` and `others`.

Implements the tf.types.experimental.func.TraceType interface.

If not overridden by a subclass, the default behavior is to assume the
TypeSpec is covariant upon attributes that implement TraceType and
invariant upon rest of the attributes as well as the structure and type
of the TypeSpec.

<br />

<br />

<br />

| Args ||
|---|---|
| `others` | A sequence of TraceTypes. |

<br />

### `most_specific_compatible_type`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/type_spec.py#L216-L234)

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

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

> [!WARNING]
> **Deprecated:** THIS FUNCTION IS DEPRECATED. It will be removed in a future version. Instructions for updating: Use most_specific_common_supertype instead.

Deprecated. Please use `most_specific_common_supertype` instead.
Do not override this function.

<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.9.3/tensorflow/python/framework/tensor_spec.py#L78-L83)

    __eq__(
        other
    )

Return self==value.

### `__ne__`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.9.3/tensorflow/python/framework/tensor_spec.py#L85-L86)

    __ne__(
        other
    )

Return self!=value.