Skip to main content

TimesFM fork distribution for tsagentkit.

Project description

TimesFM

TimesFM (Time Series Foundation Model) is a pretrained time-series foundation model developed by Google Research for time-series forecasting.

This open version is not an officially supported Google product.

Fork Notice (tsagentkit)

This repository is a fork of google-research/timesfm, published to PyPI as tsagentkit-timesfm to support the tsagentkit project without a GitHub dependency. The Python import name remains timesfm.

Latest Model Version: TimesFM 2.5

Archived Model Versions:

  • 1.0 and 2.0: relevant code archived in the sub directory v1. You can pip install timesfm==1.3.0 to install an older version of this package to load them.

Update - Oct. 29, 2025

Added back the covariate support through XReg for TimesFM 2.5.

Update - Sept. 15, 2025

TimesFM 2.5 is out!

Comparing to TimesFM 2.0, this new 2.5 model:

  • uses 200M parameters, down from 500M.
  • supports up to 16k context length, up from 2048.
  • supports continuous quantile forecast up to 1k horizon via an optional 30M quantile head.
  • gets rid of the frequency indicator.
  • has a couple of new forecasting flags.

Along with the model upgrade we have also upgraded the inference API. This repo will be under construction over the next few weeks to

  1. add support for an upcoming Flax version of the model (faster inference).
  2. add back covariate support.
  3. populate more docstrings, docs and notebook.

Install

  1. Install from PyPI:

    pip install "tsagentkit-timesfm[torch]"
    # Or with flax
    pip install "tsagentkit-timesfm[flax]"
    # Or XReg support
    pip install "tsagentkit-timesfm[xreg]"
    
  2. [Optional] Install your preferred torch / jax backend based on your OS and accelerators (CPU, GPU, TPU or Apple Silicon).:

From Source (optional)

git clone https://github.com/LeonEthan/timesfm.git
cd timesfm

uv venv
source .venv/bin/activate

uv pip install -e .[torch]
# Or with flax
uv pip install -e .[flax]
# Or XReg support
uv pip install -e .[xreg]

Code Example

import torch
import numpy as np
import timesfm

torch.set_float32_matmul_precision("high")

model = timesfm.TimesFM_2p5_200M_torch.from_pretrained("google/timesfm-2.5-200m-pytorch")

model.compile(
    timesfm.ForecastConfig(
        max_context=1024,
        max_horizon=256,
        normalize_inputs=True,
        use_continuous_quantile_head=True,
        force_flip_invariance=True,
        infer_is_positive=True,
        fix_quantile_crossing=True,
    )
)
point_forecast, quantile_forecast = model.forecast(
    horizon=12,
    inputs=[
        np.linspace(0, 1, 100),
        np.sin(np.linspace(0, 20, 67)),
    ],  # Two dummy inputs
)
point_forecast.shape  # (2, 12)
quantile_forecast.shape  # (2, 12, 10): mean, then 10th to 90th quantiles.

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

tsagentkit_timesfm-1.0.1.tar.gz (33.9 kB view details)

Uploaded Source

Built Distribution

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

tsagentkit_timesfm-1.0.1-py3-none-any.whl (44.1 kB view details)

Uploaded Python 3

File details

Details for the file tsagentkit_timesfm-1.0.1.tar.gz.

File metadata

  • Download URL: tsagentkit_timesfm-1.0.1.tar.gz
  • Upload date:
  • Size: 33.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for tsagentkit_timesfm-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6aef3a3617aa29d2e926fb1a5bb7b51f90715d60579c6a760eee443ab2eb003e
MD5 14f7da31447a7ada7ed4c29ce8b8c273
BLAKE2b-256 47f940bb964d3233aed2c5d76206cf0a833571d300dd2731776032c911c7bded

See more details on using hashes here.

File details

Details for the file tsagentkit_timesfm-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for tsagentkit_timesfm-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 de43165684108b58dfeb9097b5a26621f8aba2882ef885477fa41846b799f271
MD5 ec6bbd71d4cabccd44b2661287eae810
BLAKE2b-256 e34fe4e23dfe0e130cac7815d32759813b1dde7b4cafcbfc0499a3669d1fe3de

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