Skip to main content

Core Electric Barometer error metrics, including asymmetric CWSL and standard forecast loss functions.

Project description

Electric Barometer · Metrics (eb-metrics)

CI License: BSD-3-Clause Python Versions PyPI

Asymmetric, readiness-oriented forecast evaluation metrics for operational decision systems.


Overview

eb-metrics provides a set of forecast evaluation metrics designed for operational environments where the consequences of error are asymmetric and interval-level reliability matters. Traditional accuracy measures such as RMSE or MAE treat overforecasting and underforecasting symmetrically and summarize average deviation, often obscuring whether a forecast is suitable for real-world execution.

The metrics in this package evaluate forecasts in terms of service protection, shortfall behavior, and cost-weighted impact. They are designed for readiness-oriented assessment in settings such as production, staffing, inventory, logistics, and short-horizon demand planning, where even small shortfalls can create disproportionate operational disruption. eb-metrics serves as the foundational metric layer of the Electric Barometer ecosystem, providing interpretable primitives that support decision-aligned forecast comparison and selection.


Role in the Electric Barometer Ecosystem

eb-metrics defines the core metric primitives used throughout the Electric Barometer ecosystem. It is responsible for implementing asymmetric loss, reliability, and readiness-oriented forecast evaluation measures in a form that is interpretable, composable, and operationally aligned.

This package focuses exclusively on metric definition and behavior. It does not manage data aggregation, evaluation workflows, model interfaces, feature construction, or integration testing. Those concerns are handled by adjacent layers in the ecosystem that apply, orchestrate, or consume these metrics in broader forecasting and decision-making pipelines.

By separating metric semantics from evaluation logic and execution concerns, eb-metrics provides a stable foundation that supports consistent, decision-aligned forecast assessment across heterogeneous operational contexts.


Installation

eb-metrics is distributed as a standard Python package.

pip install eb-metrics

The package supports Python 3.10 and later.


Core Concepts

  • Asymmetric error — Overforecasting and underforecasting can have different operational consequences, so evaluation should reflect directional cost differences.
  • Interval reliability — In readiness-oriented systems, it matters how often forecasts meet demand within each interval, not just average error over time.
  • Shortfall behavior — Underbuilding events are operationally distinct; evaluation should capture both their frequency and their severity.
  • Tolerance-based adequacy — Many systems can absorb small deviations; reliability can be expressed as the frequency of “accurate enough” intervals.
  • Readiness-oriented evaluation — Forecast quality is assessed by execution feasibility and risk, not solely statistical deviation.

Minimal Example

The following example computes Cost-Weighted Service Loss (CWSL) for a single demand series using asymmetric penalties for underbuild and overbuild:

import numpy as np
from eb_metrics import cwsl

# Realized demand and corresponding forecast
y_true = np.array([20, 28, 32, 35, 40, 42])
y_pred = np.array([22, 25, 29, 36, 37, 45])

# Compute cost-weighted service loss
loss = cwsl(
    y_true=y_true,
    y_pred=y_pred,
    underbuild_cost=2.0,
    overbuild_cost=1.0,
)

print(loss)

License

BSD 3-Clause License.
© 2025 Kyle Corrie.

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

eb_metrics-0.2.6.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

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

eb_metrics-0.2.6-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file eb_metrics-0.2.6.tar.gz.

File metadata

  • Download URL: eb_metrics-0.2.6.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for eb_metrics-0.2.6.tar.gz
Algorithm Hash digest
SHA256 5fbbba73b898034c9801764780cd22618c496d915c31d3d543646577b8cdb4cf
MD5 0759a497cd363cd4d805be5ce5a81903
BLAKE2b-256 2779f9436f2c9223f61e3c76c2232ee68f9cb6fabda5fde8707bd85b5efe100a

See more details on using hashes here.

File details

Details for the file eb_metrics-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: eb_metrics-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for eb_metrics-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 31c18d4494ca871a1a724997318aa0e0fe232337f0c77bb32f12c3b8861de464
MD5 27b31007b6da8c8f0d17c85931397718
BLAKE2b-256 279f316dc0e16e8c20e4c89addce76ae5869eaeaa74d20484caacbd6a400d4e4

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