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

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

See the guide: Framework (contrib) > Deprecation

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.


  • 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.


Decorated function or method.


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

Defined in tensorflow/python/util/