W3cubDocs

/TensorFlow Python

tf.contrib.framework.deprecated

tf.contrib.framework.deprecated

deprecated(
    date,
    instructions
)

Defined in tensorflow/python/util/deprecation.py.

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:

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.

Returns:

Decorated function or method.

Raises:

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

© 2017 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/api_docs/python/tf/contrib/framework/deprecated