deprecated

paddle.utils. deprecated ( update_to: str = '', since: str = '', reason: str = '', level: int = 0 ) → Callable[[Callable[[_InputT], _RetT]], Callable[[_InputT], _RetT]] [source]

Decorate a function to signify its deprecation.

This function wraps a method that will soon be removed and does two things:

  • The docstring of the API will be modified to include a notice about deprecation.”

  • Raises a DeprecatedWarning when old API is called.

Parameters

  • since (str, optional) – The version at which the decorated method is considered deprecated.

  • update_to (str, optional) – The new API users should use.

  • reason (str, optional) – The reason why the API is deprecated.

  • level (int, optional) – The deprecated warning log level. It must be an Integer and must be one of 0, 1, 2. If level == 0, the warning message will not be showed. If level == 1, the warning message will be showed normally. If level == 2, it will raise RuntimeError.

Returns

decorated function or class.

Return type

decorator