kgraph-ts
Graph Embedding for Interpretable Time Series Clustering
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README -
✓Academic publication links
Links to: arxiv.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.7%) to scientific vocabulary
Keywords
Repository
Graph Embedding for Interpretable Time Series Clustering
Basic Info
- Host: GitHub
- Owner: boniolp
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://graphint.streamlit.app/
- Size: 49.4 MB
Statistics
- Stars: 35
- Watchers: 3
- Forks: 1
- Open Issues: 1
- Releases: 1
Topics
Metadata Files
README.md
$k$-Graph
A Graph Embedding for Interpretable Time Series Clustering
Table of Contents
$k$-Graph in short
$k$-Graph is an explainable and interpretable Graph-based time series clustering. $k$-Graph is divided into three steps: (i) Graph embedding, (ii) Graph clustering, and (iii) Consensus Clustering. In practice, it first projects the time series into a graph and repeats the operation for multiple pattern lengths. For each pattern length, we use the corresponding graph to cluster the time series (based on the frequency of the nodes and edges for each time series). We then find a consensus between all pattern lengths and use the consensus as clustering labels. Thanks to the graph representation of the time series (into a unique graph), $k$-Graph can be utilized for variable-length time series. Moreover, we provide a way to select the most interpretable graph for the resulting clustering partition and allow users to visualize the subsequences contained in the most representative and exclusive nodes.
🔍 Features
- 📊 Clusters time series using graph embeddings
- 🔄 Supports variable-length time series analysis
- 🧠 Provides interpretable graph visualizations
🌐 Try it Online
Explore $k$-Graph with our interactive tool: 👉 GrapHint Visualization Tool
📁 Project Structure
(bash)
kGraph/
├── kgraph/ # Core implementation
├── examples/ # Example usage scripts
├── ressources/ # Visuals and images
├── utils/ # utils methods for loading datasets
├── requirements.txt # Dependencies
└── README.md
Getting started
The easiest solution to install $k$-Graph is to run the following command:
(bash)
pip install kgraph-ts
Graphviz and pyGraphviz can be used to obtain better visualisation for $k$-Graph. These two packages are not necessary to run $k$-graph. If not installed, a random layout is used to plot the graphs. To benefit from a better visualisation of the graphs, please install Graphviz and pyGraphviz as follows:
For Mac:
(bash)
brew install graphviz
For Linux (Ubuntu):
(bash)
sudo apt install graphviz
For Windows:
Stable Windows install packages are listed here
Once Graphviz is installed, you can install pygraphviz as follows:
(bash)
pip install pygraphviz
Manual installation
You can also install manually $k$-Graph by following the instructions below. All Python packages needed are listed in requirements.txt file and can be installed simply using the pip command:
(bash)
conda env create --file environment.yml
conda activate kgraph
pip install -r requirements.txt
You can then install $k$-Graph locally with the following command:
(bash)
pip install .
Usage
In order to play with $k$-Graph, please check the UCR archive. We depict below a code snippet demonstrating how to use $k$-Graph.
```python import sys import pandas as pd import numpy as np import networkx as nx import matplotlib.pyplot as plt from sklearn.metrics import adjustedrandscore
sys.path.insert(1, './utils/') from utils import fetchucrdataset
from kgraph import kGraph
path = "/Path/to/UCRArchive2018/" data = fetchucrdataset('Trace',path) X = np.concatenate([data['datatrain'],data['datatest']],axis=0) y = np.concatenate([data['targettrain'],data['target_test']],axis=0)
Executing kGraph
clf = kGraph(nclusters=len(set(y)),nlengths=10,n_jobs=4) clf.fit(X)
print("ARI score: ",adjustedrandscore(clf.labels_,y))
Running kGraph for the following length: [36, 72, 10, 45, 81, 18, 54, 90, 27, 63]
Graphs computation done! (36.71151804924011 s)
Consensus done! (0.03878021240234375 s)
Ensemble clustering done! (0.0060100555419921875 s)
ARI score: 0.986598879940902
```
For variable-length time series datasets, $k$-Graph has to be initialized as follows:
python
clf = kGraph(n_clusters=len(set(y)),variable_length=True,n_lengths=10,n_jobs=4)
Visualization tools
We provide visualization methods to plot the graph and the identified clusters (i.e., graphoids). After running $k$-Graph, you can run the following code to plot the graphs partitioned in different clusters (grey are nodes that are not associated with a specific cluster).
python
clf.show_graphoids(group=True,save_fig=True,namefile='Trace_kgraph')
Instead of visualizing the graph, we can directly retrieve the most representative nodes for each cluster with the following code:
```python nb_patterns = 1
Get the most representative nodes
nodes = clf.interprete(nbpatterns=nbpatterns)
plt.figure(figsize=(10,4*nbpatterns)) count = 0 for j in range(nbpatterns): for i,node in enumerate(nodes.keys()):
# Get the time series for the corresponding node
mean,sup,inf = clf.get_node_ts(X=X,node=nodes[node][j][0])
count += 1
plt.subplot(nb_patterns,len(nodes.keys()),count)
plt.fill_between(x=list(range(int(clf.optimal_length))),y1=inf,y2=sup,alpha=0.2)
plt.plot(mean,color='black')
plt.plot(inf,color='black',alpha=0.6,linestyle='--')
plt.plot(sup,color='black',alpha=0.6,linestyle='--')
plt.title('node {} for cluster {}: \n (representativity: {:.3f} \n exclusivity : {:.3f})'.format(nodes[node][j][0],node,nodes[node][j][3],nodes[node][j][2]))
plt.tight_layout()
plt.savefig('Traceclusterinterpretation.jpg') plt.close() ```
You can find a script containing all the code above here.
References
$k$-Graph has been accepted for publication IEEE Transactions on Knowledge and Data Engineering (TKDE). You may find the preprint version here. If you use $k$-Graph in your project or research, cite the following paper:
P. Boniol, D. Tiano, A. Bonifati and T. Palpanas, " k -Graph: A Graph Embedding for Interpretable Time Series Clustering," in IEEE Transactions on Knowledge and Data Engineering, doi: 10.1109/TKDE.2025.3543946.
bibtex
@ARTICLE{10896823,
author={Boniol, Paul and Tiano, Donato and Bonifati, Angela and Palpanas, Themis},
journal={IEEE Transactions on Knowledge and Data Engineering},
title={$k$-Graph: A Graph Embedding for Interpretable Time Series Clustering},
year={2025},
volume={37},
number={5},
pages={2680-2694},
keywords={Time series analysis;Feature extraction;Clustering algorithms;Accuracy;Heuristic algorithms;Clustering methods;Training;Shape;Partitioning algorithms;Directed graphs;Time Series;Clustering;Interpretability},
doi={10.1109/TKDE.2025.3543946}}
Contributors
- Paul Boniol, Inria, ENS, PSL University, CNRS
- Donato Tiano, Università degli Studi di Modena e Reggio Emilia
- Angela Bonifati, Lyon 1 University, IUF, Liris CNRS
- Themis Palpanas, Université Paris Cité, IUF
Owner
- Name: Paul Boniol
- Login: boniolp
- Kind: user
- Company: Université Paris Cité
- Website: https://boniolp.github.io/
- Repositories: 2
- Profile: https://github.com/boniolp
Postdoctoral researcher at Université Paris Cité
Citation (CITATION.cff)
cff-version: 1.0.1
message: "If you use this software, please cite it as below."
authors:
- family-names: Boniol
given-names: Paul
- family-names: Tiano
given-names: Donato
- family-names: Bonifati
given-names: Angela
- family-names: Palpanas
given-names: Themis
title: "$k$-Graph: A Graph Embedding for Interpretable Time Series Clustering"
date-released: 2025
url: "https://github.com/boniolp/kGraph"
preferred-citation:
type: article
authors:
- family-names: Boniol
given-names: Paul
- family-names: Tiano
given-names: Donato
- family-names: Bonifati
given-names: Angela
- family-names: Palpanas
given-names: Themis
doi: 10.1109/TKDE.2025.3543946
journal: "IEEE Transactions on Knowledge and Data Engineering"
title: "$k$-Graph: A Graph Embedding for Interpretable Time Series Clustering"
issue: 5
volume: 37
year: 2025
start: 2680
end: 2694
GitHub Events
Total
- Issues event: 1
- Watch event: 21
- Issue comment event: 1
- Push event: 5
- Fork event: 1
Last Year
- Issues event: 1
- Watch event: 21
- Issue comment event: 1
- Push event: 5
- Fork event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 1
- Total pull requests: 0
- Average time to close issues: about 3 hours
- Average time to close pull requests: N/A
- Total issue authors: 1
- Total pull request authors: 0
- Average comments per issue: 1.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- allenkei (1)
- shenxiangzhuang (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 23 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
pypi.org: kgraph-ts
kGraph
- Homepage: https://github.com/boniolp/kGraph
- Documentation: https://kgraph-ts.readthedocs.io/
- License: MIT License
-
Latest release: 0.0.1
published almost 2 years ago
Rankings
Maintainers (1)
Dependencies
- aeon ==0.6.0
- matplotlib ==3.7.2
- networkx ==3.2.1
- numpy ==1.24.3
- pandas ==2.0.3
- scikit_learn ==1.3.0
- scipy ==1.11.4
- setuptools ==63.2.0
- aeon ==0.6.0
- matplotlib ==3.7.2
- networkx ==3.1
- numpy ==1.24.4
- pandas ==2.0.3
- pygraphviz ==1.11
- scikit-learn ==1.2.2
- scipy ==1.11.3
- setuptools ==63.2.0