tf.contrib.framework.deprecated_args
Декоратор для маркирования определённых аргументов функции как устаревших.
tf.contrib.framework.deprecated_args(
date, instructions, *deprecated_arg_names_or_tuples, **kwargs
)
Этот декоратор регистрирует предупреждение об устаревании всякий раз, когда декорированная функция вызывается с устаревшим аргументом. Он имеет следующий формат:
Вызов
Если date равно None, «после
Он также редактирует строку документации функции: « (устаревшие аргументы)» добавляется к первой строке строки документации, а уведомление об устаревании предваряет остальную часть строки документации.
| Аргументы | |
|---|---|
date | Строка или None. Дата, к которой функция планируется удалить. Должна быть в формате ISO 8601 (ГГГГ-ММ-ДД) или None. |
instructions | Строка. Инструкции по обновлению кода, использующего устаревшую функцию. |
*deprecated_arg_names_or_tuples | Строка или 2-кортеж (Строка, [значения_ok]). Строка — это имя устаревшего аргумента. Допускается предоставление значения ok. Если предоставленное пользователем значение аргумента равно этому значению, предупреждение подавляется. |
**kwargs | Если warn_once=False передаётся, каждое вызов с устаревшим аргументом будет регистрировать предупреждение. По умолчанию предупреждение регистрируется только в первый раз, когда функция вызывается с любым заданным устаревшим аргументом. Все остальные аргументы kwargs вызывают ValueError. |
| Возвращаемые значения | |
|---|---|
| Декорированная функция или метод. |
| Исключения | |
|---|---|
ValueError | Если дата не равна None или не в формате ISO 8601, инструкции пустые, устаревшие аргументы отсутствуют в сигнатуре функции, второй элемент кортежа deprecated_tuple не является списком или если передан аргумент kwargs, кроме warn_once. |
© 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/contrib/framework/deprecated_args
