mmengine.utils.deprecated_function

mmengine.utils.deprecated_function(since, removed_in, instructions)

Marks functions as deprecated.

Throw a warning when a deprecated function is called, and add a note in the docstring. Modified from https://github.com/pytorch/pytorch/blob/master/torch/onnx/_deprecation.py

Parameters:

• since (str) – The version when the function was first deprecated.

• removed_in (str) – The version when the function will be removed.

• instructions (str) – The action users should take.

Returns:

A new function, which will be deprecated soon.

Return type:

Callable