gemseo.mlearning.clustering.algos.kmeans module#

The k-means algorithm for clustering.

The k-means algorithm groups the data into clusters, where the number of clusters \(k\) is fixed. This is done by initializing \(k\) centroids in the design space. The points are grouped into clusters according to their nearest centroid.

When fitting the algorithm, each centroid is successively moved to the mean of its corresponding cluster, and the cluster value of each point is then reset to the cluster value of the closest centroid. This process is repeated until convergence.

Cluster values of new points may be predicted by returning the value of the closest centroid. Denoting \((c_1, \\cdots, c_k) \\in \\mathbb{R}^{n \\times k}\) the centroids, and assuming no overlap between the centroids, we may compute the prediction

\[\begin{split}\\operatorname{cluster}(x) = \\underset{i=1,\\cdots,k}{\\operatorname{argmin}} \\|x-c_i\\|.\end{split}\]

A probability measure may also be provided, using the distances from the point to each of the centroids:

\[\begin{split}\\mathbb{P}(x \\in C_i) = \\begin{cases} 1 & \\operatorname{if} x = c_i\\\\ 0 & \\operatorname{if} x = c_j,\\ j \\neq i\\\\ \\frac{\\frac{1}{\\|x-c_i\\|}}{\\sum_{j=1}^k \\frac{1}{\\|x-c_j\\|}} & \\operatorname{if} x \\neq c_j\\, \\forall j=1,\\cdots,k \\end{cases},\end{split}\]

where \(C_i = \\{x\\, | \\, \\operatorname{cluster}(x) = i \\}\). Here, \(\\mathbb{P}(x \\in C_i)\) represents the probability of cluster \(i\) given the point \(x\).

This concept is implemented through the KMeans class which inherits from the BaseClusterer class.

Dependence#

This clustering algorithm relies on the KMeans class of the scikit-learn library.

class KMeans(data, settings_model=None, **settings)[source]#

Bases: BasePredictiveClusterer

The k-means clustering algorithm.

Parameters:

  • data (Dataset) -- The training 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 KMeans_Settings

EPS = 2.220446049250313e-16#
LIBRARY: ClassVar[str] = 'scikit-learn'#

The name of the library of the wrapped machine learning algorithm.

SHORT_ALGO_NAME: ClassVar[str] = 'KMeans'#

The short name of the machine learning algorithm, often an acronym.

Typically used for composite names, e.g. f"{algo.SHORT_ALGO_NAME}_{dataset.name}" or f"{algo.SHORT_ALGO_NAME}_{discipline.name}".