openstef 3.4.27__tar.gz → 3.4.28__tar.gz

{openstef-3.4.27 → openstef-3.4.28}/PKG-INFO

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

{openstef-3.4.27 → openstef-3.4.28}/openstef/data_classes/prediction_job.py

@@ -27,6 +27,7 @@ class PredictionJobDataClass(BaseModel):
         - ``"linear"``
         - ``"linear_quantile"``
         - ``"xgb_multioutput_quantile"``
+        - ``"flatliner"``
 
     If unsure what to pick, choose ``"xgb"``.
 

{openstef-3.4.27 → openstef-3.4.28}/openstef/enums.py

@@ -13,6 +13,7 @@ class MLModelType(Enum):
     LINEAR = "linear"
     LINEAR_QUANTILE = "linear_quantile"
     ARIMA = "arima"
+    FLATLINER = "flatliner"
 
 
 class ForecastType(Enum):

{openstef-3.4.27 → openstef-3.4.28}/openstef/model/confidence_interval_applicator.py

@@ -73,8 +73,11 @@ class ConfidenceIntervalApplicator:
                 result = self._add_quantiles_to_forecast_quantile_regression(
                     temp_forecast, self.model.quantiles
                 )
-                self.logger.warning('Quantiles are requested the model was not trained on. Using the quantiles the model was trained on', 
-                               requested_quantiles=pj["quantiles"], trained_quantiles=self.model.quantiles)
+                self.logger.warning(
+                    "Quantiles are requested the model was not trained on. Using the quantiles the model was trained on",
+                    requested_quantiles=pj["quantiles"],
+                    trained_quantiles=self.model.quantiles,
+                )
                 return result
 
         return self._add_quantiles_to_forecast_default(temp_forecast, pj["quantiles"])

{openstef-3.4.27 → openstef-3.4.28}/openstef/model/model_creator.py

@@ -13,6 +13,7 @@ from openstef.model.regressors.lgbm import LGBMOpenstfRegressor
 from openstef.model.regressors.linear import LinearOpenstfRegressor
 from openstef.model.regressors.linear_quantile import LinearQuantileOpenstfRegressor
 from openstef.model.regressors.regressor import OpenstfRegressor
