DOC Fix pos_label docstring in Display classes
#31696
Open
+6
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
virchan
reviewed
Jul 5, 2025
sklearn/metrics/_plot/roc_curve.py
Outdated
| @@ -72,8 +72,7 @@ class RocCurveDisplay(_BinaryClassifierCurveDisplayMixin): | |||
|
|
|||
| pos_label : int, float, bool or str, default=None | |||
| The class considered as the positive class when computing the roc auc | |||
| metrics. By default, `estimators.classes_[1]` is considered | |||
| as the positive class. | |||
| metrics. Used for labelling the axes. If `None`, not included in labels. | |||
There was a problem hiding this comment.
I was a bit confused by the wording until I ran some experiments in Jupyter. 😅
What do you think about:
Suggested change
| metrics. Used for labelling the axes. If `None`, not included in labels. | |
| metrics. If not `None`, this value is displayed in the x- and y-axis labels. |
There was a problem hiding this comment.
This is MUCH better. I didn't like what I had but I couldn't think of how to improve. Let me update other docstrings to say something along these lines too, as it would be nice to know what pos_label is actually doing - just updating figure labels!
pos_label docstring in RocCurveDisplaypos_label docstring in Display classes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Noticed when working on #28972
Specify that
pos_labelfrom init is used to label the x and y axes. Fixes some inaccuracies:pos_labelparameter in display class init is not able to be inferpos_label(as it does not have access to estimator or predictions).Fix docstrings accordingly.
What does this implement/fix? Explain your changes.
Any other comments?