aub_htp.machine_learning.kmeans.AlphaStableKMeans#

class aub_htp.machine_learning.kmeans.AlphaStableKMeans(n_clusters: int = 8, alpha: float = 1.0, *, max_iter: int = 100, tol: float = 1e-06)#

Bases: ClusterMixin, BaseEstimator

__init__(n_clusters: int = 8, alpha: float = 1.0, *, max_iter: int = 100, tol: float = 1e-06)#

Methods

__init__([n_clusters, alpha, max_iter, tol])

fit(X[, y])

fit_predict(X[, y])

Perform clustering on X and returns cluster labels.

get_metadata_routing()

Get metadata routing of this object.

get_params([deep])

Get parameters for this estimator.

predict(X)

score(X[, y, sample_weight])

set_params(**params)

Set the parameters of this estimator.

set_score_request(*[, sample_weight])

Configure whether metadata should be requested to be passed to the score method.
fit(X, y=None)#
predict(X)#
score(X, y=None, sample_weight=None)#
set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → AlphaStableKMeans#

Configure whether metadata should be requested to be passed to the score method.

Note that this method is only relevant when this estimator is used as a sub-estimator within a meta-estimator and metadata routing is enabled with enable_metadata_routing=True (see sklearn.set_config()). Please check the User Guide on how the routing mechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed to score if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it to score.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Parameters#

sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for sample_weight parameter in score.

Returns#

selfobject

The updated object.