+from openstef.model.regressors.flatliner import FlatlinerRegressor
 from openstef.model.regressors.xgb import XGBOpenstfRegressor
 from openstef.model.regressors.xgb_quantile import XGBQuantileOpenstfRegressor
 from openstef.model.regressors.xgb_multioutput_quantile import (
@@ -105,6 +106,9 @@ valid_model_kwargs = {
         "imputation_strategy",
         "fill_value",
     ],
+    MLModelType.FLATLINER: [
+        "quantiles",
+    ],
     MLModelType.LINEAR_QUANTILE: [
         "alpha",
         "quantiles",
@@ -134,6 +138,7 @@ class ModelCreator:
         MLModelType.LINEAR: LinearOpenstfRegressor,
         MLModelType.LINEAR_QUANTILE: LinearQuantileOpenstfRegressor,
         MLModelType.ARIMA: ARIMAOpenstfRegressor,
+        MLModelType.FLATLINER: FlatlinerRegressor,
     }
 
     @staticmethod

{openstef-3.4.27 → openstef-3.4.28}/openstef/model/regressors/dazls.py

@@ -52,6 +52,7 @@ class Dazls(BaseEstimator):
         Args:
             features: inputs for domain and adaptation model (domain_model_input, adaptation_model_input)
             target: the expected output (y_train)
+
         """
         x, y = (
             features.loc[:, self.baseline_input_columns],
@@ -76,6 +77,7 @@ class Dazls(BaseEstimator):
 
         Returns:
             prediction: The output prediction after both models.
+
         """
         model_test_data = x.loc[:, self.baseline_input_columns]
 
@@ -90,6 +92,7 @@ class Dazls(BaseEstimator):
 
         Returns:
             RMSE and R2 scores
+
         """
         rmse = (mean_squared_error(truth, prediction)) ** 0.5
         r2_score_value = r2_score(truth, prediction)
@@ -100,6 +103,7 @@ class Dazls(BaseEstimator):
 
         Returns:
             Summary represented by a string
+
         """
         summary_str = (
             f"{self.__name__} model summary:\n\n"

openstef-3.4.28/openstef/model/regressors/flatliner.py

@@ -0,0 +1,100 @@
+# SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+import re
+from typing import Dict, Union, Set, Optional, List
+
+import numpy as np
+import pandas as pd
+from sklearn.base import RegressorMixin
+from sklearn.linear_model import QuantileRegressor
+from sklearn.preprocessing import MinMaxScaler
+from sklearn.utils.validation import check_is_fitted
+
+from openstef.feature_engineering.missing_values_transformer import (
+    MissingValuesTransformer,
+)
+from openstef.model.regressors.regressor import OpenstfRegressor
+
+
+class FlatlinerRegressor(OpenstfRegressor, RegressorMixin):
+    feature_names_: List[str] = []
+
+    def __init__(self, quantiles=None):
+        """Initialize FlatlinerRegressor.
+
+        The model always predicts 0.0, regardless of the input features. The model is
+        meant to be used for flatliner locations that still expect a prediction while
+        preserving the prediction interface.
+        """
+        super().__init__()
+        self.quantiles = quantiles
+
+    @property
+    def feature_names(self) -> list:
+        """The names of the features used to train the model."""
+        check_is_fitted(self)
+        return self.feature_names_
+
+    @staticmethod
+    def _get_importance_names():
+        return {
+            "gain_importance_name": "total_gain",
+            "weight_importance_name": "weight",
+        }
+
+    @property
+    def can_predict_quantiles(self) -> bool:
+        """Attribute that indicates if the model predict particular quantiles."""
+        return True
+
+    def fit(self, x: pd.DataFrame, y: pd.Series, **kwargs) -> RegressorMixin:
+        """Fits flatliner model.
+
+        Args:
+            x: Feature matrix
+            y: Labels
+
+        Returns:
+            Fitted LinearQuantile model
+
+        """
+        self.feature_names_ = list(x.columns)
+        self.feature_importances_ = np.ones(len(self.feature_names_)) / (
+            len(self.feature_names_) or 1.0
+        )
+
+        return self
+
+    def predict(self, x: pd.DataFrame, quantile: float = 0.5, **kwargs) -> np.array:
+        """Makes a prediction for a desired quantile.
+
+        Args:
+            x: Feature matrix
+            quantile: Quantile for which a prediciton is desired,
+                note that only quantile are available for which a model is trained,
+                and that this is a quantile-model specific keyword
+
+        Returns:
+            Prediction
+
+        Raises:
+            ValueError in case no model is trained for the requested quantile
+
+        """
+        check_is_fitted(self)
+
+        return np.zeros(x.shape[0])
+
+    def _get_feature_importance_from_linear(self, quantile: float = 0.5) -> np.array:
+        check_is_fitted(self)
+        return np.array([0.0 for _ in self.feature_names_])
+
+    @classmethod
+    def _get_param_names(cls):
+        return [
+            "quantiles",
+        ]
+
+    def __sklearn_is_fitted__(self) -> bool:
+        return True

{openstef-3.4.27 → openstef-3.4.28}/openstef.egg-info/PKG-INFO

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

{openstef-3.4.27 → openstef-3.4.28}/openstef.egg-info/SOURCES.txt

@@ -53,6 +53,7 @@ openstef/model/regressors/__init__.py
 openstef/model/regressors/arima.py
 openstef/model/regressors/custom_regressor.py
 openstef/model/regressors/dazls.py
+openstef/model/regressors/flatliner.py
 openstef/model/regressors/lgbm.py
 openstef/model/regressors/linear.py
 openstef/model/regressors/linear_quantile.py

{openstef-3.4.27 → openstef-3.4.28}/setup.py

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