|View source on GitHub|
Decorator for marking specific function arguments as deprecated.
tf.contrib.framework.deprecated_args( date, instructions, *deprecated_arg_names_or_tuples, **kwargs )
This decorator logs a deprecation warning whenever the decorated function is called with the deprecated argument. It has the following format:
date is None, 'after
It also edits the docstring of the function: ' (deprecated arguments)' is appended to the first line of the docstring and a deprecation notice is prepended to the rest of the docstring.
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.
*deprecated_arg_names_or_tuples: String or 2-Tuple(String, [ok_vals]). The string is the deprecated argument name. Optionally, an ok-value may be provided. If the user provided argument equals this value, the warning is suppressed.
warn_once=Falseis passed, every call with a deprecated argument will log a warning. The default behavior is to only warn the first time the function is called with any given deprecated argument. All other kwargs raise
Decorated function or method.
ValueError: If date is not None or in ISO 8601 format, instructions are empty, the deprecated arguments are not present in the function signature, the second element of a deprecated_tuple is not a list, or if a kwarg other than