Skip to content

MAINT Parameters validation for metrics.label_ranking_loss() #25742

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 2, 2023
Merged

MAINT Parameters validation for metrics.label_ranking_loss() #25742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81bc116
added parameter validation for metrics.label_ranking_loss
Mar 2, 2023
b785d73
fix docstring
jeremiedbb Mar 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions sklearn/metrics/_ranking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1224,6 +1224,13 @@ def coverage_error(y_true, y_score, *, sample_weight=None):
return np.average(coverage, weights=sample_weight)


@validate_params(
{
"y_true": ["array-like", "sparse matrix"],
"y_score": ["array-like"],
"sample_weight": ["array-like", None],
}
)
def label_ranking_loss(y_true, y_score, *, sample_weight=None):
"""Compute Ranking loss measure.

Expand All @@ -1242,10 +1249,10 @@ def label_ranking_loss(y_true, y_score, *, sample_weight=None):

Parameters
----------
y_true : {ndarray, sparse matrix} of shape (n_samples, n_labels)
y_true : {array-like, sparse matrix} of shape (n_samples, n_labels)
True binary labels in binary indicator format.

y_score : ndarray of shape (n_samples, n_labels)
y_score : array-like of shape (n_samples, n_labels)
Target scores, can either be probability estimates of the positive
class, confidence values, or non-thresholded measure of decisions
(as returned by "decision_function" on some classifiers).
Expand Down
1 change: 1 addition & 0 deletions sklearn/tests/test_public_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ def _check_function_param_validation(
"sklearn.metrics.f1_score",
"sklearn.metrics.hamming_loss",
"sklearn.metrics.jaccard_score",
"sklearn.metrics.label_ranking_loss",
"sklearn.metrics.log_loss",
"sklearn.metrics.matthews_corrcoef",
"sklearn.metrics.max_error",
Expand Down