tf.experimental.Optional

Представляет значение, которое может или не может присутствовать.

Тип tf.experimental.Optional может представлять результат операции, которая может завершиться ошибкой как значение, а не вызовом исключения и остановкой выполнения. Например, tf.data.Iterator.get_next_as_optional() возвращает tf.experimental.Optional, который либо содержит следующий элемент итератора, если он существует, либо пустое значение, указывающее на то, что конец последовательности достигнут.

tf.experimental.Optional может использоваться только со значениями, преобразуемыми в tf.Tensor или tf.CompositeTensor.

Можно создать tf.experimental.Optional из значения, используя метод from_value():

optional = tf.experimental.Optional.from_value(42)
print(optional.has_value())
tf.Tensor(True, shape=(), dtype=bool)
print(optional.get_value())
tf.Tensor(42, shape=(), dtype=int32)

или без значения, используя метод empty():

optional = tf.experimental.Optional.empty(
  tf.TensorSpec(shape=(), dtype=tf.int32, name=None))
print(optional.has_value())
tf.Tensor(False, shape=(), dtype=bool)

optional = tf.experimental.Optional.from_value(42)
print(optional.element_spec)
tf.TensorSpec(shape=(), dtype=tf.int32, name=None)

Методы

empty

Просмотреть исходный код

@staticmethod
empty(
    element_spec
)

Возвращает Optional без значения.

Примечание: Этот метод принимает аргумент, определяющий структуру значения, которое было бы содержанием возвращаемого Optional, если бы оно имело значение.

optional = tf.experimental.Optional.empty(
  tf.TensorSpec(shape=(), dtype=tf.int32, name=None))
print(optional.has_value())
tf.Tensor(False, shape=(), dtype=bool)

from_value

Просмотреть исходный код

@staticmethod
from_value(
    value
)

Возвращает tf.experimental.Optional, который оборачивает данное значение.

optional = tf.experimental.Optional.from_value(42)
print(optional.has_value())
tf.Tensor(True, shape=(), dtype=bool)
print(optional.get_value())
tf.Tensor(42, shape=(), dtype=int32)

get_value

Просмотреть исходный код

@abc.abstractmethod
get_value(
    name=None
)

Возвращает значение, обернутое этим опциональным значением.

Если этот опционал не имеет значения (т.е. self.has_value() вычисляется как False), эта операция вызовет tf.errors.InvalidArgumentError во время выполнения.

optional = tf.experimental.Optional.from_value(42)
print(optional.get_value())
tf.Tensor(42, shape=(), dtype=int32)

has_value

Просмотреть исходный код

@abc.abstractmethod
has_value(
    name=None
)

Возвращает тензор, вычисляемый как True, если этот опционал имеет значение.

optional = tf.experimental.Optional.from_value(42)
print(optional.has_value())
tf.Tensor(True, shape=(), dtype=bool)