Skip to main content

Foundation model support for OpenSTEF

Project description

openstef-foundation-models

Foundation model support for OpenSTEF — bringing pre-trained, ONNX-based forecasting models to the OpenSTEF ecosystem.

Installation

Pick exactly one ONNX runtime — [cpu] and [gpu] are mutually exclusive.

CPU (default — the meta-package openstef installs this for you):

pip install "openstef-foundation-models[cpu]"

GPU (CUDA):

pip install "openstef-foundation-models[gpu]"

Note: Do not install both [cpu] and [gpu] in the same environment — onnxruntime and onnxruntime-gpu collide. They're declared as conflicting extras so uv enforces the choice; pip does not, so pick one yourself.

Selecting a checkpoint

OpenSTEF publishes its checkpoints to the HuggingFace Hub. Pick a model size and variant from the catalog instead of hand-writing repo ids and filenames:

from openstef_foundation_models.models import Chronos2, CheckpointVariant
from openstef_foundation_models.presets import ForecastingWorkflowConfig

# Default: the base Chronos-2, dynamic shapes — runs on any provider.
config = ForecastingWorkflowConfig()

# The smaller model, static shapes — enables the CoreML provider on macOS.
config = ForecastingWorkflowConfig(
    checkpoint=Chronos2.SMALL.checkpoint(CheckpointVariant.STATIC),
)

# Let the host decide: static on macOS, dynamic elsewhere.
config = ForecastingWorkflowConfig(
    checkpoint=Chronos2.BASE.checkpoint(CheckpointVariant.recommended()),
)

Available sizes are Chronos2.BASE (chronos-2) and Chronos2.SMALL (chronos-2-small); variants are DYNAMIC (portable) and STATIC (frozen shapes, the macOS/CoreML path in the default provider fallback chain).

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

openstef_foundation_models-4.1.0.tar.gz (36.8 kB view details)

Uploaded Source

Built Distribution

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

openstef_foundation_models-4.1.0-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

Details for the file openstef_foundation_models-4.1.0.tar.gz.

File metadata

  • Download URL: openstef_foundation_models-4.1.0.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for openstef_foundation_models-4.1.0.tar.gz
Algorithm Hash digest
SHA256 ca4926fddebc4fb99ad9810bb8c0c25a13f3ce7e4dd1e1ae7361d1592c0825e8
MD5 ef69d094db30bc1228a08eb96d824e85
BLAKE2b-256 e99bb0e24b840990696c9e9a47f9ab8a4a3fb0a76fc6233db67adce775daafb7

See more details on using hashes here.

File details

Details for the file openstef_foundation_models-4.1.0-py3-none-any.whl.

File metadata

  • Download URL: openstef_foundation_models-4.1.0-py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for openstef_foundation_models-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ecd7a7b8423ed4df539ea96474989c48c835f882b8e116797ca0c7522d6978f
MD5 d2b40f0ca82cd0a2fede349d2f2d2749
BLAKE2b-256 be9b95fefc86b6d1c9e2b1380eba6e8bed8e7ec6861fb8b726ad0c13f5f0d23e

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