Clustering

The aeon.clustering module contains algorithms for time series clustering.

All clusterers in aeon can be listed using the aeon.utils.discovery .all_estimators function using type_filter="clusterer", optionally filtered by tags. Valid tags for clusterers can be found with aeon.utils.tags .all_tags_for_estimator function with the argument "clusterer".

Clustering Algorithms

KASBA([n_clusters, distance, ...])	KASBA clusterer [Rd394677c9e81-1].
KShape([n_clusters, init, n_init, max_iter, ...])	K-Shape [R589f27e526f4-1] clustering for equal-length time series.
TimeSeriesKMeans([n_clusters, init, ...])	Time series K-means clustering implementation.
TimeSeriesKMedoids([n_clusters, init, ...])	Time series K-medoids implementation.
TimeSeriesKShape(*args, **kwargs)	Kshape algorithm: wrapper of the tslearn implementation.
TimeSeriesKernelKMeans([n_clusters, kernel, ...])	Kernel K Means [R3e7c374b18c1-1]: wrapper of the tslearn implementation.
TimeSeriesCLARA([n_clusters, init, ...])	Time series CLARA implementation.
TimeSeriesCLARANS([n_clusters, init, ...])	Time series CLARANS implementation.
ElasticSOM([n_clusters, distance, init, ...])	Elastic Self-Organising Map (SOM) clustering algorithm.
KSpectralCentroid([n_clusters, max_shift, ...])	K-Spectral Centroid clustering implementation.

Deep learning

AEFCNClusterer([estimator, ...])	Auto-Encoder based Fully Convolutional Network (FCN), as described in [R4f194d8f8b22-1].
AEResNetClusterer([estimator, ...])	Auto-Encoder with Residual Network backbone for clustering.
AEDCNNClusterer([estimator, ...])	Auto-Encoder based Dilated Convolutional Networks (DCNN), as described in [R204885c824de-1].
AEDRNNClusterer([estimator, ...])	Auto-Encoder based Dilated Recurrent Neural Network (DRNN).
AEAttentionBiGRUClusterer([estimator, ...])	Auto-Encoder based Attention Bidirectional GRU Network.
AEBiGRUClusterer([estimator, ...])	Auto-Encoder based Bidirectional GRU Network.

Feature-based

Catch22Clusterer([features, catch24, ...])	Canonical Time-series Characteristics (catch22) clusterer.
SummaryClusterer([summary_stats, estimator, ...])	Summary statistic clusterer.
TSFreshClusterer([default_fc_parameters, ...])	Time Series Feature Extraction based on Scalable Hypothesis Tests clusterer.

Compose

ClustererPipeline(transformers, clusterer[, ...])

Pipeline of transformers and a clusterer.

Averaging

kasba_average(X[, init_barycenter, ...])	Compute the KASBA barycenter average of time series using an elastic distance [1]_.
elastic_barycenter_average(X[, distance, ...])	Compute the barycenter average of time series using an elastic distance.
mean_average(X)	Compute the mean average of time series.
petitjean_barycenter_average(X[, distance, ...])	Compute the barycenter average of time series using an elastic distance.
subgradient_barycenter_average(X[, ...])	Compute the stochastic subgradient barycenter average of time series.
shift_invariant_average(X[, initial_center, ...])	Shift-invariant average with parallel processing support.

Dummy

DummyClusterer([strategy, n_clusters, ...])

Dummy clustering for benchmarking purposes.

Base

BaseClusterer()

Abstract base class for time series clusterers.

BaseDeepClusterer([estimator, batch_size, ...])

Abstract base class for deep learning time series clusterers.