Clustering

This module contains the base classes for clustering algorithms.

The cluster module implements the concept of clustering models, a kind of unsupervised machine learning algorithm where the goal is to group data into clusters. Wherever possible, these methods should be able to predict the class of the new data, as well as the probability of belonging to each class.

This concept is implemented through the MLClusteringAlgo class, which inherits from the MLUnsupervisedAlgo class, and through the MLPredictiveClusteringAlgo class which inherits from MLClusteringAlgo.

Classes:

MLClusteringAlgo(data[, transformer, var_names])

Clustering algorithm.

MLPredictiveClusteringAlgo(data[, ...])

Predictive clustering algorithm.

class gemseo.mlearning.cluster.cluster.MLClusteringAlgo(data, transformer=None, var_names=None, **parameters)[source]

Clustering algorithm.

The inheriting classes shall overload the MLUnsupervisedAlgo._fit() method.

learning_set

The learning dataset.

Type

Dataset

parameters

The parameters of the machine learning algorithm.

Type

Dict[str,MLAlgoParameterType]

transformer

The strategies to transform the variables. The values are instances of Transformer while the keys are the names of either the variables or the groups of variables, e.g. “inputs” or “outputs” in the case of the regression algorithms. If a group is specified, the Transformer will be applied to all the variables of this group. If None, do not transform the variables.

Type

Dict[str,Transformer]

algo

The interfaced machine learning algorithm.

Type

Any

input_names

The names of the variables.

Type

List[str]

labels

The indices of the clusters for the different samples.

Type

List(int)

n_clusters

The number of clusters.

Type

int

Parameters
  • data (Dataset) – The learning dataset.

  • transformer (Mapping[str, TransformerType] | None) –

    The strategies to transform the variables. The values are instances of Transformer while the keys are the names of either the variables or the groups of variables, e.g. “inputs” or “outputs” in the case of the regression algorithms. If a group is specified, the Transformer will be applied to all the variables of this group. If None, do not transform the variables.

    By default it is set to None.

  • var_names (Iterable[str] | None) –

    The names of the variables. If None, consider all variables mentioned in the learning dataset.

    By default it is set to None.

  • **parameters (MLAlgoParameterType) – The parameters of the machine learning algorithm.

Raises

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

Classes:

DataFormatters()

Decorators for the internal MLAlgo methods.

Attributes:

is_trained

Return whether the algorithm is trained.

learning_samples_indices

The indices of the learning samples used for the training.

Methods:

learn([samples, fit_transformers])

Train the machine learning algorithm from the learning dataset.

load_algo(directory)

Load a machine learning algorithm from a directory.

save([directory, path, save_learning_set])

Save the machine learning algorithm.

class DataFormatters

Decorators for the internal MLAlgo methods.

Noindex

property is_trained: bool

Return whether the algorithm is trained.

learn(samples=None, fit_transformers=True)

Train the machine learning algorithm from the learning dataset.

Parameters
  • samples (Sequence[int] | None) –

    The indices of the learning samples. If None, use the whole learning dataset.

    By default it is set to None.

  • fit_transformers (bool) –

    Whether to fit the variable transformers.

    By default it is set to True.

Return type

None

property learning_samples_indices: Sequence[int]

The indices of the learning samples used for the training.

load_algo(directory)

Load a machine learning algorithm from a directory.

Parameters

directory (str | Path) – The path to the directory where the machine learning algorithm is saved.

Return type

None

save(directory=None, path='.', save_learning_set=False)

Save the machine learning algorithm.

Parameters
  • directory (str | None) –

    The name of the directory to save the algorithm.

    By default it is set to None.

  • path (str | Path) –

    The path to parent directory where to create the directory.

    By default it is set to ..

  • save_learning_set (bool) –

    Whether to save the learning set or get rid of it to lighten the saved files.

    By default it is set to False.

Returns

The path to the directory where the algorithm is saved.

Return type

str

class gemseo.mlearning.cluster.cluster.MLPredictiveClusteringAlgo(data, transformer=None, var_names=None, **parameters)[source]

Predictive clustering algorithm.

The inheriting classes shall overload the MLUnsupervisedAlgo._fit() method, and the MLClusteringAlgo._predict() and MLClusteringAlgo._predict_proba() methods if possible.

learning_set

The learning dataset.

Type

Dataset

parameters

The parameters of the machine learning algorithm.

Type

Dict[str,MLAlgoParameterType]

transformer

