openstef 3.4.75__py3-none-any.whl → 3.4.77__py3-none-any.whl

openstef/data_classes/prediction_job.py

@@ -10,7 +10,12 @@ from pydantic import BaseModel, Field
 from openstef.data_classes.data_prep import DataPrepDataClass
 from openstef.data_classes.model_specifications import ModelSpecificationDataClass
 from openstef.data_classes.split_function import SplitFuncDataClass
-from openstef.enums import AggregateFunction, BiddingZone, PipelineType
+from openstef.enums import (
+    AggregateFunction,
+    BiddingZone,
+    PipelineType,
+    FallbackStrategy,
+)
 
 
 class PredictionJobDataClass(BaseModel):
@@ -136,6 +141,11 @@ class PredictionJobDataClass(BaseModel):
         None, description="The import string for the custom data prep class"
     )
 
+    fallback_strategy: Optional[FallbackStrategy] = Field(
+        FallbackStrategy.EXTREME_DAY,
+        description="The fallback strategy to use when not enough input data is available.",
+    )
+
     def __getitem__(self, item: str) -> Any:
         """Allows us to use subscription to get the items from the object."""
         return getattr(self, item)

openstef/enums.py

@@ -139,3 +139,8 @@ class PipelineType(Enum):
     FORECAST = "forecast"
     TRAIN = "train"
     HYPER_PARMATERS = "hyper_parameters"
+
+
+class FallbackStrategy(Enum):
+    EXTREME_DAY = "extreme_day"
+    RAISE_ERROR = "raise_error"

openstef/model/fallback.py

@@ -5,11 +5,13 @@ from datetime import UTC, datetime
 
 import pandas as pd
 
+from openstef.enums import FallbackStrategy
+
 
 def generate_fallback(
     forecast_input: pd.DataFrame,
     load: pd.DataFrame,
-    fallback_strategy: str = "extreme_day",
+    fallback_strategy: FallbackStrategy = FallbackStrategy.EXTREME_DAY,
 ) -> pd.DataFrame:
     """Make a fall back forecast, Set the value of the forecast 'quality' column to 'substituted'.
 
@@ -20,6 +22,7 @@ def generate_fallback(
         load: index=datetime, columns=['load']
         fallback_strategy: strategy to determine fallback. options:
             - extreme_day: use daily profile of most extreme day
+            - raise_error: raise error if not enough data is available
     Returns:
         Fallback forecast DataFrame with columns; 'forecast', 'quality'
 
@@ -32,12 +35,17 @@ def generate_fallback(
     if len(load.dropna()) == 0:
         raise ValueError("No historic load data available")
 
-    if fallback_strategy != "extreme_day":
-        raise NotImplementedError(
-            f'fallback_strategy should be "extreme_day", received:{fallback_strategy}'
-        )
+    if fallback_strategy not in [
+        FallbackStrategy.RAISE_ERROR,
+        FallbackStrategy.EXTREME_DAY,
+    ]:
+        raise NotImplementedError("Fallback strategy not implemented")
+
+    if fallback_strategy == FallbackStrategy.RAISE_ERROR:
+        # Raise error if not enough data is available
+        raise ValueError("Not enough load data available to generate forecast")
 
-    if fallback_strategy == "extreme_day":
+    if fallback_strategy == FallbackStrategy.EXTREME_DAY:
         # Execute this fallback strategy
         # Find most extreme historic day and merge it by time-of-day to the requested moments
 

openstef/pipeline/create_forecast.py

@@ -20,6 +20,7 @@ from openstef.postprocessing.postprocessing import (
     sort_quantiles,
 )
 from openstef.validation import validation
+from openstef.enums import FallbackStrategy
 
 
 def create_forecast_pipeline(
@@ -88,7 +89,7 @@ def create_forecast_pipeline_core(
     """
     logger = get_logger(__name__)
 
