gemseo.mlearning.clustering.algos.base_clusterer module

The base class for clustering algorithms.

class BaseClusterer(data, settings_model=None, **settings)

Bases: BaseMLUnsupervisedAlgo

The base class for clustering algorithms.

Parameters:

• data (Dataset) -- The learning dataset.

• settings_model (BaseMLAlgoSettings | None) -- The machine learning algorithm settings as a Pydantic model. If None, use **settings.

• **settings (Any) -- The machine learning algorithm settings. These arguments are ignored when settings_model is not None.

Raises:

ValueError -- When both the variable and the group it belongs to have a transformer.

Settings

alias of BaseClustererSettings

labels: ndarray

The labels of the clusters for the different samples.

This attribute is set when calling learn().

n_clusters: int

The number of clusters.

This attribute is set when calling learn().