The strategies to transform the variables. The values are instances of Transformer while the keys are the names of either the variables or the groups of variables, e.g. “inputs” or “outputs” in the case of the regression algorithms. If a group is specified, the Transformer will be applied to all the variables of this group. If None, do not transform the variables.

Type

Dict[str,Transformer]

algo

The interfaced machine learning algorithm.

Type

Any

input_names

The names of the variables.

Type

List[str]

labels

The indices of the clusters for the different samples.

Type

List(int)

n_clusters

The number of clusters.

Type

int

Parameters
  • data (Dataset) – The learning dataset.

  • transformer (Mapping[str, TransformerType] | None) –

    The strategies to transform the variables. The values are instances of Transformer while the keys are the names of either the variables or the groups of variables, e.g. “inputs” or “outputs” in the case of the regression algorithms. If a group is specified, the Transformer will be applied to all the variables of this group. If None, do not transform the variables.

    By default it is set to None.

  • var_names (Iterable[str] | None) –

    The names of the variables. If None, consider all variables mentioned in the learning dataset.

    By default it is set to None.

  • **parameters (MLAlgoParameterType) – The parameters of the machine learning algorithm.

Raises

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

Classes:

DataFormatters()

Decorators for the internal MLAlgo methods.

Attributes:

is_trained

Return whether the algorithm is trained.

learning_samples_indices

The indices of the learning samples used for the training.

Methods:

learn([samples, fit_transformers])

Train the machine learning algorithm from the learning dataset.

load_algo(directory)

Load a machine learning algorithm from a directory.

predict(data)

Predict the clusters from the input data.

predict_proba(data[, hard])

Predict the probability of belonging to each cluster from input data.

save([directory, path, save_learning_set])

Save the machine learning algorithm.

class DataFormatters

Decorators for the internal MLAlgo methods.

Noindex

property is_trained: bool

Return whether the algorithm is trained.

learn(samples=None, fit_transformers=True)

Train the machine learning algorithm from the learning dataset.

Parameters
  • samples (Sequence[int] | None) –

    The indices of the learning samples. If None, use the whole learning dataset.

    By default it is set to None.

  • fit_transformers (bool) –

    Whether to fit the variable transformers.

    By default it is set to True.

Return type

None

property learning_samples_indices: Sequence[int]

The indices of the learning samples used for the training.

load_algo(directory)

Load a machine learning algorithm from a directory.

Parameters

directory (str | Path) – The path to the directory where the machine learning algorithm is saved.

Return type

None

predict(data)[source]

Predict the clusters from the input data.

The user can specify these input data either as a NumPy array, e.g. array([1., 2., 3.]) or as a dictionary, e.g. {'a': array([1.]), 'b': array([2., 3.])}.

If the numpy arrays are of dimension 2, their i-th rows represent the input data of the i-th sample; while if the numpy arrays are of dimension 1, there is a single sample.

The type of the output data and the dimension of the output arrays will be consistent with the type of the input data and the dimension of the input arrays.

Parameters

data (DataType) – The input data.

Returns

The predicted cluster for each input data sample.

Return type

int | ndarray

predict_proba(data, hard=True)[source]

Predict the probability of belonging to each cluster from input data.

The user can specified these input data either as a numpy array, e.g. array([1., 2., 3.]) or as a dictionary, e.g. {'a': array([1.]), 'b': array([2., 3.])}.

If the numpy arrays are of dimension 2, their i-th rows represent the input data of the i-th sample; while if the numpy arrays are of dimension 1, there is a single sample.

The dimension of the output array will be consistent with the dimension of the input arrays.

Parameters
  • data (Union[numpy.ndarray, Mapping[str, numpy.ndarray]]) – The input data.

  • hard (bool) –

    Whether clustering should be hard (True) or soft (False).

    By default it is set to True.

Returns

The probability of belonging to each cluster, with shape (n_samples, n_clusters) or (n_clusters,).

Return type

numpy.ndarray

save(directory=None, path='.', save_learning_set=False)

Save the machine learning algorithm.

Parameters
  • directory (str | None) –

    The name of the directory to save the algorithm.

    By default it is set to None.

  • path (str | Path) –

    The path to parent directory where to create the directory.

    By default it is set to ..

  • save_learning_set (bool) –

    Whether to save the learning set or get rid of it to lighten the saved files.

    By default it is set to False.

Returns

The path to the directory where the algorithm is saved.

Return type

str

Available clustering models are:

Examples

Development