API Replace y_pred with y_score in DetCurveDisplay #31764

luiser1401 · 2025-07-15T19:49:06Z

This PR replaces y_pred with y_score in the DetCurveDisplay class. This change was made to follow the pattern in RocCurveDisplay.

Fixes: #31761

github-actions · 2025-07-15T19:50:00Z

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: 901eda2. Link to the linter CI: here}

lucyleeow

Thanks @luiser1401 , just some suggestions.

CI failure is unrelated (we're working on fixing).

lucyleeow · 2025-07-17T04:07:19Z

sklearn/metrics/_plot/det_curve.py

+        if y_score is not None and not (
+            isinstance(y_pred, str) and y_pred == "deprecated"
+        ):
+            raise ValueError(
+                "`y_pred` and `y_score` cannot be both specified. Please use `y_score`"
+                " only as `y_pred` is deprecated in 1.7 and will be removed in 1.9."
+            )
+        if not (isinstance(y_pred, str) and y_pred == "deprecated"):
+            warnings.warn(
+                (
+                    "y_pred is deprecated in 1.7 and will be removed in 1.9. "
+                    "Please use `y_score` instead."
+                ),
+                FutureWarning,
+            )
+            y_score = y_pred


Let's refactor this out to sklearn/utils/_plotting.py and it can be used for precision recall, ROC and DET displays

lucyleeow · 2025-07-17T04:10:45Z

doc/whats_new/upcoming_changes/sklearn.metrics/31764.fix.rst

+- :func:`metrics._plot.det_curve.DetCurveDisplay.from_predictions` y_pred parameter is deprecated and will be removed
+    in v1.9. It has been replaced by y_score.
+- :func:`metrics._plot.precision_recall_curve.PrecisionRecallDisplay.from_predictions` y_pred parameter is deprecated
+    and will be removed in v1.9. It has been replaced by y_score.
+  By :user:`Luis <luiser1401>`


What about:

Suggested change

- :func:`metrics._plot.det_curve.DetCurveDisplay.from_predictions` y_pred parameter is deprecated and will be removed

in v1.9. It has been replaced by y_score.

- :func:`metrics._plot.precision_recall_curve.PrecisionRecallDisplay.from_predictions` y_pred parameter is deprecated

and will be removed in v1.9. It has been replaced by y_score.

By :user:`Luis <luiser1401>`

- `y_pred` is deprecated in favour of `y_score` in :func:`metrics.DetCurveDisplay.from_predictions`

and :func:`metrics.PrecisionRecallDisplay.from_predictions`. Both will be removed

in v1.10.

By :user:`Luis <luiser1401>`

Can't tell if lines are under 88 characters but please check this.
I think we're at v1.8 so removal will in in 2 versions, 1.10

Will check line lenghts and structure the log how you suggested, however the last release is 1.7 on Jun 6th

lucyleeow · 2025-07-17T04:12:36Z

sklearn/metrics/_plot/tests/test_det_curve_display.py

+def test_y_score_and_y_pred_specified_error():
+    """Check that an error is raised when both y_score and y_pred are specified."""
+    y_true = np.array([0, 1, 1, 0])
+    y_score = np.array([0.1, 0.4, 0.35, 0.8])
+    y_pred = np.array([0.2, 0.3, 0.5, 0.1])
+
+    with pytest.raises(
+        ValueError, match="`y_pred` and `y_score` cannot be both specified"
+    ):
+        DetCurveDisplay.from_predictions(y_true, y_score=y_score, y_pred=y_pred)
+
+
+# TODO(1.9): remove
+def test_y_pred_deprecation_warning(pyplot):


I think these can be one test, that checks deprecation of y_pred

lucyleeow · 2025-07-17T04:14:27Z

sklearn/metrics/_plot/tests/test_det_curve_display.py

+        display_y_pred = DetCurveDisplay.from_predictions(y_true, y_pred=y_score)
+
+    assert_allclose(
+        display_y_pred.fpr, [5.000000e-01, 5.000000e-01, 5.000000e-01, 2.220446e-16]


I think we only need to test one of fpr or fnr to ensure that we are passing y_pred through correctly.
Maybe instead of hard coding the numbers we can just calculate them using det_curve?

I've deleted hardcoded values for these kind of test in al three classes.

jeremiedbb

Thanks for the PR @luiser1401. Here are some comments

sklearn/metrics/_plot/det_curve.py

sklearn/metrics/_plot/precision_recall_curve.py

sklearn/metrics/_plot/tests/test_det_curve_display.py

sklearn/metrics/_plot/tests/test_precision_recall_display.py

jeremiedbb · 2025-07-18T13:22:22Z

sklearn/utils/_plotting.py

+# TODO(1.9): remove after the end of the deprecation period of `y_pred`
+def _deprecate_y_pred_parameter(y_score, y_pred):
+    """Deprecate `y_pred` in favour of of `y_score`."""
+    if y_score is not None and not (isinstance(y_pred, str) and y_pred == "deprecated"):
+        raise ValueError(
+            "`y_pred` and `y_score` cannot be both specified. Please use `y_score`"
+            " only as `y_pred` is deprecated in 1.7 and will be removed in 1.10."
+        )
+    if not (isinstance(y_pred, str) and y_pred == "deprecated"):
+        warnings.warn(
+            (
+                "y_pred is deprecated in 1.7 and will be removed in 1.10. "
+                "Please use `y_score` instead."
+            ),
+            FutureWarning,
+        )
+        return y_pred
+
+    return y_score


For RocCurveDisplay, the deprecation happened in 1.7 but the deprecations of this PR will be released with 1.8, so we need to add a version argument to this function.

sklearn/utils/_plotting.py

doc/whats_new/upcoming_changes/sklearn.metrics/31764.fix.rst

sklearn/metrics/_plot/precision_recall_curve.py

sklearn/metrics/_plot/tests/test_det_curve_display.py

sklearn/metrics/_plot/tests/test_precision_recall_display.py

sklearn/utils/_plotting.py

jeremiedbb

LGTM. Thanks @luiser1401

lucyleeow

LGTM, just a nitpick on wording but I'm fine for this to go in as is

sklearn/metrics/_plot/det_curve.py

replace y_pred with y_score

85239d0

github-actions bot added module:metrics Documentation labels Jul 15, 2025

luiser1401 changed the title ~~DOC: Replace y_pred with y_score in DetCurveDisplay (issue: 31761)~~ FIX: Replace y_pred with y_score in DetCurveDisplay (issue: 31761) Jul 15, 2025

luiser1401 added 5 commits July 15, 2025 20:54

update tests

80fec6d

extend tests

2ab1387

add changelog

c64e675

final update to test

3fafa6e

change y_pred to y_score in precision_recall_curve.py

291a1b6

luiser1401 mentioned this pull request Jul 16, 2025

y_pred changed to y_true in RocCurveDisplay.from_predictions, but not in DetCurveDisplay.from_predictions #31761

Closed

lucyleeow reviewed Jul 17, 2025

View reviewed changes

luiser1401 added 5 commits July 17, 2025 13:57

refactor deprecation warning

ab89f6c

change versioning in todo

48383ca

reformat changelog

5655d1f

merge tests

a4ae098

delete hardcoded values from tests

d98568f

luiser1401 requested a review from lucyleeow July 17, 2025 14:18

jeremiedbb reviewed Jul 18, 2025

View reviewed changes

luiser1401 added 3 commits July 21, 2025 12:59

add review changes

8107e49

cleanup version parameter

5032158

update docstrings

e227fc3

luiser1401 requested a review from jeremiedbb July 21, 2025 12:19

jeremiedbb changed the title ~~FIX: Replace y_pred with y_score in DetCurveDisplay (issue: 31761)~~ API Replace y_pred with y_score in DetCurveDisplay Jul 21, 2025

jeremiedbb reviewed Jul 21, 2025

View reviewed changes

luiser1401 added 2 commits July 21, 2025 15:40

update based on review

603d425

delte unsued variable

3119c7b

luiser1401 requested a review from jeremiedbb July 21, 2025 14:41

jeremiedbb added 2 commits July 22, 2025 12:43

fix CI

88d34a7

fix last one

68d74ba

jeremiedbb approved these changes Jul 22, 2025

View reviewed changes

jeremiedbb added the Waiting for Second Reviewer First reviewer is done, need a second one! label Jul 22, 2025

jeremiedbb added this to the 1.8 milestone Jul 22, 2025

lucyleeow approved these changes Jul 24, 2025

View reviewed changes

sklearn/metrics/_plot/det_curve.py Show resolved Hide resolved

luiser1401 added 2 commits July 24, 2025 09:02

Merge branch 'main' into solve-issue-luis

6df5d48

Merge branch 'main' into solve-issue-luis

901eda2

jeremiedbb merged commit 91486d6 into scikit-learn:main Jul 25, 2025
36 checks passed

Uh oh!

API Replace y_pred with y_score in DetCurveDisplay #31764

API Replace y_pred with y_score in DetCurveDisplay #31764

Uh oh!

Conversation

luiser1401 commented Jul 15, 2025

Uh oh!

github-actions bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✔️ Linting Passed

Uh oh!

lucyleeow left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lucyleeow Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

lucyleeow Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

luiser1401 Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

lucyleeow Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

lucyleeow Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

luiser1401 Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

jeremiedbb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeremiedbb Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeremiedbb left a comment

Choose a reason for hiding this comment

Uh oh!

lucyleeow left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 15, 2025 •

edited

Loading

lucyleeow left a comment •

edited

Loading