Skip to main content

arXiv slides Downloads

The Time Series Cluster Kernel (TCK) is a kernel similarity for multivariate time series with missing values. Once computed, the kernel can be used to perform tasks such as classification, clustering, and dimensionality reduction.


TCK is based on an ensemble of Gaussian Mixture Models (GMMs) for time series. The GMMs use time-varying means to handle time dependencies and informative Bayesian priors to handle missing values. The similarity between two time series is proportional to the number of times they are assigned to the same mixtures.

Installation

The recommended installation is with pip:

pip install tck

Alternatively, you can install the library from source:

git clone https://github.com/FilippoMB/https://github.com/FilippoMB/Time-Series-Cluster-Kernel.git
cd https://github.com/FilippoMB/Time-Series-Cluster-Kernel
pip install -e .

Quick start

The following scripts provide minimalistic examples that illustrate how to use the library for different tasks.

To run them, download the project and cd to the root folder:

git clone https://github.com/FilippoMB/https://github.com/FilippoMB/Time-Series-Cluster-Kernel.git
cd https://github.com/FilippoMB/Time-Series-Cluster-Kernel

Classification

python examples/classification.py

Clustering

python examples/clustering.py

The following notebooks illustrate more advanced use-cases.

  • Perform time series dimensionality reduction, cluster analysis, and visualize the results: view or Open In Colab

⚠ Running on Windows

TCK uses multiprocessing. While using multiprocessing in Python on Windows, it is necessary to protect the entry point of the program by using

if __name__ == '__main__':

Please, refer to the following examples.

Classification

python examples/classification_windows.py

Clustering

python examples/clustering_windows.py

Datasets

Data format

  • TCK works both with univariate and multivariate time series. The dataset must be stored in a numpy array of shape [N, T, V], where N is the number of variables, T is the number of time steps, and V is the number of variables (V=1 in the univariate case).
  • If the time series in the same dataset have a different number of time steps, T corresponds to the maximum length of the time series in the dataset. All the time series shorter than T should be padded with trailing zeros to match the dimension T. Alternatively, one can use interpolation to stretch the shorter time series up to length T.
  • The time series can contain missing data. Missing data dare indicated by entries np.nan in the data array.

Available datasets

There are several univariate and multivariate time series classification datasets immediately available for test and benchmarking purposes.

To list of available datasets can be retrieved as follows

from tck.datasets import DataLoader
downloader.available_datasets(details=True) # Leave at False to just get the names

A dataset can be loaded as follows

Xtr, Ytr, Xte, Yte = downloader.get_data('Japanese_Vowels')

Configuration and detailed usage

There are few hyperparameters that can be tuned to modify the TCK behavior.

tck = TCK(G, C)
  • G is the number of GMMs.
  • C is the number of components in the GMMs.

Usually, the higher the better but the computations take longer.

tck.fit(X, minN, minV, maxV, minT, maxT, I)

minN: Minimum percentage of samples to be used in the training of the GMMs. minV: Minimum number of attributes to be sampled from the dataset. maxV: Maximum number of attributes to be sampled from the dataset. minT: Minimum length of time segments to be sampled from the dataset. maxT: Maximum length of time segments to be sampled from the dataset. I: Number of iterations for the MAP-EM algorithm.

These parameters are usually less sensitive and can be left to their default value in most cases.

Ktr = tck.predict(mode='tr-tr')
Kte = tck.predict(Xte=Xte, mode='tr-te')
  • If mode='tr-tr', returns the similarity matrix between training samples, i.e., Ktr[i,j] is the similarity between time series i and j in the training set.
  • If mode='tr-te', it is necessary to pass the test set Xte as additional imput. The returned similarity matrix Kte[i,j] is the similarity between time series i in the test set and time series j in the training set.

Citation

Please, consider citing the original paper if you are using TCK in your reasearch.

@article{mikalsen2018time,
  title={Time series cluster kernel for learning similarities between multivariate time series with missing data},
  author={Mikalsen, Karl {\O}yvind and Bianchi, Filippo Maria and Soguero-Ruiz, Cristina and Jenssen, Robert},
  journal={Pattern Recognition},
  volume={76},
  pages={569--581},
  year={2018},
  publisher={Elsevier}
}

Metadata

Release files for tck 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tck 1.0.0
File Size Uploaded
tck-1.0.0.tar.gz 11.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tck 1.0.0
File Interpreter ABI Platform
tck-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 22.7 kB

Release files / tck-1.0.0.tar.gz

Download URL tck-1.0.0.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
40aaeed74c05462ba0922e4ee60e355a6849cb186f5a87df4ecadfcec2200e8c
BLAKE2b-256 checksum
How to use checksums
3d7de5d077216ac20d71e7e7f3f1c28bda75738d4c64bd3ba3233d317d2ace7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.14

Release files / tck-1.0.0-py3-none-any.whl

Download URL tck-1.0.0-py3-none-any.whl
Size 10.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dcaa59e944414acf1eac7377aee7cdc3ef75391667c394de5d06d6d0adcd02ce
BLAKE2b-256 checksum
How to use checksums
a9ba87de685aaaed225d46c4e25082f2e3950c1e2f96e933ebf05ac1bfaa6519
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.14

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4

2 release files

0.3

2 release files

0.2

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page