API Reference

This is the complete API reference for OpenSTEF. The API is organized into several packages:

Core Package

Core data structures, datasets, and utilities

Core Package (openstef_core)

Models Package

Machine learning models and feature engineering

Models Package (openstef_models)

BEAM Package

Backtesting, evaluation, analysis and metrics for forecasting models

BEAM Package (openstef_beam)

Core Package (openstef_core)

Core Modules:

datasets	Time series datasets and versioned data access.
utils	Utility functions and helpers for OpenSTEF core functionality.
base_model	Configuration utilities for OpenSTEF Beam.
exceptions	Custom exceptions for OpenSTEF core functionality.

Models Package (openstef_models)

Model Modules:

transforms	Feature engineering utilities for OpenSTEF.
models	Model implementations and model interfaces for OpenSTEF.
explainability	Explainability utilities for OpenSTEF.

BEAM Package (openstef_beam)

BEAM Modules:

metrics	Metrics for measuring how well energy forecasting models perform.
backtesting	Tests forecasting models by simulating how they would perform in real operations.
analysis	Turns evaluation results into visualizations and reports for decision making.
evaluation	Organizes forecasting results into structured performance reports.
benchmarking	Runs complete model comparison studies across multiple forecasting targets.