MAINT Parameters validation for sklearn.metrics.adjusted_rand_score (s…

…cikit-learn#26134) Co-authored-by: Jérémie du Boisberranger <[email protected]>
neurodata · Apr 12, 2023 · 3023f19 · 3023f19
1 parent c8fb561
commit 3023f19
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/sklearn/metrics/cluster/_supervised.py b/sklearn/metrics/cluster/_supervised.py
@@ -325,6 +325,12 @@ def rand_score(labels_true, labels_pred):
  return numerator / denominator
 
 
+@validate_params(
+ {
+ "labels_true": ["array-like"],
+ "labels_pred": ["array-like"],
+ }
+)
 def adjusted_rand_score(labels_true, labels_pred):
  """Rand index adjusted for chance.
 
@@ -352,10 +358,10 @@ def adjusted_rand_score(labels_true, labels_pred):
 
  Parameters
  ----------
- labels_true : int array, shape = [n_samples]
+ labels_true : array-like of shape (n_samples,), dtype=int
  Ground truth class labels to be used as a reference.
 
- labels_pred : array-like of shape (n_samples,)
+ labels_pred : array-like of shape (n_samples,), dtype=int
  Cluster labels to evaluate.
 
  Returns

diff --git a/sklearn/tests/test_public_functions.py b/sklearn/tests/test_public_functions.py
@@ -209,6 +209,7 @@ def _check_function_param_validation(
  "sklearn.metrics.mutual_info_score",
  "sklearn.metrics.ndcg_score",
  "sklearn.metrics.pair_confusion_matrix",
+ "sklearn.metrics.adjusted_rand_score",
  "sklearn.metrics.pairwise.additive_chi2_kernel",
  "sklearn.metrics.pairwise.cosine_distances",
  "sklearn.metrics.pairwise.cosine_similarity",