Mantis: Lightweight Calibrated Foundation Model for User-Friendly Time Series Classification
Project description
Mantis: Lightweight Foundation Model for Time Series Classification
🚨 NEW Version 1.0.0: Mantis+ and MantisV2 are now available! 🚨
Overview
Mantis is a family of open-source time series classification foundation models.
The key features of Mantis:
- Zero-shot feature extraction: The model can be used in a frozen state to extract deep features and train a classifier on them.
- Fine-tuning: To achieve the highest performance, the model can be further fine-tuned for a new task.
- Lightweight: Our models contain few million parameters, allowing us to fine-tune them on a single GPU (even feasible on a CPU).
- Calibration: In our studies, we have shown that Mantis is the most calibrated foundation model for classification so far.
- Adaptable to large-scale datasets: For datasets with a large number of channels, we propose additional adapters that reduce memory requirements.
Below we give instructions how the package can be installed and used.
Installation
Pip installation
It can be installed via pip by running:
pip install mantis-tsfm
The requirements can be verified at pyproject.toml
Editable mode using Poetry
First, install Poetry and add the path to the binary file to your shell configuration file. For example, on Linux systems, you can do this by running:
curl -sSL https://install.python-poetry.org | python3 -
export PATH="/home/username/.local/bin:$PATH"
Now you can create a virtual environment that is based on one of your already installed Python interpreters. For example, if your default Python is 3.9, then create the environment by running:
poetry env use 3.9
Alternatively, you can specify a path to the interpreter. For example, to use an Anaconda Python interpreter:
poetry env use /path/to/anaconda3/envs/my_env/bin/python
If you want to run any command within the environment, instead of activating the environment manually, you can use poetry run:
poetry run <command>
For example, to install the dependencies and run tests:
poetry install
poetry run pytest
If dependencies are not resolving correctly, try re-generating the lock file:
poetry lock
poetry install
Getting started
Please refer to getting_started/ folder to see reproducible examples of how the package can be used.
Below we summarize the basic commands needed to use the package.
Prepare Data.
As an input, Mantis accepts any time series with sequence length proportional to 32, which corresponds to the number of tokens fixed in our model. We found that resizing time series via interpolation is generally a good choice:
import torch
import torch.nn.functional as F
def resize(X):
X_scaled = F.interpolate(torch.tensor(X, dtype=torch.float), size=512, mode='linear', align_corners=False)
return X_scaled.numpy()
Generally speaking, the interpolation size is a hyperparameter to play with. Nevertheless, since Mantis was pre-trained on sequences of length 512, interpolating to this length looks reasonable in most of cases.
Initialization.
To this moment, we have two backbones and three checkpoints:
| Mantis | Mantis+ | MantisV2 | |
|---|---|---|---|
| Module | MantisV1 |
MantisV1 |
MantisV2 |
| Checkpoint | paris-noah/Mantis-8M |
paris-noah/MantisPlus |
paris-noah/MantisV2 |
To load our of these pre-trained model from the Hugging Face, you can do as follows:
from mantis.architecture import MantisV1
network = MantisV1(device='cuda')
network = network.from_pretrained("paris-noah/Mantis-8M")
Feature Extraction.
We provide a scikit-learn-like wrapper MantisTrainer that allows to use Mantis as a feature extractor by running the following commands:
from mantis.trainer import MantisTrainer
model = MantisTrainer(device='cuda', network=network)
Z = model.transform(X) # X is your time series dataset
Fine-tuning.
If you want to fine-tune the model on your supervised dataset, you can use fit method of MantisTrainer:
from mantis.trainer import MantisTrainer
model = MantisTrainer(device='cuda', network=network)
model.fit(X, y) # y is a vector with class labels
probs = model.predict_proba(X)
y_pred = model.predict(X)
Adapters.
We have integrated into the framework the possibility to pass the input to an adapter before sending it to the foundation model. This may be useful for time series data sets with a large number of channels. More specifically, large number of channels may induce the curse of dimensionality or make model's fine-tuning unfeasible.
A straightforward way to overcome these issues is to use a dimension reduction approach like PCA:
from mantis.adapters import MultichannelProjector
adapter = MultichannelProjector(new_num_channels=5, base_projector='pca')
adapter.fit(X)
X_transformed = adapter.transform(X)
model = MantisTrainer(device='cuda', network=network)
Z = model.transform(X_transformed)
Another wat is to add learnable layers before the foundation model and fine-tune them with the prediction head:
from mantis.adapters import LinearChannelCombiner
model = MantisTrainer(device='cuda', network=network)
adapter = LinearChannelCombiner(num_channels=X.shape[1], new_num_channels=5)
model.fit(X, y, adapter=adapter, fine_tuning_type='adapter_head')
Pre-training.
The model can be pre-trained using the pretrain method of MantisTrainer that supports data parallelization. You can see a pre-training demo at getting_started/pretrain.py.
For example, to pre-train the model on 4 GPUs, you can run the following commands:
cd getting_started/
python -m torch.distributed.run --nproc_per_node=4 --nnodes=1 pretrain.py --seed 42
We have open-sourced CauKer 2M, the synthetic data set we used to pre-train the two version of Mantis, resulting in MantisPlus and MantisV2 checkpoints. The pretrain method directly supports a HF dataset as an input.
Structure
├── data/ <-- two datasets for demonstration
├── getting_started/ <-- jupyter notebooks with tutorials
└── src/mantis/ <-- the main package
├── adapters/ <-- adapters for multichannel time series
├── architecture/ <-- foundation model architectures
└── trainer/ <-- a scikit-learn-like wrapper for feature extraction or fine-tuning
License
This project is licensed under the Apache License 2.0. See the LICENSE file for more details.
Open-source Participation
We would be happy to receive feedback and integrate any suggestion, so do not hesitate to contribute to this project by raising a GitHub issue.
Citing Mantis 📚
If you use Mantis in your work, please cite this technical report:
@article{feofanov2025mantis,
title={Mantis: Lightweight Calibrated Foundation Model for User-Friendly Time Series Classification},
author={Vasilii Feofanov and Songkang Wen and Marius Alonso and Romain Ilbert and Hongbo Guo and Malik Tiomoko and Lujia Pan and Jianfeng Zhang and Ievgen Redko},
journal={arXiv preprint arXiv:2502.15637},
year={2025},
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mantis_tsfm-1.0.0.tar.gz.
File metadata
- Download URL: mantis_tsfm-1.0.0.tar.gz
- Upload date:
- Size: 31.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.2 CPython/3.11.14 Darwin/24.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1e89d96fa63b121998b7fa22d3f6d15eb84f77be056ad0ce9abf0743081ebe0d
|
|
| MD5 |
49a7a2449d8fb93103549d46394a2f59
|
|
| BLAKE2b-256 |
35845401dd282414697c3e19a6846e54c4b6d09defaa1cd4fc0ef5f88bcbc3a8
|
File details
Details for the file mantis_tsfm-1.0.0-py3-none-any.whl.
File metadata
- Download URL: mantis_tsfm-1.0.0-py3-none-any.whl
- Upload date:
- Size: 40.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.2 CPython/3.11.14 Darwin/24.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8ec2b412d2c210955bd639ece836e7d170cd92485caadb75acf7d8b58afbdb80
|
|
| MD5 |
bbd1deec726ce8b34cafd6d0b7a0055c
|
|
| BLAKE2b-256 |
1de9b1e756b8b94487edf22faf3c94b65cb4ed60c4ad93350be29fc57760f8e5
|