-    fallback_strategy = "extreme_day"  # this can later be expanded
+    fallback_strategy = pj.get("fallback_strategy", FallbackStrategy.EXTREME_DAY)
 
     # Validate and clean data
     validated_data = validation.validate(

openstef/postprocessing/postprocessing.py

@@ -255,9 +255,14 @@ def sort_quantiles(
     if len(p_columns) == 0:
         return forecast
 
-    # sort the columns
+    # Sort the columns
     p_columns = np.sort(p_columns)
 
     forecast.loc[:, p_columns] = forecast[p_columns].apply(sorted, axis=1).to_list()
 
+    # Set the forecast columun equal to the median if available
+    median_col = f"{quantile_col_start}50"
+    if median_col in forecast.columns:
+        forecast["forecast"] = forecast[median_col]
+
     return forecast

{openstef-3.4.75.dist-info → openstef-3.4.77.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openstef
-Version: 3.4.75
+Version: 3.4.77
 Summary: Open short term energy forecaster
 Home-page: https://github.com/OpenSTEF/openstef
 Author: Alliander N.V

{openstef-3.4.75.dist-info → openstef-3.4.77.dist-info}/RECORD

@@ -1,7 +1,7 @@
 openstef/__init__.py,sha256=93UM6m0LLQhO69-mSqLuUy73jgs4W7Iuxfo3Lm8c98g,419
 openstef/__main__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/app_settings.py,sha256=4SiEoPfPmM_Vc9gwWleT_IRxHIk36bZaYRCdNf3ewoo,762
-openstef/enums.py,sha256=kwAbEoMI_a--Ikk6RxeJmvR2JKYKDNHynhMUbbiczZs,2851
+openstef/enums.py,sha256=_nhwTY5-bV14ydv4nA06KEZ1xsI53oNqMX963P10jgg,2947
 openstef/exceptions.py,sha256=dgnvZe5WWuJWCZm_GES6suEATbusPlwbiEUfNQKeExY,1993
 openstef/settings.py,sha256=nSgkBqFxuqB3w7Rwo60i8j37c5ngDbt6vpjHS6QtJXQ,354
 openstef/data/NL_terrestrial_radiation.csv,sha256=A4kbW56GDzWi4tWUwY2C-4PiOvcKJCwkWQQtdg4ekPE,820246
@@ -17,7 +17,7 @@ openstef/data/dazls_model_3.4.24/dazls_stored_3.4.24_model_card.md.license,sha25
 openstef/data_classes/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/data_classes/data_prep.py,sha256=sANgFjfwmSWhLCfmLjfqXQnczuvVZfk2765jZd7LwuE,3691
 openstef/data_classes/model_specifications.py,sha256=PZeBLfH_MrP9-QorL1r0Hklp0befE8Nw05vNhTX9Y20,1338
-openstef/data_classes/prediction_job.py,sha256=omVzowGYUp5YD_7k3i3pKlDh1I7i_jU3-za7FJ3fK1s,6731
+openstef/data_classes/prediction_job.py,sha256=HS2ZjhOoF4EdQRttOiTM0W1E7z5ZNjBglMpcSSZvoCY,6967
 openstef/data_classes/split_function.py,sha256=K8y1dsQC5exeIDh37f7UwJ11tV71_uVSNbnKmwXpnOM,3435
 openstef/feature_engineering/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/feature_engineering/apply_features.py,sha256=pro4eUmOFexX_9g9kJtDcbrQ1hWKzXjVpiJBmmBi89o,5326
@@ -45,7 +45,7 @@ openstef/metrics/reporter.py,sha256=2F1uRmh2MC-JH8Lsr1xGLxUFYDGfQ0Q85Pcjcc31TP0,
 openstef/model/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/model/basecase.py,sha256=caI6Q-8y0ymlxGK9Js_H3Vh0q6ruNHlGD5RG0_kE5M0,2878
 openstef/model/confidence_interval_applicator.py,sha256=VOdHsDJhfeyaq_cnk9QMUaZ2IumbiBBoW1zo8AuqDg0,9559
-openstef/model/fallback.py,sha256=g6TEuEhV4w07SCGkR_AvPf2up9f0ixGKQojYC-Ewl6Y,2812
+openstef/model/fallback.py,sha256=x60GVyl1c5DpebzkjJEMToZpMTD1c4FrhM-tBN9uizk,3177
 openstef/model/model_creator.py,sha256=fnhcVGUHskbuAys5kjlJ4GXKxbi9Eq5eAA19ex11Vv0,6658
 openstef/model/objective.py,sha256=0PZUbPzuyaYlpWEH_qPavO6ll7zwqTTUTfIrUzzFMbs,15585
 openstef/model/objective_creator.py,sha256=3jJgcmY1sm-Yoe3SfjKrJukrsqtYyloUFaPbBWqswhQ,2208
@@ -77,7 +77,7 @@ openstef/monitoring/teams.py,sha256=klN7Ge-0VktJbZ_I-K8MJIc3LWgdNy0MGL8b2TdoUR8,
 openstef/pipeline/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/pipeline/create_basecase_forecast.py,sha256=7IShIjEmjkzpNzWzQVKmYQvy0q_uwCGO-E0mSRmGdhw,4397
 openstef/pipeline/create_component_forecast.py,sha256=40fYKajdj4F9K7fzmL3euyvwTr0v-oO_5cXpya87A0c,5839
-openstef/pipeline/create_forecast.py,sha256=mVbbu7jM31NEwfaDeQPqF3Okps9H1oLfjhPPiJRL4zg,5582
+openstef/pipeline/create_forecast.py,sha256=rLGU7DXqAQNH_pkqIF8tvjOq0NldnKTKH2sylLrNiRg,5640
 openstef/pipeline/optimize_hyperparameters.py,sha256=w5LpZhW3KVklCJzaogNzyHfpMJfNqeRAnvyV4vi35wg,10953
 openstef/pipeline/train_create_forecast_backtest.py,sha256=hBJPxfDkbrmFSSGZrRH1vTiIVqJP-SWe0ibVpHT_8Qg,6048
 openstef/pipeline/train_model.py,sha256=O1pyATMQUkNZQ01FlOwG8r3gtKwRcx7YD73f-91umuo,19948
@@ -85,7 +85,7 @@ openstef/pipeline/utils.py,sha256=23mB31p19FoGWelLJzxNmqlzGwEr3fCDBEA37V2kpYY,21
 openstef/plotting/__init__.py,sha256=KQjXzyafCt1bE7XDrSeV4TDUIO7MkwN_Br4ASOcNI2g,163
 openstef/plotting/load_forecast_plotter.py,sha256=GWHVmUB2YosNj7TnSrMnxYAfM2Z1mNg5oRV9A_lJmQY,8129
 openstef/postprocessing/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
-openstef/postprocessing/postprocessing.py,sha256=lQz642SN7Stul7A95nFbn34dksVAcOPI8ktawyqOzbc,8816
+openstef/postprocessing/postprocessing.py,sha256=lKYsI-ckDy0jUwLPr1AlFRSfoMHMkXvnHuUFwomaJFM,9015
 openstef/preprocessing/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/preprocessing/preprocessing.py,sha256=bM_cSSSb2vGTD79RGzUrI6KoELbzlCyJwc7jqQGNEsE,1454
 openstef/tasks/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
@@ -104,8 +104,8 @@ openstef/tasks/utils/predictionjobloop.py,sha256=Ysy3zF5lzPMz_asYDKeF5m0qgVT3tCt
 openstef/tasks/utils/taskcontext.py,sha256=O-LZ_wHEl5vbT8oB7EYtOeMkvk6EqCnI1-KiyER7Eu4,5407
 openstef/validation/__init__.py,sha256=bIyGTSA4V5VoOLTwdaiJJAnozmpSzvQooVYlsf8H4eU,163
 openstef/validation/validation.py,sha256=r6UqkdH5TMjsGfn8Ta07K1jkqmrVmwcPGfyQvMmZyO4,11459
-openstef-3.4.75.dist-info/licenses/LICENSE,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907
-openstef-3.4.75.dist-info/METADATA,sha256=8Q6z9qqtBZrKepnjG6MSSXzfrSlZ8U2enknksgTBRBI,8834
-openstef-3.4.75.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-openstef-3.4.75.dist-info/top_level.txt,sha256=kD0H4PqrQoncZ957FvqwfBxa89kTrun4Z_RAPs_HhLs,9
-openstef-3.4.75.dist-info/RECORD,,
+openstef-3.4.77.dist-info/licenses/LICENSE,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907
+openstef-3.4.77.dist-info/METADATA,sha256=d8ogfqGlSvJIz8uiS3H2n66frGodeTDiGS4dAhjkve0,8834
+openstef-3.4.77.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+openstef-3.4.77.dist-info/top_level.txt,sha256=kD0H4PqrQoncZ957FvqwfBxa89kTrun4Z_RAPs_HhLs,9
+openstef-3.4.77.dist-info/RECORD,,

{openstef-3.4.75.dist-info → openstef-3.4.77.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.4.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any