Skip to content

MAINT Parameters validation for affinity_propagation #24868

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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 20 additions & 1 deletion sklearn/cluster/_affinity_propagation.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
from ..exceptions import ConvergenceWarning
from ..base import BaseEstimator, ClusterMixin
from ..utils import as_float_array, check_random_state
from ..utils._param_validation import Interval, StrOptions
from ..utils._param_validation import Interval
from ..utils._param_validation import StrOptions
from ..utils._param_validation import validate_params
from ..utils.validation import check_is_fitted
from ..metrics import euclidean_distances
from ..metrics import pairwise_distances_argmin
Expand All @@ -34,6 +36,23 @@ def all_equal_similarities():
return all_equal_preferences() and all_equal_similarities()


@validate_params(
{
"S": ["array-like"],
"preference": [
"array-like",
Interval(Real, None, None, closed="neither"),
None,
],
"convergence_iter": [Interval(Integral, 1, None, closed="left")],
"max_iter": [Interval(Integral, 1, None, closed="left")],
"damping": [Interval(Real, 0.5, 1.0, closed="both")],
"copy": ["boolean"],
"verbose": ["boolean"],
"return_n_iter": ["boolean"],
"random_state": ["random_state"],
}
)
def affinity_propagation(
S,
*,
Expand Down
1 change: 1 addition & 0 deletions sklearn/tests/test_public_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

PARAM_VALIDATION_FUNCTION_LIST = [
"sklearn.cluster.kmeans_plusplus",
"sklearn.cluster.affinity_propagation",
]


Expand Down