flowsom.models.BaseClusterEstimator

flowsom.models.BaseClusterEstimator#

class flowsom.models.BaseClusterEstimator#

Base class for all cluster estimators in FlowSOM.

Methods table#

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.

set_params(**params)

Set the parameters of this estimator.

Methods#

BaseClusterEstimator.fit_predict(X, y=None, **kwargs)#

Perform clustering on X and returns cluster labels.

Parameters:

  • X (array-like of shape (n_samples, n_features)) – Input data.

  • y (Ignored) – Not used, present for API consistency by convention.

  • **kwargs (dict) –

    Arguments to be passed to fit.

    Added in version 1.4.

Returns:

labels : ndarray of shape (n_samples,), dtype=np.int64 Cluster labels.

BaseClusterEstimator.get_metadata_routing()#

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:

-routing (MetadataRequest) A MetadataRequest encapsulating routing information.

BaseClusterEstimator.get_params(deep=True)#

Get parameters for this estimator.

Parameters:

deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

-params (dict) Parameter names mapped to their values.

BaseClusterEstimator.set_params(**params)#

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**params (dict) – Estimator parameters.

Returns:

self : estimator instance Estimator instance.

Contents