def auc(
x: torch.Tensor,
y: torch.Tensor,
) -> torch.Tensor:
"""
Computes Area Under the Curve (AUC) using the trapezoidal rule
.. warning :: Deprecated in favor of
:func:`~pytorch_lightning.metrics.functional.auc.auc`. Will be removed
in v1.4.0.
Args:
x: x-coordinates
y: y-coordinates
Return:
Tensor containing AUC score (float)
Example:
>>> x = torch.tensor([0, 1, 2, 3])
>>> y = torch.tensor([0, 1, 2, 2])
>>> auc(x, y)
tensor(4.)
"""
rank_zero_warn(
"This `auc` was deprecated in v1.2.0 in favor of"
" `pytorch_lightning.metrics.functional.auc import auc`."
" It will be removed in v1.4.0", DeprecationWarning)
return __auc(x, y)
def auc(
x: torch.Tensor,
y: torch.Tensor,
) -> torch.Tensor:
"""
.. deprecated::
Use :func:`torchmetrics.functional.auc`. Will be removed in v1.4.0.
"""
rank_zero_deprecation(
"This `auc` was deprecated in v1.2.0 in favor of"
" `pytorch_lightning.metrics.functional.auc import auc`."
" It will be removed in v1.4.0")
return __auc(x, y)