Skip to content

MAINT Parameters validation for metrics.hinge_loss #25880

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 17, 2023
Merged

MAINT Parameters validation for metrics.hinge_loss #25880

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
d2982eb
MAINT Parameters validation for metrics.hinge_loss
bharatr21 Mar 16, 2023
dac05c0
MAINT Add to list of public test functions
bharatr21 Mar 16, 2023
5a30df3
Merge branch 'main' into param-validate-metrics
bharatr21 Mar 16, 2023
20b2955
Update _classification.py
jeremiedbb Mar 17, 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
12 changes: 10 additions & 2 deletions sklearn/metrics/_classification.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2864,6 +2864,14 @@ def log_loss(
return _weighted_sum(loss, sample_weight, normalize)


@validate_params(
{
"y_true": ["array-like"],
"pred_decision": ["array-like"],
"labels": ["array-like", None],
"sample_weight": ["array-like", None],
}
)
def hinge_loss(y_true, pred_decision, *, labels=None, sample_weight=None):
"""Average hinge loss (non-regularized).

Expand All @@ -2883,11 +2891,11 @@ def hinge_loss(y_true, pred_decision, *, labels=None, sample_weight=None):

Parameters
----------
y_true : array of shape (n_samples,)
y_true : array-like of shape (n_samples,)
True target, consisting of integers of two values. The positive label
must be greater than the negative label.

pred_decision : array of shape (n_samples,) or (n_samples, n_classes)
pred_decision : array-like of shape (n_samples,) or (n_samples, n_classes)
Predicted decisions, as output by decision_function (floats).

labels : array-like, default=None
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 @@ -163,6 +163,7 @@ def _check_function_param_validation(
"sklearn.metrics.fbeta_score",
"sklearn.metrics.get_scorer",
"sklearn.metrics.hamming_loss",
"sklearn.metrics.hinge_loss",
"sklearn.metrics.jaccard_score",
"sklearn.metrics.label_ranking_average_precision_score",
"sklearn.metrics.label_ranking_loss",
Expand Down