Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC Fix description of roc_auc_score for average=None #25779

Merged
merged 1 commit into from Mar 8, 2023

Conversation

adam-handke
Copy link
Contributor

Reference Issues/PRs

Fixes #25773

What does this implement/fix? Explain your changes.

Fixes documentation of sklearn.metrics.roc_auc_score for average=None parameter because it falsely stated that it only works with multi_class="ovo". In reality, a NotImplementedError is thrown when average=None and multi_class="ovo" (lines 681-684) but it works flawlessly with multi_class="ovr". Therefore, ovo should be changed to ovr in the docs.

Any other comments?

I wasted some time trying to use roc_auc_score according to documentation with average=None and multi_class="ovo" so I hope this fix saves somebody else's time.

@thomasjpfan thomasjpfan changed the title DOC Fix description of roc_auc_score for average=None (#25773) DOC Fix description of roc_auc_score for average=None Mar 8, 2023
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR! LGTM

@thomasjpfan thomasjpfan merged commit 451f212 into scikit-learn:main Mar 8, 2023
@thomasjpfan thomasjpfan mentioned this pull request Mar 8, 2023
12 tasks
@thomasjpfan thomasjpfan added the To backport PR merged in master that need a backport to a release branch defined based on the milestone. label Mar 8, 2023
@thomasjpfan thomasjpfan added this to the 1.2.2 milestone Mar 8, 2023
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation module:metrics To backport PR merged in master that need a backport to a release branch defined based on the milestone.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: roc_auc_score wrong description of average parameter with None value
2 participants