# tf.RaggedTensorSpec

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/RaggedTensorSpec) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.4.0/tensorflow/python/ops/ragged/ragged_tensor.py#L2179-L2492) |

Type specification for a [`tf.RaggedTensor`](https://www.tensorflow.org/versions/r2.4/api_docs/python/tf/RaggedTensor).

Inherits From: [`TypeSpec`](https://www.tensorflow.org/versions/r2.4/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.RaggedTensorSpec`](https://www.tensorflow.org/api_docs/python/tf/RaggedTensorSpec)

<br />

    tf.RaggedTensorSpec(
        shape=None, dtype=tf.dtypes.float32, ragged_rank=None,
        row_splits_dtype=tf.dtypes.int64, flat_values_spec=None
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `shape` | The shape of the RaggedTensor, or `None` to allow any shape. If a shape is specified, then all ragged dimensions must have size `None`. |
| `dtype` | [`tf.DType`](https://www.tensorflow.org/versions/r2.4/api_docs/python/tf/dtypes/DType) of values in the RaggedTensor. |
| `ragged_rank` | Python integer, the number of times the RaggedTensor's flat_values is partitioned. Defaults to `shape.ndims - 1`. |
| `row_splits_dtype` | `dtype` for the RaggedTensor's `row_splits` tensor. One of [`tf.int32`](https://www.tensorflow.org/versions/r2.4/api_docs/python/tf#int32) or [`tf.int64`](https://www.tensorflow.org/versions/r2.4/api_docs/python/tf#int64). |
| `flat_values_spec` | TypeSpec for flat_value of the RaggedTensor. It shall be provided when the flat_values is a CompositeTensor rather then Tensor. If both `dtype` and `flat_values_spec` and are provided, `dtype` must be the same as `flat_values_spec.dtype`. (experimental) |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `dtype` | The [`tf.dtypes.DType`](https://www.tensorflow.org/versions/r2.4/api_docs/python/tf/dtypes/DType) specified by this type for the RaggedTensor. <br /> rt = tf.ragged.constant([["a"], ["b", "c"]], dtype=tf.string) tf.type_spec_from_value(rt).dtype tf.string <br /> |
| `flat_values_spec` | The `TypeSpec` of the flat_values of RaggedTensor. |
| `ragged_rank` | The number of times the RaggedTensor's flat_values is partitioned. <br /> Defaults to `shape.ndims - 1`. values = tf.ragged.constant([[1, 2, 3], [4], [5, 6], [7, 8, 9, 10]]) tf.type_spec_from_value(values).ragged_rank 1 rt1 = tf.RaggedTensor.from_uniform_row_length(values, 2) tf.type_spec_from_value(rt1).ragged_rank 2 <br /> |
| `row_splits_dtype` | The [`tf.dtypes.DType`](https://www.tensorflow.org/versions/r2.4/api_docs/python/tf/dtypes/DType) of the RaggedTensor's `row_splits`. <br /> rt = tf.ragged.constant([[1, 2, 3], [4]], row_splits_dtype=tf.int64) tf.type_spec_from_value(rt).row_splits_dtype tf.int64 <br /> |
| `shape` | The statically known shape of the RaggedTensor. <br /> rt = tf.ragged.constant([[0], [1, 2]]) tf.type_spec_from_value(rt).shape TensorShape([2, None]) rt = tf.ragged.constant([[[0, 1]], [[1, 2], [3, 4]]], ragged_rank=1) tf.type_spec_from_value(rt).shape TensorShape([2, None, 2]) <br /> |
| `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.4.0/tensorflow/python/ops/ragged/ragged_tensor.py#L2477-L2492)

    @classmethod
    from_value(
        value
    )

### `is_compatible_with`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.4.0/tensorflow/python/ops/ragged/ragged_tensor.py#L2323-L2332)

    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.4.0/tensorflow/python/framework/type_spec.py#L110-L132)

    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.4.0/tensorflow/python/framework/type_spec.py#L293-L296)

    __eq__(
        other
    )

Return self==value.

### `__ne__`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.4.0/tensorflow/python/framework/type_spec.py#L298-L299)

    __ne__(
        other
    )

Return self!=value.