Skip to content

MAINT Parameters validation for sklearn.metrics.silhouette_samples #26053

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 1 commit into from
Apr 3, 2023
Merged

MAINT Parameters validation for sklearn.metrics.silhouette_samples #26053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 12 additions & 0 deletions sklearn/metrics/cluster/_unsupervised.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,13 @@
from ...utils import check_random_state
from ...utils import check_X_y
from ...utils import _safe_indexing
from ...utils._param_validation import (
StrOptions,
validate_params,
)
from ..pairwise import pairwise_distances_chunked
from ..pairwise import pairwise_distances
from ..pairwise import _VALID_METRICS
from ...preprocessing import LabelEncoder


Expand Down Expand Up @@ -172,6 +177,13 @@ def _silhouette_reduce(D_chunk, start, labels, label_freqs):
return intra_cluster_distances, inter_cluster_distances


@validate_params(
{
"X": ["array-like", "sparse matrix"],
"labels": ["array-like"],
"metric": [StrOptions(set(_VALID_METRICS) | {"precomputed"}), callable],
}
)
def silhouette_samples(X, labels, *, metric="euclidean", **kwds):
"""Compute the Silhouette Coefficient for each sample.

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 @@ -170,6 +170,7 @@ def _check_function_param_validation(
"sklearn.metrics.classification_report",
"sklearn.metrics.cluster.adjusted_mutual_info_score",
"sklearn.metrics.cluster.contingency_matrix",
"sklearn.metrics.cluster.silhouette_samples",
"sklearn.metrics.cohen_kappa_score",
"sklearn.metrics.confusion_matrix",
"sklearn.metrics.coverage_error",
Expand Down