You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/user_guide/operators/forecast_operator/yaml_schema.rst
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ Below is an example of a ``forecast.yaml`` file with every parameter specified:
137
137
- string
138
138
- No
139
139
- prophet
140
-
- Model to use. Options: prophet, arima, neuralprophet, automlx, autots, auto-select.
140
+
- Model to use. Options: prophet, arima, neuralprophet, automlx, autots, auto-select, auto-select-series.
141
141
142
142
* - model_kwargs
143
143
- dict
@@ -163,6 +163,18 @@ Below is an example of a ``forecast.yaml`` file with every parameter specified:
163
163
- false
164
164
- Handle outliers.
165
165
166
+
* - postprocessing.set_min_forecast
167
+
- integer
168
+
- No
169
+
-
170
+
- This can be used to define the minimum forecast in the output.
171
+
172
+
* - postprocessing.set_max_forecast
173
+
- integer
174
+
- No
175
+
-
176
+
- This can be used to define the maximum forecast in the output.
177
+
166
178
* - generate_explanations
167
179
- boolean
168
180
- No
@@ -266,7 +278,7 @@ Further Description
266
278
* **format**: (Optional) Specify the format for output data (e.g., ``csv``, ``json``, ``excel``).
267
279
* **options**: (Optional) Include any additional arguments, such as connection parameters for storage.
268
280
269
-
* **model**: (Optional) The name of the model framework to use. Defaults to ``auto-select``. Available options include ``arima``, ``prophet``, ``neuralprophet``, ``autots``, and ``auto-select``.
281
+
* **model**: (Optional) The name of the model framework to use. Defaults to ``prophet``. Available options include ``arima``, ``prophet``, ``neuralprophet``, ``automlx``, ``autots``, ``auto-select``, and ``auto-select-series``.
270
282
271
283
* **model_kwargs**: (Optional) A dictionary of arguments to pass directly to the model framework, allowing for detailed control over modeling.
272
284
@@ -282,6 +294,10 @@ Further Description
282
294
* **preprocessing**: (Optional) Controls preprocessing and feature engineering steps. This can be enabled or disabled using the ``enabled`` flag. The default is ``true``.
283
295
* **steps**: (Optional) Specific preprocessing steps, such as ``missing_value_imputation`` and ``outlier_treatment``, which are enabled by default.
* **set_min_forecast**: (Optional) This can be used to define the minimum forecast in the output.
299
+
* **set_max_forecast**: (Optional) This can be used to define the maximum forecast in the output.
300
+
285
301
* **metric**: (Optional) The metric to select during model evaluation. Options include ``MAPE``, ``RMSE``, ``MSE``, and ``SMAPE``. The default is ``MAPE``.
286
302
287
303
* **confidence_interval_width**: (Optional) The width of the confidence interval to calculate in the forecast. The default is 0.80, indicating an 80% confidence interval.
@@ -324,4 +340,4 @@ Further Description
324
340
* **cool_down_in_seconds**: The cooldown period (in seconds) to wait before performing another scaling action.
325
341
* **scaling_metric**: The metric used for scaling actions. e.g. ``CPU_UTILIZATION`` or ``MEMORY_UTILIZATION``
326
342
* **scale_in_threshold**: The utilization percentage below which the instances will scale in (reduce).
327
-
* **scale_out_threshold**: The utilization percentage above which the instances will scale out (increase).
343
+
* **scale_out_threshold**: The utilization percentage above which the instances will scale out (increase).
0 commit comments