Skip to content

Commit 4eb3389

Browse files
committed
doc updated
1 parent 8b167ab commit 4eb3389

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,22 @@ Below is an example of a ``forecast.yaml`` file with every parameter specified:
9191

9292
* **global_explanation_filename**: (Optional) The name of the global explanation file. It is saved in the output directory, with a default name of ``global_explanations.csv``.
9393

94-
* **local_explanation_filename**: (Optional) The name of the local explanation file. It is saved in the output directory, with a default name of ``local_explanations.csv``.
94+
* **local_explanation_filename**: (Optional) The name of the local explanation file. It is saved in the output directory, with a default name of ``local_explanations.csv``.
95+
96+
* **what_if_analysis**: (Optional) This dictionary defines the configuration for saving the model to the model store and setting up a model deployment server to enable real-time predictions and what-if analysis, with the following parameters:
97+
* **project_id**: The OCID of the data science project where the resources will be created.
98+
* **compartment_id**: The OCID of the compartment
99+
* **model_display_name**: The display name of the model used to save the model in the model store.
100+
* **model_deployment**: This dictionary describing the model deployment configuration. It includes:
101+
* **display_name**: The display name for the model deployment.
102+
* **initial_shape**: The compute shape for the initial model deployment.
103+
* **description**: A brief description of the model deployment.
104+
* **log_group**: The OCID of the log group where the logs are organized.
105+
* **log_id**: The OCID of the log where deployment logs are stored.
106+
* **auto_scaling**: (Optional) A dictionary specifying the auto-scaling configuration for the deployment. It includes:
107+
* **minimum_instance**: The minimum number of instances to maintain during auto-scaling.
108+
* **maximum_instance**: The maximum number of instances to scale up to during peak demand.
109+
* **cool_down_in_seconds**: The cooldown period (in seconds) to wait before performing another scaling action.
110+
* **scaling_metric**: The metric used for scaling actions. e.g. ``CPU_UTILIZATION`` or ``MEMORY_UTILIZATION``
111+
* **scale_in_threshold**: The utilization percentage below which the instances will scale in (reduce).
112+
* **scale_out_threshold**: The utilization percentage above which the instances will scale out (increase).

0 commit comments

Comments
 (0)