Skip to main content

a Foundation Model for Univariate Time Series Forecasting

Project description

A tutorial on how to build a Foundation Model for Univariate Time Series Forecasting

Huggingface Model Card Paper Model Card

A concise, reproducible recipe for training a transformer-based, patch-to-patch forecasting model for univariate time series. The approach mirrors Large Language Model (LLM) practices (next-token → next-patch) while remaining lightweight compared to a classic LLM and practical.

Highlights

  • Next-patch prediction objective (autoregressive, causal)
  • Patch-based representation of time series (tokens ↔ patches)
  • Causal masking self-attention with RoPE (relative positions)
  • RevIN (Reversible Instance Normalization)
  • SwiGLU feed-forward networks
  • Multi-quantile outputs (median + uncertainty bands)
  • KV-cache for efficient long-horizon inference
  • Autoregressive multi-quantile decoding MOIRAI2.0 (currently without KV-cache)

Quick Start

from source code

  1. Clone the repository and install dependencies
git clone https://github.com/vilhess/PatchFM
cd PatchFM
pip install -r requirements.txt
  1. Run inference with a pretrained model from Huggingface Hub
import torch
from model import Forecaster
from configs import PatchFMConfig

# --- Instantiate model ---
config = PatchFMConfig(load_from_hub=True)
model = Forecaster(config)

# --- Inference ---
forecast_horizon = 64
seq = torch.randn(1, 1024)  # (batch, time)
pred_median, pred_quantiles = model(seq, forecast_horizon=forecast_horizon, quantiles=[0.1, 0.5, 0.9], quantile_decoding=True)  #  (batch, time), (batch, time, quantiles)

from pip package

  1. Install the package from PyPI
pip install patchfm
  1. Run inference with a pretrained model from Huggingface Hub
import torch
from patchfm import PatchFMConfig, Forecaster

# same as above

We provide an extended quick start example in notebooks/tutorial.ipynb. If you dont have suitable hardware you can run the the extended quick start example example also in Google Colab:

Open Quick Start In Colab

Method (TL;DR)

  • Patching: Split a context signal of length $w$ into $P_{num} = w / P_{len}$ patches of length $P_{len}$.
  • Causal RevIN: Normalize input signal and denormalize outputs to the original scale without statistics leakage.
  • Architecture: Input residual MLP → stacked Transformer blocks (MHA + SwiGLU FFN, pre-norm, residual) → $|\mathcal{Q}|$ output heads mapping back to patch space.
  • Positional encoding: Rotary Position Embeddings (RoPE) applied to queries/keys.
  • Training: Multi-quantile (pinball) loss across positions, elements, and quantiles $\mathcal{Q}$.
  • Inference: Predict next patch; roll out autoregressively for long horizons.
  • KV-cache: during inference, cache keys/values to avoid redundant computations.

Problem Formulation

Given context patches $x_{p_1}, \ldots, x_{p_n}$, predict the next patch $x_{p_{i+1}}$ for each position $i$ using only past patches (causality). The model outputs quantiles ${\hat{x}{p{i+1}}^{(q)}: q \in \mathcal{Q}}$ with median (q=0.5) as the point forecast.

Loss: Multi-Quantile (Pinball)

For residual $u = x - \hat{x}^{(q)}$: $$\rho_q(u) = \begin{cases} q,u, & u \ge 0,\ (q-1),u, & u < 0. \end{cases}$$ Aggregate over positions, patch elements, and quantiles.

Architecture

  • Input MLP: $\mathbb{R}^{P_{len}} \to \mathbb{R}^{dim}$ residual 2-layer MLP (ReLU)
  • Multi-Head Attention: causal mask, RoPE; queries/keys/values per head
  • FFN: SwiGLU (SiLU-gated), pre-norm + residual
  • Output heads: |Q| linear maps $\mathbb{R}^{dim} \to \mathbb{R}^{P_{len}}$ (one per quantile)

Model Details

  • Patch size: 32
  • Max context: 32 patches (1024 steps)
  • Forecast horizon: 32 steps per forward pass
  • Quantiles $\mathcal{Q}$: {0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9}
  • Layers: 6
  • Attention heads: 64 (head dim 32)
  • Model dim: 2048
  • Parameters: ~300M

Inference

  • Single step: predict next patch ($P_{len}$ values)
  • Long-horizon: append prediction to context and repeat (optionally drop oldest patch to keep window fixed)

Datasets

  • UTSD (Unified Time Series Dataset) [UTSD]: seven domains (Energy, IoT, Nature, Web, Health, Transport, Environment). We work with UTSD-12G (~18M series after preprocessing).
  • GIFT-Eval pretraining dataset [GIFT]: aligned with the GIFT-Eval dataset but without data leakage issue with the benchmark. The dataset contains approximately 71 univariate and 17 multivariate time series datasets from various domains and various frequencies. After preprocessing, this yields approximately 600K univariate series.
  • Artificial: ~1M synthetic series (sinusoidal, linear, polynomial, logarithmic) plus mixtures via TSMixup [Chronos]; Gaussian Process samples via KernelSynth (mixtures of RBF/periodic/linear kernels with swept hyperparameters).

Repository Layout

  • model/training/ — main PatchFM model class

    • modules.py - core modules (Residual Layers, MHA, SwiGLU, RoPE, Transformer Encoder, ...)
    • revin.py — causal RevIN
    • loss.py — multi-quantile (pinball) loss
    • trainer.py — PyTorch Lightning trainer class
  • model/inference/ — main PatchFM model class for inference

    • modules.py — core modules with caching support
    • forecaster.py — Forecasting model and rollout logic
  • dataset/ — data loading and preprocessing

    • artificial.py — synthetic dataset : artificial signals + TSMixup + KernelSynth
    • utsd.py — Unified Time Series Dataset (UTSD) loading and preprocessing
    • gift.py — GIFT-Eval pretraining dataset loading and preprocessing
    • get_data.py — utility to fetch and preprocess datasets
    • generate_data.py — utility to generate and save the KernelSynth dataset (long to generate)
  • configs/ — model and training configurations

  • notebooks/inference — how to load a trained model and generate forecasts

  • training.py — training script using PyTorch Lightning

Acknowledgements

We thank the authors of the following repositories for inspiration and code snippets:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

patchfm-3.0.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

patchfm-3.0.0-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file patchfm-3.0.0.tar.gz.

File metadata

  • Download URL: patchfm-3.0.0.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.10

File hashes

Hashes for patchfm-3.0.0.tar.gz
Algorithm Hash digest
SHA256 084f7ea595966e4dadf8984bcc8faf19253069dad24fe3b28ead387e7b1bfbef
MD5 945b340f62d3799110673ba85f3cf8c9
BLAKE2b-256 feb7847ded73eb1bf2cbd4fff75f1632370adc6cd4031a8a1355214c891d1e59

See more details on using hashes here.

File details

Details for the file patchfm-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: patchfm-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.10

File hashes

Hashes for patchfm-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 207a5a3815d2ac2b6e9e967c957e7f5f82569408bd16f27568299aaa8a08e705
MD5 a7574025432bcc665557c9371af64676
BLAKE2b-256 9d9e5e2981b52eae19c992ea25cc2820722d2bd904c7fc3230ba00c8b89d0a38

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page