<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.15.1/tensorflow/python/framework/tensor.py#L918-L1220) |

Describes the type of a tf.Tensor.

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

#### 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.md.txt)

<br />

```python
tf.TensorSpec(
    shape,
    dtype=`tf.dtypes.float32`,
    name=None
)
```

```python
t = tf.constant([[1,2,3],[4,5,6]])
tf.TensorSpec.from_tensor(t)
TensorSpec(shape=(2, 3), dtype=tf.int32, name=None)
```

Contains metadata for describing the nature of [`tf.Tensor`](https://www.tensorflow.org/versions/r2.15/api_docs/python/tf/Tensor.md.txt) objects
accepted or returned by some TensorFlow APIs.

For example, it can be used to constrain the type of inputs accepted by
a tf.function:

```python
@tf.function(input_signature=[tf.TensorSpec([1, None])])
def constrained_foo(t):
  print("tracing...")
  return t
```

Now the [`tf.function`](https://www.tensorflow.org/versions/r2.15/api_docs/python/tf/function.md.txt) is able to assume that `t` is always of the type
`tf.TensorSpec([1, None])` which will avoid retracing as well as enforce the
type restriction on inputs.

As a result, the following call with tensor of type `tf.TensorSpec([1, 2])`
triggers a trace and succeeds:

```python
>>> constrained_foo(tf.constant([[1., 2]])).numpy()
tracing...
array([[1., 2.]], dtype=float32)
```

The following subsequent call with tensor of type `tf.TensorSpec([1, 4])`
does not trigger a trace and succeeds:

```python
>>> constrained_foo(tf.constant([[1., 2, 3, 4]])).numpy()
array([[1., 2., 3., 4.], dtype=float32)
```

But the following call with tensor of type `tf.TensorSpec([2, 2])` fails:

```python
>>> constrained_foo(tf.constant([[1., 2], [3, 4]])).numpy()
Traceback (most recent call last):
...
TypeError: Binding inputs to tf.function `constrained_foo` failed ...
```

<br />

<br />

<br />

| ## Args ||
|---|---|
| `shape` | Value convertible to [`tf.TensorShape`](https://www.tensorflow.org/versions/r2.15/api_docs/python/tf/TensorShape.md.txt). The shape of the tensor. |
| `dtype` | Value convertible to [`tf.DType`](https://www.tensorflow.org/versions/r2.15/api_docs/python/tf/dtypes/DType.md.txt). 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.15/api_docs/python/tf/TensorShape.md.txt), or dtype is not convertible to a [`tf.DType`](https://www.tensorflow.org/versions/r2.15/api_docs/python/tf/dtypes/DType.md.txt). |

<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

### `experimental_as_proto`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.15.1/tensorflow/python/framework/tensor.py#L978-L983)

```python
experimental_as_proto() -> struct_pb2.TensorSpecProto
```

Returns a proto representation of the TensorSpec instance.

### `experimental_from_proto`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.15.1/tensorflow/python/framework/tensor.py#L969-L976)

```python
@classmethod
experimental_from_proto(
    proto: struct_pb2.TensorSpecProto
) -> 'TensorSpec'
```

Returns a TensorSpec instance based on the serialized proto.

### `experimental_type_proto`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.15.1/tensorflow/python/framework/tensor.py#L964-L967)

```python
@classmethod
experimental_type_proto() -> Type[struct_pb2.TensorSpecProto]
```

Returns the type of proto associated with TensorSpec serialization.

### `from_spec`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.15.1/tensorflow/python/framework/tensor.py#L1127-L1139)

```python
@classmethod
from_spec(
    spec, name=None
)
```

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

```python
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.15.1/tensorflow/python/framework/tensor.py#L1141-L1162)

```python
@classmethod
from_tensor(
    tensor, name=None
)
```

Returns a `TensorSpec` that describes `tensor`.

```python
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.15/api_docs/python/tf/Tensor.md.txt) 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.15.1/tensorflow/python/framework/tensor.py#L985-L997)

```python
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.15/api_docs/python/tf/TensorShape.md.txt#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.15.1/tensorflow/python/framework/tensor.py#L999-L1007)

```python
is_subtype_of(
    other
)
```

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.15.1/tensorflow/python/framework/type_spec.py#L149-L195)

```python
most_specific_common_supertype(
    others: Sequence[`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.15.1/tensorflow/python/framework/type_spec.py#L324-L342)

```python
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.15.1/tensorflow/python/framework/tensor.py#L897-L900)

```python
__eq__(
    other
)
```

Return self==value.

### `__ne__`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.15.1/tensorflow/python/framework/tensor.py#L902-L903)

```python
__ne__(
    other
)
```

Return self!=value.