eb-optimization 0.1.1__tar.gz → 0.2.0__tar.gz

{eb_optimization-0.1.1/src/eb_optimization.egg-info → eb_optimization-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eb-optimization
-Version: 0.1.1
+Version: 0.2.0
 Summary: Electric Barometer: Optimization and tuning utilities for EB objectives and policy parameters.
 Author-email: "Kyle Corrie (Economistician)" <kcorrie@economistician.com>
 License-Expression: BSD-3-Clause
@@ -28,13 +28,20 @@ Provides-Extra: opt
 Provides-Extra: test
 Requires-Dist: pytest>=8.0; extra == "test"
 Requires-Dist: scikit-learn>=1.3; extra == "test"
+Requires-Dist: eb-optimization[eb]; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0; extra == "dev"
 Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: eb-optimization[eb]; extra == "dev"
 Dynamic: license-file
 
 # Electric Barometer · Optimization (`eb-optimization`)
 
+[![CI](https://github.com/Economistician/eb-optimization/actions/workflows/ci.yml/badge.svg)](https://github.com/Economistician/eb-optimization/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-optimization)
+![PyPI](https://img.shields.io/pypi/v/eb-optimization)
+
 Decision and policy layer for the Electric Barometer ecosystem, responsible for tuning, calibration, and governed parameter selection.
 
 ---

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/README.md

@@ -1,5 +1,10 @@
 # Electric Barometer · Optimization (`eb-optimization`)
 
+[![CI](https://github.com/Economistician/eb-optimization/actions/workflows/ci.yml/badge.svg)](https://github.com/Economistician/eb-optimization/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-optimization)
+![PyPI](https://img.shields.io/pypi/v/eb-optimization)
+
 Decision and policy layer for the Electric Barometer ecosystem, responsible for tuning, calibration, and governed parameter selection.
 
 ---

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/pyproject.toml

@@ -3,7 +3,7 @@
 ######################################
 [project]
 name = "eb-optimization"
-version = "0.1.1"
+version = "0.2.0"
 description = "Electric Barometer: Optimization and tuning utilities for EB objectives and policy parameters."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -75,12 +75,14 @@ opt = [
 test = [
   "pytest>=8.0",
   "scikit-learn>=1.3",
+  "eb-optimization[eb]",
 ]
 
 # Local developer tooling
 dev = [
   "pytest>=8.0",
   "pytest-cov>=5.0",
+  "eb-optimization[eb]",
 ]
 
 ######################################

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/src/eb_optimization/policies/__init__.py

@@ -62,11 +62,13 @@ __all__ = [
     "apply_tau_policy",
     "apply_tau_policy_hr",
     "apply_entity_tau_policy",
+
     # Cost ratio policies
     "CostRatioPolicy",
     "DEFAULT_COST_RATIO_POLICY",
     "apply_cost_ratio_policy",
     "apply_entity_cost_ratio_policy",
+
     # RAL policies
     "RALPolicy",
     "DEFAULT_RAL_POLICY",

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/src/eb_optimization/policies/ral_policy.py

@@ -23,8 +23,10 @@ optimization, not the optimization process itself.
 
 from dataclasses import dataclass
 from typing import Optional, Sequence
+
 import pandas as pd
 
+
 @dataclass(frozen=True)
 class RALPolicy:
     r"""Portable policy artifact for the Readiness Adjustment Layer (RAL).
@@ -67,7 +69,7 @@ class RALPolicy:
     artifacts needed to execute the adjustment.
     """
 
-    global_uplift: float
+    global_uplift: float = 1.0
     segment_cols: Sequence[str] = ()
     uplift_table: Optional[pd.DataFrame] = None
 
@@ -93,16 +95,17 @@ class RALPolicy:
         pd.Series
             A series with the adjusted forecast values.
         """
-        # Start with the global uplift applied to the forecast column
-        adjusted_forecast = df[forecast_col] * self.global_uplift
+        adjusted_forecast = df[forecast_col] * float(self.global_uplift)
 
-        # Apply segment-level uplifts if available
         if self.is_segmented():
             # Merge uplift_table with the DataFrame based on segment columns
-            uplift_df = df.merge(self.uplift_table, on=self.segment_cols, how="left")
-            # Apply the segment-level uplift (if available) to the forecast
-            uplifted_forecast = adjusted_forecast * uplift_df["uplift"].fillna(1.0)  # Default to 1.0 if no uplift
-            return uplifted_forecast
+            uplift_df = df.merge(self.uplift_table, on=list(self.segment_cols), how="left")
+
+            # Apply the segment-level uplift (if available) to the forecast.
+            # NOTE: `uplift` here is interpreted as a multiplicative factor relative to the
+            # global uplift. Missing segments default to 1.0 (no additional uplift).
+            return adjusted_forecast * uplift_df["uplift"].fillna(1.0)
+
         return adjusted_forecast
 
     def transform(self, df: pd.DataFrame, forecast_col: str) -> pd.DataFrame:
@@ -124,6 +127,36 @@ class RALPolicy:
             The transformed DataFrame with the adjusted forecast values added.
         """
         df_copy = df.copy()
-        adjusted_forecast = self.adjust_forecast(df_copy, forecast_col)
-        df_copy["readiness_forecast"] = adjusted_forecast
-        return df_copy
+        df_copy["readiness_forecast"] = self.adjust_forecast(df_copy, forecast_col)
+        return df_copy
+
+
+# Convenience default policy instance (for the policies package API)
+DEFAULT_RAL_POLICY = RALPolicy()
+
+
+def apply_ral_policy(
+    df: pd.DataFrame,
+    forecast_col: str,
+    policy: RALPolicy = DEFAULT_RAL_POLICY,
+) -> pd.DataFrame:
+    """Convenience functional wrapper to apply a RALPolicy.
+
+    This is a thin wrapper around :meth:`RALPolicy.transform` used by callers/tests
+    that prefer a functional interface.
+
+    Parameters
+    ----------
+    df : pd.DataFrame
+        Input DataFrame containing the forecast column.
+    forecast_col : str
+        Name of the forecast column to adjust.
+    policy : RALPolicy
+        Policy artifact to apply. Defaults to :data:`DEFAULT_RAL_POLICY`.
+
+    Returns
+    -------
+    pd.DataFrame
+        Copy of `df` with `readiness_forecast` added.
+    """
+    return policy.transform(df=df, forecast_col=forecast_col)

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/src/eb_optimization/search/__init__.py

@@ -21,7 +21,12 @@ Key rules
 - Pure, deterministic search utilities
 """
 
+from . import grid
+from . import kernels
+from . import results
+
 __all__ = [
     "grid",
     "kernels",
+    "results",
 ]

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/src/eb_optimization/tuning/__init__.py

@@ -19,6 +19,11 @@ re-exporting function symbols. This avoids import-time breakage when internals
 are renamed during refactors.
 """
 
+from . import cost_ratio
+from . import sensitivity
+from . import tau
+from . import ral
+
 __all__ = [
     "cost_ratio",
     "sensitivity",

{eb_optimization-0.1.1 → eb_optimization-0.2.0/src/eb_optimization.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eb-optimization
-Version: 0.1.1
+Version: 0.2.0
 Summary: Electric Barometer: Optimization and tuning utilities for EB objectives and policy parameters.
 Author-email: "Kyle Corrie (Economistician)" <kcorrie@economistician.com>
 License-Expression: BSD-3-Clause
@@ -28,13 +28,20 @@ Provides-Extra: opt
 Provides-Extra: test
 Requires-Dist: pytest>=8.0; extra == "test"
 Requires-Dist: scikit-learn>=1.3; extra == "test"
+Requires-Dist: eb-optimization[eb]; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0; extra == "dev"
 Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: eb-optimization[eb]; extra == "dev"
 Dynamic: license-file
 
 # Electric Barometer · Optimization (`eb-optimization`)
 
+[![CI](https://github.com/Economistician/eb-optimization/actions/workflows/ci.yml/badge.svg)](https://github.com/Economistician/eb-optimization/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-optimization)
+![PyPI](https://img.shields.io/pypi/v/eb-optimization)
+
 Decision and policy layer for the Electric Barometer ecosystem, responsible for tuning, calibration, and governed parameter selection.
 
 ---

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/src/eb_optimization.egg-info/SOURCES.txt

@@ -20,4 +20,5 @@ src/eb_optimization/tuning/__init__.py
 src/eb_optimization/tuning/cost_ratio.py
 src/eb_optimization/tuning/ral.py
 src/eb_optimization/tuning/sensitivity.py
-src/eb_optimization/tuning/tau.py
+src/eb_optimization/tuning/tau.py
+tests/test_public_api.py

{eb_optimization-0.1.1 → eb_optimization-0.2.0}/src/eb_optimization.egg-info/requires.txt

@@ -4,6 +4,7 @@ pandas>=2.0
 [dev]
 pytest>=8.0
 pytest-cov>=5.0
+eb-optimization[eb]
 
 [eb]
 eb-metrics<0.3,>=0.2
@@ -14,3 +15,4 @@ eb-evaluation<0.3,>=0.2
 [test]
 pytest>=8.0
 scikit-learn>=1.3
+eb-optimization[eb]

eb_optimization-0.2.0/tests/test_public_api.py

@@ -0,0 +1,39 @@
+def test_policies_public_api_imports():
+    from eb_optimization.policies import (
+        TauPolicy,
+        CostRatioPolicy,
+        RALPolicy,
+        DEFAULT_COST_RATIO_POLICY,
+        DEFAULT_RAL_POLICY,
+        apply_tau_policy,
+        apply_tau_policy_hr,
+        apply_entity_tau_policy,
+        apply_cost_ratio_policy,
+        apply_entity_cost_ratio_policy,
+        apply_ral_policy,
+    )
+
+    # Touch symbols so linters/optimizers can't "optimize away" imports
+    assert TauPolicy and CostRatioPolicy and RALPolicy
+    assert DEFAULT_COST_RATIO_POLICY is not None
+    assert DEFAULT_RAL_POLICY is not None
+    assert callable(apply_tau_policy)
+    assert callable(apply_tau_policy_hr)
+    assert callable(apply_entity_tau_policy)
+    assert callable(apply_cost_ratio_policy)
+    assert callable(apply_entity_cost_ratio_policy)
+    assert callable(apply_ral_policy)
+
+
+def test_search_and_tuning_module_exports():
+    # module-level stability (export modules, not functions)
+    from eb_optimization import search, tuning
+
+    assert hasattr(search, "grid")
+    assert hasattr(search, "kernels")
+    assert hasattr(search, "results")
+
+    assert hasattr(tuning, "cost_ratio")
+    assert hasattr(tuning, "sensitivity")
+    assert hasattr(tuning, "tau")
+    assert hasattr(tuning, "ral")