tf.contrib.framework.deprecated
Stay organized with collections
Save and categorize content based on your preferences.
Decorator for marking functions or methods deprecated.
tf.contrib.framework.deprecated(
date, instructions, warn_once=True
)
This decorator logs a deprecation warning whenever the decorated function is
called. It has the following format:
(from ) is deprecated and will be removed after .
Instructions for updating:
If date is None, 'after ' is replaced with 'in a future version'.
will include the class name if it is a method.
It also edits the docstring of the function: ' (deprecated)' is appended
to the first line of the docstring and a deprecation notice is prepended
to the rest of the docstring.
Args |
|---|
date
|
String or None. The date the function is scheduled to be removed.
Must be ISO 8601 (YYYY-MM-DD), or None.
|
instructions
|
String. Instructions on how to update code using the
deprecated function.
|
warn_once
|
Boolean. Set to True to warn only the first time the decorated
function is called. Otherwise, every call will log a warning.
|
Returns |
|---|
|
Decorated function or method.
|
Raises |
|---|
ValueError
|
If date is not None or in ISO 8601 format, or instructions are
empty.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-01 UTC.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.contrib.framework.deprecated\n\n\u003cbr /\u003e\n\n|--------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/util/deprecation.py#L274-L329) |\n\nDecorator for marking functions or methods deprecated. \n\n tf.contrib.framework.deprecated(\n date, instructions, warn_once=True\n )\n\nThis decorator logs a deprecation warning whenever the decorated function is\ncalled. It has the following format:\n\n(from ) is deprecated and will be removed after . Instructions for updating:\n\nIf `date` is None, 'after ' is replaced with 'in a future version'. will include the class name if it is a method.\n\nIt also edits the docstring of the function: ' (deprecated)' is appended\nto the first line of the docstring and a deprecation notice is prepended\nto the rest of the docstring.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `date` | String or None. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD), or None. |\n| `instructions` | String. Instructions on how to update code using the deprecated function. |\n| `warn_once` | Boolean. Set to `True` to warn only the first time the decorated function is called. Otherwise, every call will log a warning. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| Decorated function or method. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|-----------------------------------------------------------------------|\n| `ValueError` | If date is not None or in ISO 8601 format, or instructions are empty. |\n\n\u003cbr /\u003e"]]
View source on GitHub