DOC Specify the meaning of scoring=None in sklearn.metrics.check_scoring #20367
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
amueller
reviewed
Jun 26, 2021
sklearn/metrics/_scorer.py
Outdated
| @@ -432,6 +432,7 @@ def check_scoring(estimator, scoring=None, *, allow_none=False): | |||
| A string (see model evaluation documentation) or | |||
| a scorer callable object / function with signature | |||
| ``scorer(estimator, X, y)``. | |||
| If None, the provided estimator object's scoring method is used. | |||
There was a problem hiding this comment.
It should probably be score method, with ticks, to be really explicit?
There was a problem hiding this comment.
that makes sense! I'll change it
There was a problem hiding this comment.
just done it @amueller . thanks for the feedback!
amueller
reviewed
Jun 26, 2021
sklearn/metrics/_scorer.py
Outdated
| @@ -432,6 +432,7 @@ def check_scoring(estimator, scoring=None, *, allow_none=False): | |||
| A string (see model evaluation documentation) or | |||
| a scorer callable object / function with signature | |||
| ``scorer(estimator, X, y)``. | |||
| If None, the provided estimator object's 'score' method is used. | |||
There was a problem hiding this comment.
Sorry for being unclear, I think it should be backticks, which will make it be rendered as code. `score`
There was a problem hiding this comment.
no problem, i fixed it!
thomasjpfan
approved these changes
Jun 26, 2021
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
Partially addresses #17295.
What does this implement/fix? Explain your changes.
This PR specifies the meaning of
scoring=Nonefor the functioncheck_scoringin thesklearn.metrics._scorermodule.#DataUmbrella sprint