Skip to content

Commit b025009

Browse files
committed
Add reorder deprecation warning to auc docstring
1 parent 055e4f6 commit b025009

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

pytorch_lightning/metrics/functional/classification.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,9 @@ def auc(
806806
Args:
807807
x: x-coordinates
808808
y: y-coordinates
809-
reorder: reorder coordinates, so they are increasing
809+
reorder: reorder coordinates, so they are increasing. The unstable algorithm of torch.argsort is
810+
used internally to sort `x` which may in some cases cause inaccuracies in the result.
811+
WARNING: Deprecated and will be removed in v1.1.
810812
811813
Return:
812814
Tensor containing AUC score (float)

0 commit comments

Comments
 (0)