openstef 3.4.14__tar.gz → 3.4.15__tar.gz

{openstef-3.4.14 → openstef-3.4.15}/PKG-INFO

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

{openstef-3.4.14 → openstef-3.4.15}/openstef/metrics/figure.py

@@ -71,6 +71,9 @@ def plot_data_series(
     Returns:
         A line plot of each passed data series.
 
+    Raises:
+        ValueError: If names is None and the number of series is greater than 3.
+
     """
     series_names = {
         1: ("series",),

{openstef-3.4.14 → openstef-3.4.15}/openstef/metrics/metrics.py

@@ -25,6 +25,9 @@ def get_eval_metric_function(metric_name: str) -> Callable:
     Returns:
         Function to calculate the metric.
 
+    Raises:
+        KeyError: If the metric is not available.
+
     """
     evaluation_function = {
         "rmse": rmse,
@@ -130,6 +133,9 @@ def r_mae_highest(
 
     The range is based on the load range of the previous two weeks.
 
+    Raises:
+        ValueError: If the length of the realised and forecast arrays are not equal.
+
     """
     # Check if length of both arrays is equal
     if len(np.array(realised)) != len(np.array(forecast)):
@@ -395,7 +401,7 @@ def xgb_quantile_obj(
     Args:
         preds: numpy.ndarray
         dmatrix: xgboost.DMatrix
-        quantile: float
+        quantile: float between 0 and 1
 
     Returns:
         Gradient and Hessian

{openstef-3.4.14 → openstef-3.4.15}/openstef/model/confidence_interval_applicator.py

@@ -74,6 +74,9 @@ class ConfidenceIntervalApplicator:
             Forecast with added standard deviation. DataFrame with columns:
                 "forecast", "stdev"
 
+        Raises:
+            ModelWithoutStDev: If the model does not have a valid standard deviation.
+
         """
         minimal_resolution: int = 15  # Minimal time resolution in minutes
         standard_deviation = self.model.standard_deviation

{openstef-3.4.14 → openstef-3.4.15}/openstef/model/regressors/xgb_quantile.py

@@ -52,6 +52,9 @@ class XGBQuantileOpenstfRegressor(OpenstfRegressor):
             alpha: Alpha
             max_delta_step: Maximum delta step
 
+        Raises:
+            ValueError in case quantile 0.5 is not in the requested quantiles
+
         """
         super().__init__()
         # Check if quantile 0.5 is pressent this is required

{openstef-3.4.14 → openstef-3.4.15}/openstef/model/serializer.py

@@ -147,6 +147,9 @@ class MLflowSerializer:
         Args:
             experiment_name: Name of the experiment, often the id of the predition job.
 
+        Raises:
+            LookupError: If model is not found in MLflow.
+
         """
         try:
             models_df = self._find_models(

{openstef-3.4.14 → openstef-3.4.15}/openstef/model_selection/model_selection.py

@@ -140,6 +140,9 @@ def split_data_train_validation_test(
         - Validation data.
         - Test data.
 
+    Raises:
+        ValueError: When the test and validation fractions are too high.
+
     """
     test_fraction = test_fraction if back_test else 0
     train_fraction = 1 - (test_fraction + validation_fraction)

{openstef-3.4.14 → openstef-3.4.15}/openstef/pipeline/create_basecase_forecast.py

@@ -38,6 +38,9 @@ def create_basecase_forecast_pipeline(
     Returns:
         Base case forecast
 
+    Raises:
+        NoRealisedLoadError: When no realised load for given datetime range.
+
     """
     logger = structlog.get_logger(__name__)
 

{openstef-3.4.14 → openstef-3.4.15}/openstef/pipeline/create_forecast.py

@@ -40,6 +40,10 @@ def create_forecast_pipeline(
     Returns:
         DataFrame with the forecast
 
+    Raises:
+        InputDataOngoingZeroFlatlinerError: When all recent load measurements are zero.
+        LookupError: When no model is found for the given prediction job in MLflow.
+
     """
     prediction_model_pid = pj["id"]
     # Use the alternative forecast model if it's specify in the pj
@@ -76,6 +80,9 @@ def create_forecast_pipeline_core(
     Returns:
         Forecast
 
+    Raises:
+        InputDataOngoingZeroFlatlinerError: When all recent load measurements are zero.
+
     """
     logger = structlog.get_logger(__name__)
 

{openstef-3.4.14 → openstef-3.4.15}/openstef/pipeline/optimize_hyperparameters.py

@@ -59,6 +59,9 @@ def optimize_hyperparameters_pipeline(
 
     Raises:
         ValueError: If the input_date is insufficient.
+        InputDataInsufficientError: If the input dataframe is empty.
+        InputDataWrongColumnOrderError: If the load column is missing in the input dataframe.
+        OldModelHigherScoreError: When old model is better than new model.
 
     Returns:
         Optimized hyperparameters.
@@ -119,6 +122,10 @@ def optimize_hyperparameters_pipeline_core(
 
     Raises:
         ValueError: If the input_date is insufficient.
+        InputDataInsufficientError: If the input dataframe is empty.
+        InputDataWrongColumnOrderError: If the load column is missing in the input dataframe.
+        OldModelHigherScoreError: When old model is better than new model.
+        InputDataOngoingZeroFlatlinerError: When all recent load measurements are zero.
 
     Returns:
         - Best model,

{openstef-3.4.14 → openstef-3.4.15}/openstef/pipeline/train_create_forecast_backtest.py

@@ -56,6 +56,11 @@ def train_model_and_forecast_back_test(
         - Validation data sets (list[pd.DataFrame])
         - Test data sets (list[pd.DataFrame])
 
+    Raises:
+        InputDataInsufficientError: when input data is insufficient.
+        InputDataWrongColumnOrderError: when input data has a invalid column order.
+        ValueError: when the horizon is a string and the corresponding column in not in the input data
+        InputDataOngoingZeroFlatlinerError: when all recent load measurements are zero.
     """
     if pj.backtest_split_func is None:
         backtest_split_func = backtest_split_default
@@ -124,6 +129,9 @@ def train_model_and_forecast_test_core(
         - The trained model
         - The forecast on the test set.
 
+    Raises:
+        NotImplementedError: When using invalid model type in the prediction job.
+        InputDataWrongColumnOrderError: When 'load' column is not first and 'horizon' column is not last.
     """
     model = train_model.train_pipeline_step_train_model(
         pj, modelspecs, train_data, validation_data

{openstef-3.4.14 → openstef-3.4.15}/openstef/pipeline/train_model.py

@@ -60,6 +60,13 @@ def train_model_pipeline(
             - The validation dataset with forecasts
             - The test dataset with forecasts
 
+    Raises:
+        InputDataInsufficientError: when input data is insufficient.
+        InputDataWrongColumnOrderError: when input data has a invalid column order.
+            'load' column should be first and 'horizon' column last.
+        OldModelHigherScoreError: When old model is better than new model.
+        SkipSaveTrainingForecasts: If old model is better or younger than `MAXIMUM_MODEL_AGE`, the model is not saved.
+
     """
     # Initialize serializer
     serializer = MLflowSerializer(mlflow_tracking_uri=mlflow_tracking_uri)
@@ -164,6 +171,7 @@ def train_model_pipeline_core(
         InputDataInsufficientError: when input data is insufficient.
         InputDataWrongColumnOrderError: when input data has a invalid column order.
         OldModelHigherScoreError: When old model is better than new model.
+        InputDataOngoingZeroFlatlinerError: when all recent load measurements are zero.
 
     Returns:
         - Fitted_model (OpenstfRegressor)
@@ -257,6 +265,8 @@ def train_pipeline_common(
     Raises:
         InputDataInsufficientError: when input data is insufficient.
         InputDataWrongColumnOrderError: when input data has a invalid column order.
+            'load' column should be first and 'horizon' column last.
+        InputDataOngoingZeroFlatlinerError: when all recent load measurements are zero.
 
     """
     data_with_features = train_pipeline_step_compute_features(
@@ -346,6 +356,7 @@ def train_pipeline_step_compute_features(
         InputDataInsufficientError: when input data is insufficient.
         InputDataWrongColumnOrderError: when input data has a invalid column order.
         ValueError: when the horizon is a string and the corresponding column in not in the input data
+        InputDataOngoingZeroFlatlinerError: when all recent load measurements are zero.
 
     """
     if input_data.empty:
@@ -419,6 +430,10 @@ def train_pipeline_step_train_model(
     Returns:
         The trained model
 
+    Raises:
+        NotImplementedError: When using invalid model type in the prediction job.
+        InputDataWrongColumnOrderError: When 'load' column is not first and 'horizon' column is not last.
+
     """
     # Test if first column is "load" and last column is "horizon"
     if train_data.columns[0] != "load" or train_data.columns[-1] != "horizon":

{openstef-3.4.14 → openstef-3.4.15}/openstef/pipeline/utils.py

@@ -27,6 +27,9 @@ def generate_forecast_datetime_range(
     Returns:
         Start and end datetimes of the forecast range.
 
+    Raises:
+        ValueError: If the target column does not have null values.
+
     """
     # By labeling the True/False values (based on the isnull() statement) as clusters,
     # we find what True value belongs to what cluster and the amount of True clusters.

{openstef-3.4.14 → openstef-3.4.15}/openstef/tasks/create_components_forecast.py

@@ -51,6 +51,10 @@ def create_components_forecast_task(
         pj: Prediction job
         context: Contect object that holds a config manager and a database connection
 
+    Raises:
+        ComponentForecastTooShortHorizonError: If the forecast horizon is too short
+         (less than 30 minutes in advance)
+
     """
     logger = structlog.get_logger(__name__)
     if pj["train_components"] == 0:

{openstef-3.4.14 → openstef-3.4.15}/openstef/tasks/train_model.py

@@ -65,6 +65,10 @@ def train_model_task(
         datetime_start: Start
         datetime_end: End
 
+    Raises:
+        SkipSaveTrainingForecasts: If old model is better or too young, you don't need to save the traing forcast.
+        InputDataOngoingZeroFlatlinerError: If all recent load measurements are zero.
+
     """
     # Check pipeline types
     if PipelineType.TRAIN not in pj.pipelines_to_run:

{openstef-3.4.14 → openstef-3.4.15}/openstef/validation/validation.py

@@ -37,6 +37,9 @@ def validate(
     Returns:
         Dataframe where repeated values are set to None
 
+    Raises:
+        InputDataOngoingZeroFlatlinerError: If all recent load measurements are zero.
+
     """
     logger = structlog.get_logger(__name__)
 

{openstef-3.4.14 → openstef-3.4.15}/openstef.egg-info/PKG-INFO

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

{openstef-3.4.14 → openstef-3.4.15}/setup.py

@@ -29,7 +29,7 @@ def read_long_description_from_readme():
 
 setup(
     name="openstef",
-    version="3.4.14",
+    version="3.4.15",
     packages=find_packages(include=["openstef", "openstef.*"]),
     description="Open short term energy forecaster",
     long_description=read_long_description_from_readme(),