README.md

tsdistances

tsdistances is a Python library (with Rust backend) for computing various pairwise distances between sets of time series data. It provides efficient implementations of elastic distance measures such as Dynamic Time Warping (DTW), Longest Common Subsequence (LCSS), Time Warping Edit (TWE), and many others. The library is designed to be fast and scalable, leveraging parallel computation and GPU support via Vulkan for improved performance.

Features

• Multiple Distance Measures: Supports a wide range of time series distance measures:

  • Euclidean
  • CATCH22 Euclidean
  • Edit Distance with Real Penalty (ERP)
  • Longest Common Subsequence (LCSS)
  • Dynamic Time Warping (DTW)
  • Derivative Dynamic Time Warping (DDTW)
  • Weighted Dynamic Time Warping (WDTW)
  • Weighted Derivative Dynamic Time Warping (WDDTW)
  • Amerced Dynamic Time Warping (ADTW)
  • Move-Split-Merge (MSM)
  • Time Warp Edit Distance (TWE)
  • Shape-Based Distance (SBD)
  • MPDist

• Parallel Computation: Utilizes multiple CPU cores to speed up computations.

• GPU Acceleration: Optional GPU support using Vulkan for even faster computations.

Installation

From Source

To install tsdistances from source, follow these steps:

$ git clone https://github.com/albertoazzari/tsdistances/
$ cd tsdistances
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install maturin
$ maturin develop --release

PIP

If you use pip, you can install tsdistances with:

pip install tsdistances

Usage

Here's a basic example of using tsdistances to compute the Dynamic Time Warping (DTW) distance between two set of time series:

import numpy as np
import tsdistances

# Example usage of computing DTW distance
x1 = np.array([
    [1.0, 2.0, 3.0],
    [4.0, 5.0, 6.0]
])

x2 = np.array([
    [7.0, 8.0, 9.0],
    [10.0, 11.0, 12.0]
])

# Compute DTW distance
result = tsdistances.dtw(x1, x2, n_jobs=4, device='cpu')
print(result)