Skip to main content

Interval ERAL Algorithm and application to Evolving Clustering

Introduction

The iERAL (Interval Error In Alignment) algorithm is a state-of-the-art method designed for online time series alignment and averaging. The method obtains the average time series (the prototype) from a set of time series (a class).

Installation

To use iERAL, please install the package from pypi.org using pip:

pip install ieral

Usage

The main entry point for the end user is Cluster class in ieral.ieral:

from ieral.ieral import Cluster as iERAL

ieral = iERAL(sample=initial_sample, id=0)

The class constructor accepts two parameters:

  • sample - the initial sample to be used for the prototype calculation
  • id - the class identifier

The basic function call is:

import numpy as np
from ieral.ieral import Cluster as iERAL

data: list[np.ndarray] = [...]

ieral: iERAL = iERAL(sample=data[0], id=id, alpha=0.5)
for sample in data[1:]:
    ieral.add_sample(sample=sample)

prototype = ieral.prototype
    

For full examples, please refer to the examples/ directory at our repository.

Demonstration

The following figure demonstrates iERAL algorithm on a set of time series from the Trace dataset from UCR Archive. The dataset contains 100 time series, each with 275 samples. The time series are aligned and averaged using iERAL, and the resulting prototype is shown in the figure. iERAL demonstration

Examples

The examples/ directory at our repository. contains Jupyter notebooks that illustrate different uses and capabilities of the iERAL algorithm. To run an example, navigate to the examples/ directory and execute the desired notebook.

  • Notebook titled 01 iERAL demo demonstrates the iERAL prototyping method using the Trace dataset from UCR Archive.
  • Notebook titled 02 iERAL demo on industrial data downloads an industrial dataset from Mendeley Data [2], and calculates the prototypes for all classes.
  • Notebook titled 03 iERAL vs ERAL vs DBA vs SBD demonstrates the performance of iERAL, ERAL, DBA, and SBD algorithms on the industrial dataset from [2].
  • Notebook titled 04 Evolving Time Series Clustering demonstrates the application of iERAL in the Evolving Time Series Clustering method [1].

References

[1]
[2] Stržinar, Žiga; Pregelj, Boštjan; Petrovčič, Janko; Škrjanc, Igor; Dolanc, Gregor (2024), “Pneumatic Pressure and Electrical Current Time Series in Manufacturing”, Mendeley Data, V2, doi: 10.17632/ypzswhhzh9.2, url: https://data.mendeley.com/datasets/ypzswhhzh9/2

Metadata

Release files for ieral 0.0.2

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

Source distribution (sdist)

Source distribution for ieral 0.0.2
File Size Uploaded
ieral-0.0.2.tar.gz 18.2 kB Details

Built distribution (wheel)

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

Total release size: 36.0 kB

Release files / ieral-0.0.2.tar.gz

Download URL ieral-0.0.2.tar.gz
Size 18.2 kB
Tags Source
SHA-256 checksum
How to use checksums
427cc07cbfe154ffa8c0bbca72001327e420f55f9e8a5f8bc0ef056e9ba62eb3
BLAKE2b-256 checksum
How to use checksums
e560d63d703a758f7be5f096e6dfc4f1d8a67f9e5d247b02da552b484158de32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.3

Release files / ieral-0.0.2-py3-none-any.whl

Download URL ieral-0.0.2-py3-none-any.whl
Size 17.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a53c4c94173fc51e404f3d4e18667cc9432d71a3e05faaa47b3c2e003ea71d0a
BLAKE2b-256 checksum
How to use checksums
648984ca0a9e57bf002d66f893ba67084f6d170720a3804dd618a5852546605b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.3

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files

0.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