# tf.contrib.framework.deprecated

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/util/deprecation.py#L274-L329) |

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.

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| Decorated function or method. ||

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | If date is not None or in ISO 8601 format, or instructions are empty. |

<br />