Deprecation

tf.contrib.framework.deprecated(date, instructions)

Decorator for marking functions or methods deprecated.

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:

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. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD).
  • instructions: String. Instructions on how to update code using the deprecated function.
Returns:

Decorated function or method.

Raises:
  • ValueError: If date is not in ISO 8601 format, or instructions are empty.

tf.contrib.framework.deprecated_args(date, instructions, *deprecated_arg_names)

Decorator for marking specific function arguments as deprecated.

This decorator logs a deprecation warning whenever the decorated function is called with the deprecated argument. It has the following format:

Calling (from ) with is deprecated and will be removed after . Instructions for updating:

will include the class name if it is a method.

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.

Args:
  • date: String. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD).
  • instructions: String. Instructions on how to update code using the deprecated function.
  • *deprecated_arg_names: String. The deprecated arguments.
Returns:

Decorated function or method.

Raises:
  • ValueError: If date is not in ISO 8601 format, instructions are empty, or the deprecated arguments are not present in the function signature.

tf.contrib.framework.deprecated_arg_values(date, instructions, **deprecated_kwargs)

Decorator for marking specific function argument values as deprecated.

This decorator logs a deprecation warning whenever the decorated function is called with the deprecated argument values. It has the following format:

Calling (from ) with = is deprecated and will be removed after . Instructions for updating:

will include the class name if it is a method.

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.

Args:
  • date: String. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD).
  • instructions: String. Instructions on how to update code using the deprecated function.
  • **deprecated_kwargs: The deprecated argument values.
Returns:

Decorated function or method.

Raises:
  • ValueError: If date is not in ISO 8601 format, or instructions are empty.