fix: removed field use_future_covariates and related unit tests from TimeSeriesModelConfig

Author: rvasahu-amazon

src/sagemaker/clarify.py

@@ -347,7 +347,6 @@
             SchemaOptional("time_series_predictor_config"): {
                 "forecast": str,
                 "forecast_horizon": int,
-                SchemaOptional("use_future_covariates"): bool,
             },
         },
     }
@@ -805,15 +804,12 @@ def __init__(
         self,
         forecast: str,
         forecast_horizon: int = TS_MODEL_DEFAULT_FORECAST_HORIZON,
-        use_future_covariates: Optional[bool] = False,
     ):
         """Initializes model configuration fields for TimeSeries explainability use cases.
 
         Args:
             forecast (str): JMESPath expression to extract the forecast result.
             forecast_horizon (int):  An integer that tells the forecast horizon.
-            use_future_covariates (None or bool): If set as True, future covariates
-                included in model input and used for forecasting
 
         Raises:
             AssertionError: when either ``forecast`` or ``forecast_horizon`` are not provided
@@ -829,15 +825,10 @@ def __init__(
             raise ValueError("Please provide a string JMESPath expression for ``forecast``.")
         if not isinstance(forecast_horizon, int):
             raise ValueError("Please provide an integer ``forecast_horizon``.")
-        if use_future_covariates and not isinstance(use_future_covariates, bool):
-            raise ValueError("Please provide a boolean value for ``use_future_covariates``.")
         # add fields to an internal config dictionary
         self.predictor_config = dict()
         _set(forecast, "forecast", self.predictor_config)
         _set(forecast_horizon, "forecast_horizon", self.predictor_config)
-        _set(
-            use_future_covariates, "use_future_covariates", self.predictor_config
-        )  # _set() does nothing if a given argument is None
 
     def get_predictor_config(self):
         """Returns TimeSeries predictor config dictionary"""

tests/unit/test_clarify.py

@@ -897,7 +897,6 @@ def test_time_series_model_config(self):
         expected_config = {
             "forecast": forecast,
             "forecast_horizon": TS_MODEL_DEFAULT_FORECAST_HORIZON,
-            "use_future_covariates": False,
         }
         # WHEN
         ts_model_config = TimeSeriesModelConfig(
@@ -919,7 +918,6 @@ def test_time_series_model_config_with_forecast_horizon(self):
         expected_config = {
             "forecast": forecast,
             "forecast_horizon": forecast_horizon,
-            "use_future_covariates": False,
         }
         # WHEN
         ts_model_config = TimeSeriesModelConfig(
@@ -929,97 +927,39 @@ def test_time_series_model_config_with_forecast_horizon(self):
         # THEN
         assert ts_model_config.predictor_config == expected_config
 
-    def test_time_series_model_config_with_future_covariates(self):
-        """
-        GIVEN a valid forecast expression
-        WHEN a TimeSeriesModelConfig is constructed with it and use_future_covariates is True
-        THEN the predictor_config dictionary matches the expected
-        """
-        # GIVEN
-        forecast = "results.[forecast]"  # mock JMESPath expression for forecast
-        # create expected output
-        expected_config = {
-            "forecast": forecast,
-            "forecast_horizon": TS_MODEL_DEFAULT_FORECAST_HORIZON,
-            "use_future_covariates": True,
-        }
-        # WHEN
-        ts_model_config = TimeSeriesModelConfig(
-            forecast,
-            use_future_covariates=True,
-        )
-        # THEN
-        assert ts_model_config.predictor_config == expected_config
-
-    def test_time_series_model_config_with_horizon_and_covariates(self):
-        """
-        GIVEN a valid forecast expression and forecast horizon
-        WHEN a TimeSeriesModelConfig is constructed with it and use_future_covariates is True
-        THEN the predictor_config dictionary matches the expected
-        """
-        # GIVEN
-        forecast = "results.[forecast]"  # mock JMESPath expression for forecast
-        forecast_horizon = 25  # non-default forecast horizon
-        # create expected output
-        expected_config = {
-            "forecast": forecast,
-            "forecast_horizon": forecast_horizon,
-            "use_future_covariates": True,
-        }
-        # WHEN
-        ts_model_config = TimeSeriesModelConfig(
-            forecast,
-            forecast_horizon=forecast_horizon,
-            use_future_covariates=True,
-        )
-        # THEN
-        assert ts_model_config.predictor_config == expected_config
-
     @pytest.mark.parametrize(
-        ("forecast", "forecast_horizon", "use_future_covariates", "error", "error_message"),
+        ("forecast", "forecast_horizon", "error", "error_message"),
         [
             (
                 None,
                 TS_MODEL_DEFAULT_FORECAST_HORIZON,
-                None,
                 AssertionError,
                 "Please provide ``forecast``, a JMESPath expression to extract the forecast result.",
             ),
             (
                 "results.[forecast]",
                 None,
-                None,
                 AssertionError,
                 "Please provide an integer ``forecast_horizon``.",
             ),
             (
                 123,
                 TS_MODEL_DEFAULT_FORECAST_HORIZON,
-                None,
                 ValueError,
                 "Please provide a string JMESPath expression for ``forecast``.",
             ),
             (
                 "results.[forecast]",
                 "Not an int",
-                None,
                 ValueError,
                 "Please provide an integer ``forecast_horizon``.",
             ),
-            (
-                "results.[forecast]",
-                TS_MODEL_DEFAULT_FORECAST_HORIZON,
-                "Not a bool",
-                ValueError,
-                "Please provide a boolean value for ``use_future_covariates``.",
-            ),
         ],
     )
     def test_time_series_model_config_invalid(
         self,
         forecast,
         forecast_horizon,
-        use_future_covariates,
         error,
         error_message,
     ):
@@ -1032,7 +972,6 @@ def test_time_series_model_config_invalid(
             TimeSeriesModelConfig(
                 forecast=forecast,
                 forecast_horizon=forecast_horizon,
-                use_future_covariates=use_future_covariates,
             )
 
     def test_model_config_with_time_series(self):
@@ -1064,7 +1003,6 @@ def test_model_config_with_time_series(self):
         mock_ts_model_config_dict = {
             "forecast": forecast,
             "forecast_horizon": forecast_horizon,
-            "use_future_covariates": True,
         }
         mock_ts_model_config = Mock()
         mock_ts_model_config.get_predictor_config.return_value = mock_ts_model_config_dict