Skip to content

Commit d592c52

Browse files
committed
docs: Update forecast operator schema documentation
1 parent eec5ff0 commit d592c52

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

docs/source/user_guide/operators/forecast_operator/yaml_schema.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Below is an example of a ``forecast.yaml`` file with every parameter specified:
137137
- string
138138
- No
139139
- 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.
141141

142142
* - model_kwargs
143143
- dict
@@ -163,6 +163,18 @@ Below is an example of a ``forecast.yaml`` file with every parameter specified:
163163
- false
164164
- Handle outliers.
165165

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+
166178
* - generate_explanations
167179
- boolean
168180
- No
@@ -266,7 +278,7 @@ Further Description
266278
* **format**: (Optional) Specify the format for output data (e.g., ``csv``, ``json``, ``excel``).
267279
* **options**: (Optional) Include any additional arguments, such as connection parameters for storage.
268280

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``.
270282

271283
* **model_kwargs**: (Optional) A dictionary of arguments to pass directly to the model framework, allowing for detailed control over modeling.
272284

@@ -282,6 +294,10 @@ Further Description
282294
* **preprocessing**: (Optional) Controls preprocessing and feature engineering steps. This can be enabled or disabled using the ``enabled`` flag. The default is ``true``.
283295
* **steps**: (Optional) Specific preprocessing steps, such as ``missing_value_imputation`` and ``outlier_treatment``, which are enabled by default.
284296

297+
* **postprocessing**: (Optional) Controls postprocessing steps.
298+
* **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+
285301
* **metric**: (Optional) The metric to select during model evaluation. Options include ``MAPE``, ``RMSE``, ``MSE``, and ``SMAPE``. The default is ``MAPE``.
286302

287303
* **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
324340
* **cool_down_in_seconds**: The cooldown period (in seconds) to wait before performing another scaling action.
325341
* **scaling_metric**: The metric used for scaling actions. e.g. ``CPU_UTILIZATION`` or ``MEMORY_UTILIZATION``
326342
* **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

Comments
 (0)