Skip to content

MAINT Parameters validation for metrics.dcg_score() #25749

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 4 commits into from
Mar 3, 2023
Merged

MAINT Parameters validation for metrics.dcg_score() #25749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
11d5d52
added parameter validation for metrics.dcg_score
Mar 2, 2023
e935322
changed Integral to import from numbers
Mar 2, 2023
034d692
changed sample_weight param description to array-like
Mar 2, 2023
ee8c1c3
Merge branch 'main' into val_dcg_score
jeremiedbb Mar 3, 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
20 changes: 15 additions & 5 deletions sklearn/metrics/_ranking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

import warnings
from functools import partial
from numbers import Real
from numbers import Real, Integral

import numpy as np
from scipy.sparse import csr_matrix, issparse
Expand All @@ -34,7 +34,7 @@
from ..utils.multiclass import type_of_target
from ..utils.extmath import stable_cumsum
from ..utils.sparsefuncs import count_nonzero
from ..utils._param_validation import validate_params, StrOptions
from ..utils._param_validation import validate_params, StrOptions, Interval
from ..exceptions import UndefinedMetricWarning
from ..preprocessing import label_binarize
from ..utils._encode import _encode, _unique
Expand Down Expand Up @@ -1445,6 +1445,16 @@ def _check_dcg_target_type(y_true):
)


@validate_params(
{
"y_true": ["array-like"],
"y_score": ["array-like"],
"k": [Interval(Integral, 1, None, closed="left"), None],
"log_base": [Interval(Real, 0.0, None, closed="neither")],
"sample_weight": ["array-like", None],
"ignore_ties": ["boolean"],
}
)
def dcg_score(
y_true, y_score, *, k=None, log_base=2, sample_weight=None, ignore_ties=False
):
Expand All @@ -1461,11 +1471,11 @@ def dcg_score(

Parameters
----------
y_true : ndarray of shape (n_samples, n_labels)
y_true : array-like of shape (n_samples, n_labels)
True targets of multilabel classification, or true scores of entities
to be ranked.

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, confidence values,
or non-thresholded measure of decisions (as returned by
"decision_function" on some classifiers).
Expand All @@ -1478,7 +1488,7 @@ def dcg_score(
Base of the logarithm used for the discount. A low value means a
sharper discount (top results are more important).

sample_weight : ndarray of shape (n_samples,), default=None
sample_weight : array-like of shape (n_samples,), default=None
Sample weights. If `None`, all samples are given the same weight.

ignore_ties : bool, default=False
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 @@ -124,6 +124,7 @@ def _check_function_param_validation(
"sklearn.metrics.confusion_matrix",
"sklearn.metrics.coverage_error",
"sklearn.metrics.d2_pinball_score",
"sklearn.metrics.dcg_score",
"sklearn.metrics.det_curve",
"sklearn.metrics.f1_score",
"sklearn.metrics.hamming_loss",
Expand Down