updating docs formatting

oracle · Oct 17, 2023 · b1cdc4b · b1cdc4b
1 parent fcf7c16
commit b1cdc4b
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 56 deletions.
diff --git a/docs/source/user_guide/operators/forecasting_operator/examples.rst b/docs/source/user_guide/operators/forecasting_operator/examples.rst
@@ -12,15 +12,15 @@ The simplest yaml file is generated by the ``ads operator init --type forecast``
     type: forecast
     version: v1
     spec:
-    datetime_column:
-        name: Date
-    historical_data:
-        url: data.csv
-    horizon:
-        interval_unit: M
-        periods: 3
-    model: auto
-    target_column: target
+        datetime_column:
+            name: Date
+        historical_data:
+            url: data.csv
+        horizon:
+            interval_unit: M
+            periods: 3
+        model: auto
+        target_column: target
 
 
 
@@ -34,38 +34,38 @@ The yaml can also be maximally stated as follows:
     type: forecast
     version: v1
     spec:
-    historical_data:
-        columns:
-        - Date
-        - target
-        - Series
-        format: "csv"
-        url: historical_data.csv
-    additional_data:
-        url: additional_data.csv
-    test_data:
-        url: test_data.csv
-    output_directory: 
-        url: oci://<bucket>@<namespace>/results/
-    target_category_columns:
-        - Series
-    target_column: target
-    confidence_interval_width: 0.8
-    datetime_column:
-        format: %dd%mm%yy
-        name: Date
-    forecast_filename: forecast.csv
-    horizon:
-        interval: 1
-        interval_unit: M
-        periods: 3
-    metric: smape
-    metrics_filename: metrics.csv
-    model: automlx
-    model_kwargs: 
-    preprocessing: true
-    report_file_name: report.html
-    report_theme: light
-    report_title: report
-    tuning: 
-        n_trials: 5
+        historical_data:
+            columns:
+            - Date
+            - target
+            - Series
+            format: "csv"
+            url: historical_data.csv
+        additional_data:
+            url: additional_data.csv
+        test_data:
+            url: test_data.csv
+        output_directory: 
+            url: oci://<bucket>@<namespace>/results/
+        target_category_columns:
+            - Series
+        target_column: target
+        confidence_interval_width: 0.8
+        datetime_column:
+            format: %dd%mm%yy
+            name: Date
+        forecast_filename: forecast.csv
+        horizon:
+            interval: 1
+            interval_unit: M
+            periods: 3
+        metric: smape
+        metrics_filename: metrics.csv
+        model: automlx
+        model_kwargs: 
+        preprocessing: true
+        report_file_name: report.html
+        report_theme: light
+        report_title: report
+        tuning: 
+            n_trials: 5
diff --git a/docs/source/user_guide/operators/forecasting_operator/getting_started.rst b/docs/source/user_guide/operators/forecasting_operator/getting_started.rst
@@ -15,23 +15,22 @@ After having set up ``ads opctl`` on your desired machine using ``ads opctl conf
 
 These details exactly match the inital forecast.yaml file generated by running ``ads operator init --type forecast``:
 
-```
+.. code-block:: yaml
 
     kind: operator
     type: forecast
     version: v1
     spec:
-    datetime_column:
-        name: Date
-    historical_data:
-        url: data.csv
-    horizon:
-        interval_unit: M
-        periods: 3
-    model: auto
-    target_column: target
-
-```
+        datetime_column:
+            name: Date
+        historical_data:
+            url: data.csv
+        horizon:
+            interval_unit: M
+            periods: 3
+        model: auto
+        target_column: target
+
 
 Optionally, you are able to specify much more. The most common additions are: