Skip to content

uGR17/TIMEX_CLUSTERING

Repository files navigation

TIMEX_CLUSTERING

Library for time-series-clustering-as-a-service.

Tests with PyTest Coverage PyPI PyPI - Downloads

TIMEX-CLUSTERING (referred in code as timexseries_clustering) is a framework for time-series-clustering-as-a-service.

Its main goal is to provide a simple and generic tool to build websites and, more in general, platforms, able to provide the clustering of time-series in an "as-a-service" manner. This means that users should interact with the service as less as possible.

Installation

Installation is as simple as running:

pip install timexseries_clustering

Get started

Please, refer to the Examples folder. You will find some Jupyter Notebook which illustrate the main characteristics of TIMEX-CLUSTERING. A Notebook explaining the clustering of the new positive cases for the COVID-19 spread around the world, along with the source code of the site, here.

Clustering is as simple as running, once installed:

from timexseries_clustering.data_ingestion import ingest_timeseries

from timexseries_clustering.data_clustering.pipeline import create_timeseries_containers

ingested_dataset = ingest_timeseries(param_config)

timeseries_containers = create_timeseries_containers(ingested_dataset, param_config)

Documentation

The full documentation is available at here. It is also available the Master thesis written here.

Contacts

If you have questions, suggestions or problems, feel free to open an Issue. You can contact us at: