Shortcuts

mmengine.utils.deprecated_function

mmengine.utils.deprecated_function(since, removed_in, instructions)[source]

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

Read the Docs v: v0.8.3
Versions
latest
stable
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.0
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.