TimeKAN
TimeKAN is a Pytorch implementation of integrating Kolmogorov-Arnold Networks (KAN) for temporal data with recurrent neural network architectures (Currently LSTM and GRU). It is still in an experimental stage, the implementation suffer from exploding gradients and vanishing gradients problems but with careful training it can perform well specifically on non-linear/complex temporal data.
Inspired by:
Full documentation can be found here.
In tKANLSTM, KAN layers replace the output gate, computing $o_t = \sigma(\text{KAN}(W_x x_t + W_h h_{t-1}))$. In tKANGRU, they form the candidate hidden state, $\tilde{h}t = \tanh(\text{KAN}(W_x x_t + W_h (r_t \odot h{t-1}))$. The layer basis functions can be Fourier series, Chebyshev polynomials, or splines.
Here's how it can perform on Rossler system signal:
The table below compares TimeKAN (using tKANLSTM and
spline as basic functions) and a standard bidirectional
LSTM on three chaotic datasets available in
timekan.utils.datasets. Metrics include Mean Absolute
Error (MAE) and training time (seconds) until convergence.
| Dataset | Model | MAE | Training Time (s) |
|---|---|---|---|
| Mackey-Glass | LSTM | 0.0893 | 0.3346 |
| TimeKAN | 0.0822 | 9.8755 | |
| Lorenz | LSTM | 0.9410 | 1.1331 |
| TimeKAN | 0.7485 | 7.9437 | |
| Rössler | LSTM | 0.3332 | 1.3951 |
| TimeKAN | 0.2657 | 12.4172 |
Installation
Install TimeKAN via pip:
pip install timekan
Alternatively, clone the repository and install locally:
git clone https://github.com/SamerMakni/timekan.git
cd timekan
pip install .
Requirements: Python >= 3.9, PyTorch >= 2.4.0
Usage
Here’s a simple example training a TKANLSTM on Mackey-Glass data:
import torch
import torch.nn as nn
from timekan.models.tkan_lstm import tKANLSTM
from timekan.utils.datasets import mackey_glass
class RecurrentKAN(nn.Module):
def __init__(self, input_dim, hidden_dim):
super().__init__()
self.tkan = tKANLSTM(
input_dim=input_dim,
hidden_dim=hidden_dim,
return_sequences=False,
bidirectional=True,
kan_type='fourier',
sub_kan_configs={'gridsize': 50, 'addbias': True}
)
self.regressor = nn.Linear(hidden_dim * 2, 1)
def forward(self, x):
features = self.tkan(x)
return self.regressor(features).squeeze(-1)
x_train, y_train, x_test, y_test = mackey_glass()
model = RecurrentKAN(input_dim=1, hidden_dim=16)
criterion = nn.MSELoss()
optimizer = torch.optim.Adam(model.parameters(), lr=0.001)
for epoch in range(10):
model.train()
optimizer.zero_grad()
outputs = model(x_train)
loss = criterion(outputs, y_train)
loss.backward()
optimizer.step()
print(f"Epoch {epoch + 1}/10, Training MSE: {loss.item():.4f}")
model.eval()
with torch.no_grad():
test_outputs = model(x_test)
test_mse = criterion(test_outputs, y_test).item()
print(f"Test MSE: {test_mse:.4f}")
Metadata
Release files for timekan 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| timekan-0.1.3.tar.gz | 14.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| timekan-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 31.0 kB
Release files / timekan-0.1.3.tar.gz
| Download URL | timekan-0.1.3.tar.gz |
|---|---|
| Size | 14.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
79dcf9e716f7c9c2febd6a6cd98edbb6bbc238bd2cd96faf0ce52a3de5ab07e9
|
|
BLAKE2b-256 checksum How to use checksums |
c6a271441493b6e441f6c62e657c1cea3c0e89c53aa62fa7bec060348d23eea8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.10
|
Release files / timekan-0.1.3-py3-none-any.whl
| Download URL | timekan-0.1.3-py3-none-any.whl |
|---|---|
| Size | 16.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ae3861589c6a15a12974b552a722ba68a7e403d10f35dff8b05141b33beaddfa
|
|
BLAKE2b-256 checksum How to use checksums |
8b5ac189186df03982b9d308582e15a62da95f7a135e639df70d60976778cbc0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.10
|