tf.OptionalSpec

View source on GitHub

Represents an optional potentially containing a structured value.

Inherits From: TypeSpec

View aliases

Main aliases

`tf.data.experimental.OptionalStructure`

Compat aliases for migration

See Migration guide for more details.

tf.compat.v1.OptionalSpec, tf.compat.v1.data.experimental.OptionalStructure, `tf.compat.v2.OptionalSpec`

tf.OptionalSpec(
    value_structure
)

Attributes
value_type	The Python type for values that are compatible with this TypeSpec.

Methods

from_value

View source

@staticmethod
from_value(
    value
)

is_compatible_with

View source

is_compatible_with(
    spec_or_value
)

Returns true if spec_or_value is compatible with this TypeSpec.

most_specific_compatible_type

View source

most_specific_compatible_type(
    other
)

Returns the most specific TypeSpec compatible with self and other.

Args
other	A TypeSpec.

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

__eq__

View source

__eq__(
    other
)

Return self==value.

__ne__

View source

__ne__(
    other
)

Return self!=value.