tf.data.experimental.Optional
Оборачивает значение, которое может/может не присутствовать во время выполнения.
Объект Optional может представлять результат операции, которая может завершиться неудачей в виде значения, а не сгенерировать исключение и остановить выполнение. Например, tf.data.experimental.get_next_as_optional возвращает Optional, который либо содержит следующее значение из tf.compat.v1.data.Iterator, если оно существует, либо значение "none", указывающее на то, что конец последовательности достигнут.
Optional может использоваться только значениями, которые могут быть преобразованы в Tensor или CompositeTensor.
| Атрибуты | |
|---|---|
value_structure | Структура компонентов данного объекта Optional. |
Методы
from_value
@staticmethod
from_value(
value
)
Возвращает Optional, который оборачивает заданное значение.
| Аргументы | |
|---|---|
value | Значение для обёртывания. Значение должно быть преобразуемо в Tensor или CompositeTensor. |
| Возвращаемое значение | |
|---|---|
Объект Optional, который оборачивает value. |
get_value
@abc.abstractmethod
get_value(
name=None
)
Возвращает значение, обёрнутое в данном объекте Optional.
Если у данного объекта Optional нет значения (т.е. self.has_value() вычисляет False), эта операция вызовет tf.errors.InvalidArgumentError во время выполнения.
| Аргументы | |
|---|---|
name | (Необязательно.) Имя создаваемой операции. |
| Возвращаемое значение | |
|---|---|
| Обёрнутое значение. |
has_value
@abc.abstractmethod
has_value(
name=None
)
Возвращает тензор, равный True, если у данного объекта Optional есть значение.
| Аргументы | |
|---|---|
name | (Необязательно.) Имя создаваемой операции. |
| Возвращаемое значение | |
|---|---|
Скалярный тензор tf.Tensor типа tf.bool. |
none_from_structure
@staticmethod
none_from_structure(
value_structure
)
Возвращает Optional, у которого нет значения.
Примечание: Этот метод принимает аргумент, который определяет структуру значения, которое будет содержаться в возвращаемом объекте Optional , если у него есть значение.
| Аргументы | |
|---|---|
value_structure | Объект Structure, представляющий структуру компонентов этого объекта Optional. |
| Возвращаемое значение | |
|---|---|
Объект Optional, у которого нет значения. |
© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/data/experimental/Optional