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.1.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.1-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openstef_foundation_models-4.1.1.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","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.1.tar.gz
Algorithm Hash digest
SHA256 026941f7c0cd53937cf9ce7cd1928d4c809a0a9fdadd8193cd7fae536579f9fc
MD5 1273444b80cc3dfc0c75a3ded6ddbd23
BLAKE2b-256 7a21dae8424b0efde4b81c21b8c3dc9fc72a51fc9b8df2663e08e58fffee3e43

See more details on using hashes here.

Provenance

The following attestation bundles were made for openstef_foundation_models-4.1.1.tar.gz:

Publisher: release-v4.yaml on OpenSTEF/openstef

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: openstef_foundation_models-4.1.1-py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4b3caacceb7603f27cecce27af5902c4ab3538892e8d8f4d0f3a79766b962d70
MD5 934a5873ca6bc286c4d3be6cf4d21e9c
BLAKE2b-256 0b0f4ca4fa73a812f760a224a66b5adf592819526f2c73e074e7b8eebf78db0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for openstef_foundation_models-4.1.1-py3-none-any.whl:

Publisher: release-v4.yaml on OpenSTEF/openstef

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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