eb-evaluation 0.2.2__tar.gz → 0.2.4__tar.gz

{eb_evaluation-0.2.2 → eb_evaluation-0.2.4}/LICENSE

@@ -1,28 +1,28 @@
-BSD 3-Clause License
-
-Copyright (c) 2025, Kyle Corrie
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 3-Clause License
+
+Copyright (c) 2025, Kyle Corrie
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{eb_evaluation-0.2.2/src/eb_evaluation.egg-info → eb_evaluation-0.2.4}/PKG-INFO

@@ -1,119 +1,119 @@
-Metadata-Version: 2.4
-Name: eb-evaluation
-Version: 0.2.2
-Summary: Electric Barometer: DataFrame-based evaluation utilities for CWSL and related metrics.
-Author-email: "Kyle Corrie (Economistician)" <kcorrie@economistician.com>
-License-Expression: BSD-3-Clause
-Project-URL: Homepage, https://github.com/Economistician/eb-evaluation
-Project-URL: Repository, https://github.com/Economistician/eb-evaluation
-Project-URL: Issues, https://github.com/Economistician/eb-evaluation/issues
-Project-URL: Documentation, https://github.com/Economistician/eb-docs
-Keywords: electric-barometer,forecast-evaluation,asymmetric-loss,readiness,forecasting,pandas
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy>=1.24
-Requires-Dist: pandas>=2.0
-Requires-Dist: eb-metrics<0.3,>=0.2
-Requires-Dist: eb-adapters<0.3,>=0.2
-Provides-Extra: test
-Requires-Dist: pytest>=8.0; extra == "test"
-Requires-Dist: scikit-learn>=1.3; extra == "test"
-Provides-Extra: dev
-Requires-Dist: pytest>=8.0; extra == "dev"
-Requires-Dist: pytest-cov>=5.0; extra == "dev"
-Dynamic: license-file
-
-# Electric Barometer · Evaluation (`eb-evaluation`)
-
-[![CI](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml/badge.svg)](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml)
-![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)
-![Python Versions](https://img.shields.io/pypi/pyversions/eb-evaluation)
-![PyPI](https://img.shields.io/pypi/v/eb-evaluation)
-
-Evaluation and model selection utilities for applying Electric Barometer metrics across entities, groups, and operational contexts.
-
----
-
-## Overview
-
-`eb-evaluation` provides the evaluation and model selection layer of the Electric Barometer ecosystem. It applies metric primitives to forecasts and observations across entities, groups, and hierarchical structures, enabling consistent assessment of forecasting performance in operational settings.
-
-The package focuses on DataFrame-first evaluation workflows, including tolerance-based scoring, cost-sensitive comparison, and readiness-oriented adjustment logic. It does not define feature construction or model interfaces; instead, it consumes standardized inputs from upstream layers and produces evaluation outputs that can be used for model selection, reporting, and decision support.
-
----
-
-## Role in the Electric Barometer Ecosystem
-
-`eb-evaluation` defines the evaluation and model selection layer used throughout the Electric Barometer ecosystem. It is responsible for applying metric primitives to forecasts and observations across entities, groups, and hierarchies, enabling consistent comparison of forecasting performance in operational contexts.
-
-This package focuses exclusively on evaluation logic, aggregation semantics, and selection workflows. It does not perform feature construction, model training, or metric definition. Those responsibilities are handled by adjacent layers that generate inputs, adapt model interfaces, or define metric behavior.
-
-By separating evaluation orchestration from metric semantics and model implementation details, `eb-evaluation` provides a stable, DataFrame-first foundation for decision-aligned model comparison and readiness assessment across heterogeneous forecasting pipelines.
-
----
-
-## Installation
-
-`eb-evaluation` is distributed as a standard Python package.
-
-```bash
-pip install eb-evaluation
-```
-
-The package supports Python 3.10 and later.
-
----
-
-## Core Concepts
-
-- **DataFrame-first evaluation** — Evaluation logic operates directly on tabular forecast and observation data, enabling transparent aggregation, grouping, and comparison across entities and hierarchies.
-- **Cost- and tolerance-aware scoring** — Forecast performance is assessed using metrics that reflect asymmetric cost, acceptable deviation thresholds, and operational risk rather than purely symmetric statistical error.
-- **Hierarchical and panel semantics** — Evaluation respects entity boundaries, grouping structure, and temporal alignment, ensuring correctness in multi-level forecasting environments.
-- **Model comparability** — Forecasts produced by heterogeneous models can be evaluated and compared using a consistent set of metrics and aggregation rules.
-- **Readiness-oriented selection** — Model selection emphasizes execution feasibility and operational adequacy, not just aggregate accuracy, supporting decision-aligned forecasting workflows.
-
----
-
-## Minimal Example
-
-The example below shows how forecasts and observations can be evaluated and compared across entities using Electric Barometer metrics in a DataFrame-first workflow.
-
-```python
-import pandas as pd
-from eb_evaluation.dataframe.compare import compare_models
-
-# Example evaluation data
-df = pd.DataFrame({
-    "entity_id": ["A", "A", "B", "B"],
-    "date": pd.to_datetime(["2024-01-01", "2024-01-02"] * 2),
-    "actual": [10, 12, 7, 9],
-    "model_a": [9, 11, 8, 10],
-    "model_b": [11, 13, 6, 8],
-})
-
-# Compare models using a common evaluation contract
-results = compare_models(
-    df,
-    actual_col="actual",
-    prediction_cols=["model_a", "model_b"],
-    entity_col="entity_id",
-    time_col="date",
-)
-
-print(results)
-```
-
----
-
-## License
-
-BSD 3-Clause License.  
-© 2025 Kyle Corrie.
+Metadata-Version: 2.4
+Name: eb-evaluation
+Version: 0.2.4
+Summary: Electric Barometer: DataFrame-based evaluation utilities for CWSL and related metrics.
+Author-email: "Kyle Corrie (Economistician)" <kcorrie@economistician.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/Economistician/eb-evaluation
+Project-URL: Repository, https://github.com/Economistician/eb-evaluation
+Project-URL: Issues, https://github.com/Economistician/eb-evaluation/issues
+Project-URL: Documentation, https://github.com/Economistician/eb-docs
+Keywords: electric-barometer,forecast-evaluation,asymmetric-loss,readiness,forecasting,pandas
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.0
+Requires-Dist: eb-metrics<0.3,>=0.2
+Requires-Dist: eb-adapters<0.3,>=0.2
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Requires-Dist: scikit-learn>=1.3; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Dynamic: license-file
+
+# Electric Barometer · Evaluation (`eb-evaluation`)
+
+[![CI](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml/badge.svg)](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml)
+![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)
+![Python Versions](https://img.shields.io/pypi/pyversions/eb-evaluation)
+![PyPI](https://img.shields.io/pypi/v/eb-evaluation)
+
+Evaluation and model selection utilities for applying Electric Barometer metrics across entities, groups, and operational contexts.
+
+---
+
+## Overview
+
+`eb-evaluation` provides the evaluation and model selection layer of the Electric Barometer ecosystem. It applies metric primitives to forecasts and observations across entities, groups, and hierarchical structures, enabling consistent assessment of forecasting performance in operational settings.
+
+The package focuses on DataFrame-first evaluation workflows, including cost-sensitive comparison, tolerance-aware scoring given explicit thresholds, and readiness-oriented adjustment logic. It does not define feature construction or model interfaces; instead, it consumes standardized inputs from upstream layers and produces evaluation outputs that can be used for model selection, reporting, and decision support.
+
+---
+
+## Role in the Electric Barometer Ecosystem
+
+`eb-evaluation` defines the evaluation and model selection layer used throughout the Electric Barometer ecosystem. It is responsible for applying metric primitives to forecasts and observations across entities, groups, and hierarchies, enabling consistent comparison of forecasting performance in operational contexts.
+
+This package focuses exclusively on evaluation logic, aggregation semantics, and selection workflows. It does not perform feature construction, model training, or metric definition. Those responsibilities are handled by adjacent layers that generate inputs, adapt model interfaces, or define metric behavior.
+
+By separating evaluation orchestration from metric semantics and model implementation details, `eb-evaluation` provides a stable, DataFrame-first foundation for decision-aligned model comparison and readiness assessment across heterogeneous forecasting pipelines.
+
+---
+
+## Installation
+
+`eb-evaluation` is distributed as a standard Python package.
+
+```bash
+pip install eb-evaluation
+```
+
+The package supports Python 3.10 and later.
+
+---
+
+## Core Concepts
+
+- **DataFrame-first evaluation** — Evaluation logic operates directly on tabular forecast and observation data, enabling transparent aggregation, grouping, and comparison across entities and hierarchies.
+- **Cost- and tolerance-aware scoring** — Forecast performance is assessed using metrics that reflect asymmetric cost and explicitly supplied deviation thresholds, rather than purely symmetric statistical error.
+- **Hierarchical and panel semantics** — Evaluation respects entity boundaries, grouping structure, and temporal alignment, ensuring correctness in multi-level forecasting environments.
+- **Model comparability** — Forecasts produced by heterogeneous models can be evaluated and compared using a consistent set of metrics and aggregation rules.
+- **Readiness-oriented selection** — Model selection emphasizes execution feasibility and operational adequacy as reflected in evaluation metrics, not just aggregate accuracy, supporting decision-aligned forecasting workflows.
+
+---
+
+## Minimal Example
+
+The example below shows how forecast accuracy can be evaluated across entities
+using Electric Barometer metrics in a DataFrame-first workflow.
+
+```python
+import pandas as pd
+from eb_evaluation.dataframe import compute_cwsl_df
+
+# Example evaluation data
+df = pd.DataFrame({
+    "entity_id": ["A", "A", "B", "B"],
+    "date": pd.to_datetime(["2024-01-01", "2024-01-02"] * 2),
+    "actual": [10, 12, 7, 9],
+    "prediction": [9, 11, 8, 10],
+})
+
+# Compute Cost-Weighted Service Loss (CWSL)
+results = compute_cwsl_df(
+    df,
+    actual_col="actual",
+    prediction_col="prediction",
+    entity_col="entity_id",
+    time_col="date",
+)
+
+print(results)
+```
+
+---
+
+## License
+
+BSD 3-Clause License.  
+© 2025 Kyle Corrie.

{eb_evaluation-0.2.2 → eb_evaluation-0.2.4}/README.md

@@ -1,86 +1,86 @@
-# Electric Barometer · Evaluation (`eb-evaluation`)
-
-[![CI](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml/badge.svg)](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml)
-![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)
-![Python Versions](https://img.shields.io/pypi/pyversions/eb-evaluation)
-![PyPI](https://img.shields.io/pypi/v/eb-evaluation)
-
-Evaluation and model selection utilities for applying Electric Barometer metrics across entities, groups, and operational contexts.
-
----
-
-## Overview
-
-`eb-evaluation` provides the evaluation and model selection layer of the Electric Barometer ecosystem. It applies metric primitives to forecasts and observations across entities, groups, and hierarchical structures, enabling consistent assessment of forecasting performance in operational settings.
-
-The package focuses on DataFrame-first evaluation workflows, including tolerance-based scoring, cost-sensitive comparison, and readiness-oriented adjustment logic. It does not define feature construction or model interfaces; instead, it consumes standardized inputs from upstream layers and produces evaluation outputs that can be used for model selection, reporting, and decision support.
-
----
-
-## Role in the Electric Barometer Ecosystem
-
-`eb-evaluation` defines the evaluation and model selection layer used throughout the Electric Barometer ecosystem. It is responsible for applying metric primitives to forecasts and observations across entities, groups, and hierarchies, enabling consistent comparison of forecasting performance in operational contexts.
-
-This package focuses exclusively on evaluation logic, aggregation semantics, and selection workflows. It does not perform feature construction, model training, or metric definition. Those responsibilities are handled by adjacent layers that generate inputs, adapt model interfaces, or define metric behavior.
-
-By separating evaluation orchestration from metric semantics and model implementation details, `eb-evaluation` provides a stable, DataFrame-first foundation for decision-aligned model comparison and readiness assessment across heterogeneous forecasting pipelines.
-
----
-
-## Installation
-
-`eb-evaluation` is distributed as a standard Python package.
-
-```bash
-pip install eb-evaluation
-```
-
-The package supports Python 3.10 and later.
-
----
-
-## Core Concepts
-
-- **DataFrame-first evaluation** — Evaluation logic operates directly on tabular forecast and observation data, enabling transparent aggregation, grouping, and comparison across entities and hierarchies.
-- **Cost- and tolerance-aware scoring** — Forecast performance is assessed using metrics that reflect asymmetric cost, acceptable deviation thresholds, and operational risk rather than purely symmetric statistical error.
-- **Hierarchical and panel semantics** — Evaluation respects entity boundaries, grouping structure, and temporal alignment, ensuring correctness in multi-level forecasting environments.
-- **Model comparability** — Forecasts produced by heterogeneous models can be evaluated and compared using a consistent set of metrics and aggregation rules.
-- **Readiness-oriented selection** — Model selection emphasizes execution feasibility and operational adequacy, not just aggregate accuracy, supporting decision-aligned forecasting workflows.
-
----
-
-## Minimal Example
-
-The example below shows how forecasts and observations can be evaluated and compared across entities using Electric Barometer metrics in a DataFrame-first workflow.
-
-```python
-import pandas as pd
-from eb_evaluation.dataframe.compare import compare_models
-
-# Example evaluation data
-df = pd.DataFrame({
-    "entity_id": ["A", "A", "B", "B"],
-    "date": pd.to_datetime(["2024-01-01", "2024-01-02"] * 2),
-    "actual": [10, 12, 7, 9],
-    "model_a": [9, 11, 8, 10],
-    "model_b": [11, 13, 6, 8],
-})
-
-# Compare models using a common evaluation contract
-results = compare_models(
-    df,
-    actual_col="actual",
-    prediction_cols=["model_a", "model_b"],
-    entity_col="entity_id",
-    time_col="date",
-)
-
-print(results)
-```
-
----
-
-## License
-
-BSD 3-Clause License.  
+# Electric Barometer · Evaluation (`eb-evaluation`)
+
+[![CI](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml/badge.svg)](https://github.com/Economistician/eb-evaluation/actions/workflows/ci.yml)
+![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)
+![Python Versions](https://img.shields.io/pypi/pyversions/eb-evaluation)
+![PyPI](https://img.shields.io/pypi/v/eb-evaluation)
+
+Evaluation and model selection utilities for applying Electric Barometer metrics across entities, groups, and operational contexts.
+
+---
+
+## Overview
+
+`eb-evaluation` provides the evaluation and model selection layer of the Electric Barometer ecosystem. It applies metric primitives to forecasts and observations across entities, groups, and hierarchical structures, enabling consistent assessment of forecasting performance in operational settings.
+
+The package focuses on DataFrame-first evaluation workflows, including cost-sensitive comparison, tolerance-aware scoring given explicit thresholds, and readiness-oriented adjustment logic. It does not define feature construction or model interfaces; instead, it consumes standardized inputs from upstream layers and produces evaluation outputs that can be used for model selection, reporting, and decision support.
+
+---
+
+## Role in the Electric Barometer Ecosystem
+
+`eb-evaluation` defines the evaluation and model selection layer used throughout the Electric Barometer ecosystem. It is responsible for applying metric primitives to forecasts and observations across entities, groups, and hierarchies, enabling consistent comparison of forecasting performance in operational contexts.
+
+This package focuses exclusively on evaluation logic, aggregation semantics, and selection workflows. It does not perform feature construction, model training, or metric definition. Those responsibilities are handled by adjacent layers that generate inputs, adapt model interfaces, or define metric behavior.
+
+By separating evaluation orchestration from metric semantics and model implementation details, `eb-evaluation` provides a stable, DataFrame-first foundation for decision-aligned model comparison and readiness assessment across heterogeneous forecasting pipelines.
+
+---
+
+## Installation
+
+`eb-evaluation` is distributed as a standard Python package.
+
+```bash
+pip install eb-evaluation
+```
+
+The package supports Python 3.10 and later.
+
+---
+
+## Core Concepts
+
+- **DataFrame-first evaluation** — Evaluation logic operates directly on tabular forecast and observation data, enabling transparent aggregation, grouping, and comparison across entities and hierarchies.
+- **Cost- and tolerance-aware scoring** — Forecast performance is assessed using metrics that reflect asymmetric cost and explicitly supplied deviation thresholds, rather than purely symmetric statistical error.
+- **Hierarchical and panel semantics** — Evaluation respects entity boundaries, grouping structure, and temporal alignment, ensuring correctness in multi-level forecasting environments.
+- **Model comparability** — Forecasts produced by heterogeneous models can be evaluated and compared using a consistent set of metrics and aggregation rules.
+- **Readiness-oriented selection** — Model selection emphasizes execution feasibility and operational adequacy as reflected in evaluation metrics, not just aggregate accuracy, supporting decision-aligned forecasting workflows.
+
+---
+
+## Minimal Example
+
+The example below shows how forecast accuracy can be evaluated across entities
+using Electric Barometer metrics in a DataFrame-first workflow.
+
+```python
+import pandas as pd
+from eb_evaluation.dataframe import compute_cwsl_df
+
+# Example evaluation data
+df = pd.DataFrame({
+    "entity_id": ["A", "A", "B", "B"],
+    "date": pd.to_datetime(["2024-01-01", "2024-01-02"] * 2),
+    "actual": [10, 12, 7, 9],
+    "prediction": [9, 11, 8, 10],
+})
+
+# Compute Cost-Weighted Service Loss (CWSL)
+results = compute_cwsl_df(
+    df,
+    actual_col="actual",
+    prediction_col="prediction",
+    entity_col="entity_id",
+    time_col="date",
+)
+
+print(results)
+```
+
+---
+
+## License
+
+BSD 3-Clause License.  
 © 2025 Kyle Corrie.