oracle-ads 2.13.0__py3-none-any.whl → 2.13.1rc0__py3-none-any.whl

ads/opctl/anomaly_detection.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2025 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+from ads.opctl.operator.lowcode.anomaly.__main__ import operate
+from ads.opctl.operator.lowcode.anomaly.operator_config import AnomalyOperatorConfig
+
+if __name__ == "__main__":
+    config = AnomalyOperatorConfig()
+    operate(config)

ads/opctl/forecast.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2025 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+from ads.opctl.operator.lowcode.forecast.__main__ import operate
+from ads.opctl.operator.lowcode.forecast.operator_config import ForecastOperatorConfig
+
+if __name__ == "__main__":
+    config = ForecastOperatorConfig()
+    operate(config)

ads/opctl/operator/lowcode/forecast/__main__.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2023, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2023, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import json
@@ -15,17 +14,17 @@ from ads.opctl import logger
 from ads.opctl.operator.common.const import ENV_OPERATOR_ARGS
 from ads.opctl.operator.common.utils import _parse_input_args
 
+from .model.forecast_datasets import ForecastDatasets, ForecastResults
 from .operator_config import ForecastOperatorConfig
-from .model.forecast_datasets import ForecastDatasets
 from .whatifserve import ModelDeploymentManager
 
 
-def operate(operator_config: ForecastOperatorConfig) -> None:
+def operate(operator_config: ForecastOperatorConfig) -> ForecastResults:
     """Runs the forecasting operator."""
     from .model.factory import ForecastOperatorModelFactory
 
     datasets = ForecastDatasets(operator_config)
-    ForecastOperatorModelFactory.get_model(
+    results = ForecastOperatorModelFactory.get_model(
         operator_config, datasets
     ).generate_report()
     # saving to model catalog
@@ -36,6 +35,7 @@ def operate(operator_config: ForecastOperatorConfig) -> None:
         if spec.what_if_analysis.model_deployment:
             mdm.create_deployment()
         mdm.save_deployment_info()
+    return results
 
 
 def verify(spec: Dict, **kwargs: Dict) -> bool:

ads/opctl/operator/lowcode/forecast/model/arima.py

@@ -116,7 +116,10 @@ class ArimaOperatorModel(ForecastOperatorBaseModel):
                 lower_bound=self.get_horizon(forecast["yhat_lower"]).values,
             )
 
-            self.models[s_id] = model
+            self.models[s_id] = {}
+            self.models[s_id]["model"] = model
+            self.models[s_id]["le"] = self.le[s_id]
+            self.models[s_id]["predict_component_cols"] = X_pred.columns
 
             params = vars(model).copy()
             for param in ["arima_res_", "endog_index_"]:
@@ -163,7 +166,7 @@ class ArimaOperatorModel(ForecastOperatorBaseModel):
             sec5_text = rc.Heading("ARIMA Model Parameters", level=2)
             blocks = [
                 rc.Html(
-                    m.summary().as_html(),
+                    m['model'].summary().as_html(),
                     label=s_id if self.target_cat_col else None,
                 )
                 for i, (s_id, m) in enumerate(self.models.items())
@@ -251,7 +254,7 @@ class ArimaOperatorModel(ForecastOperatorBaseModel):
     def get_explain_predict_fn(self, series_id):
         def _custom_predict(
             data,
-            model=self.models[series_id],
+            model=self.models[series_id]["model"],
             dt_column_name=self.datasets._datetime_column_name,
             target_col=self.original_target_column,
         ):

ads/opctl/operator/lowcode/forecast/model/automlx.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2023, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2023, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 import logging
 import os
@@ -56,8 +56,8 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
         )
         return model_kwargs_cleaned, time_budget
 
-    def preprocess(self, data):  # TODO: re-use self.le for explanations
-        _, df_encoded = _label_encode_dataframe(
+    def preprocess(self, data, series_id):  # TODO: re-use self.le for explanations
+        self.le[series_id], df_encoded = _label_encode_dataframe(
             data,
             no_encode={self.spec.datetime_column.name, self.original_target_column},
         )
@@ -66,8 +66,7 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
     @runtime_dependency(
         module="automlx",
         err_msg=(
-            "Please run `pip3 install oracle-automlx>=23.4.1` and "
-            "`pip3 install oracle-automlx[forecasting]>=23.4.1` "
+            "Please run `pip3 install oracle-automlx[forecasting]>=25.1.1` "
             "to install the required dependencies for automlx."
         ),
     )
@@ -105,7 +104,7 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
             engine_opts = (
                 None
                 if engine_type == "local"
-                else ({"ray_setup": {"_temp_dir": "/tmp/ray-temp"}},)
+                else {"ray_setup": {"_temp_dir": "/tmp/ray-temp"}}
             )
             init(
                 engine=engine_type,
@@ -125,7 +124,7 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
                 self.forecast_output.init_series_output(
                     series_id=s_id, data_at_series=df
                 )
-                data = self.preprocess(df)
+                data = self.preprocess(df, s_id)
                 data_i = self.drop_horizon(data)
                 X_pred = self.get_horizon(data).drop(target, axis=1)
 
@@ -157,7 +156,9 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
                     target
                 ].values
 
-                self.models[s_id] = model
+                self.models[s_id] = {}
+                self.models[s_id]["model"] = model
+                self.models[s_id]["le"] = self.le[s_id]
 
                 # In case of Naive model, model.forecast function call does not return confidence intervals.
                 if f"{target}_ci_upper" not in summary_frame:
@@ -218,7 +219,8 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
         other_sections = []
 
         if len(self.models) > 0:
-            for s_id, m in models.items():
+            for s_id, artifacts in models.items():
+                m = artifacts["model"]
                 selected_models[s_id] = {
                     "series_id": s_id,
                     "selected_model": m.selected_model_,
@@ -247,17 +249,18 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
                 self.explain_model()
 
                 global_explanation_section = None
-                if self.spec.explanations_accuracy_mode != SpeedAccuracyMode.AUTOMLX:
-                    # Convert the global explanation data to a DataFrame
-                    global_explanation_df = pd.DataFrame(self.global_explanation)
 
-                    self.formatted_global_explanation = (
-                        global_explanation_df / global_explanation_df.sum(axis=0) * 100
-                    )
-                    self.formatted_global_explanation = self.formatted_global_explanation.rename(
-                        {self.spec.datetime_column.name: ForecastOutputColumns.DATE},
-                        axis=1,
-                    )
+                # Convert the global explanation data to a DataFrame
+                global_explanation_df = pd.DataFrame(self.global_explanation)
+
+                self.formatted_global_explanation = (
+                    global_explanation_df / global_explanation_df.sum(axis=0) * 100
+                )
+
+                self.formatted_global_explanation.rename(
+                    columns={self.spec.datetime_column.name: ForecastOutputColumns.DATE},
+                    inplace=True,
+                )
 
                 aggregate_local_explanations = pd.DataFrame()
                 for s_id, local_ex_df in self.local_explanation.items():
@@ -269,11 +272,15 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
                 self.formatted_local_explanation = aggregate_local_explanations
 
                 if not self.target_cat_col:
-                    self.formatted_global_explanation = self.formatted_global_explanation.rename(
-                        {"Series 1": self.original_target_column},
-                        axis=1,
+                    self.formatted_global_explanation = (
+                        self.formatted_global_explanation.rename(
+                            {"Series 1": self.original_target_column},
+                            axis=1,
+                        )
+                    )
+                    self.formatted_local_explanation.drop(
+                        "Series", axis=1, inplace=True
                     )
-                    self.formatted_local_explanation.drop("Series", axis=1, inplace=True)
 
                 # Create a markdown section for the global explainability
                 global_explanation_section = rc.Block(
@@ -320,7 +327,7 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
         )
 
     def get_explain_predict_fn(self, series_id):
-        selected_model = self.models[series_id]
+        selected_model = self.models[series_id]["model"]
 
         # If training date, use method below. If future date, use forecast!
         def _custom_predict_fn(
@@ -338,12 +345,12 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
             data[dt_column_name] = seconds_to_datetime(
                 data[dt_column_name], dt_format=self.spec.datetime_column.format
             )
-            data = self.preprocess(data)
+            data = self.preprocess(data, series_id)
             horizon_data = horizon_data.drop(target_col, axis=1)
             horizon_data[dt_column_name] = seconds_to_datetime(
                 horizon_data[dt_column_name], dt_format=self.spec.datetime_column.format
             )
-            horizon_data = self.preprocess(horizon_data)
+            horizon_data = self.preprocess(horizon_data, series_id)
 
             rows = []
             for i in range(data.shape[0]):
@@ -421,8 +428,10 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
                 if self.spec.explanations_accuracy_mode == SpeedAccuracyMode.AUTOMLX:
                     # Use the MLExplainer class from AutoMLx to generate explanations
                     explainer = automlx.MLExplainer(
-                        self.models[s_id],
-                        self.datasets.additional_data.get_data_for_series(series_id=s_id)
+                        self.models[s_id]["model"],
+                        self.datasets.additional_data.get_data_for_series(
+                            series_id=s_id
+                        )
                         .drop(self.spec.datetime_column.name, axis=1)
                         .head(-self.spec.horizon)
                         if self.spec.additional_data
@@ -433,7 +442,9 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
 
                     # Generate explanations for the forecast
                     explanations = explainer.explain_prediction(
-                        X=self.datasets.additional_data.get_data_for_series(series_id=s_id)
+                        X=self.datasets.additional_data.get_data_for_series(
+                            series_id=s_id
+                        )
                         .drop(self.spec.datetime_column.name, axis=1)
                         .tail(self.spec.horizon)
                         if self.spec.additional_data
@@ -445,7 +456,9 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
                     explanations_df = pd.concat(
                         [exp.to_dataframe() for exp in explanations]
                     )
-                    explanations_df["row"] = explanations_df.groupby("Feature").cumcount()
+                    explanations_df["row"] = explanations_df.groupby(
+                        "Feature"
+                    ).cumcount()
                     explanations_df = explanations_df.pivot(
                         index="row", columns="Feature", values="Attribution"
                     )
@@ -453,9 +466,18 @@ class AutoMLXOperatorModel(ForecastOperatorBaseModel):
 
                     # Store the explanations in the local_explanation dictionary
                     self.local_explanation[s_id] = explanations_df
+
+                    self.global_explanation[s_id] = dict(
+                        zip(
+                            self.local_explanation[s_id].columns,
+                            np.nanmean((self.local_explanation[s_id]), axis=0),
+                        )
+                    )
                 else:
                     # Fall back to the default explanation generation method
                     super().explain_model()
             except Exception as e:
-                logger.warning(f"Failed to generate explanations for series {s_id} with error: {e}.")
+                logger.warning(
+                    f"Failed to generate explanations for series {s_id} with error: {e}."
+                )
                 logger.debug(f"Full Traceback: {traceback.format_exc()}")

ads/opctl/operator/lowcode/forecast/model/base_model.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2023, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2023, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import logging
@@ -19,6 +19,7 @@ import report_creator as rc
 from ads.common.decorator.runtime_dependency import runtime_dependency
 from ads.common.object_storage_details import ObjectStorageDetails
 from ads.opctl import logger
+from ads.opctl.operator.lowcode.common.const import DataColumns
 from ads.opctl.operator.lowcode.common.utils import (
     datetime_to_seconds,
     disable_print,
@@ -28,7 +29,6 @@ from ads.opctl.operator.lowcode.common.utils import (
     seconds_to_datetime,
     write_data,
 )
-from ads.opctl.operator.lowcode.common.const import DataColumns
 from ads.opctl.operator.lowcode.forecast.model.forecast_datasets import TestData
 from ads.opctl.operator.lowcode.forecast.utils import (
     _build_metrics_df,
@@ -49,10 +49,9 @@ from ..const import (
     SpeedAccuracyMode,
     SupportedMetrics,
     SupportedModels,
-    BACKTEST_REPORT_NAME,
 )
 from ..operator_config import ForecastOperatorConfig, ForecastOperatorSpec
-from .forecast_datasets import ForecastDatasets
+from .forecast_datasets import ForecastDatasets, ForecastResults
 
 logging.getLogger("report_creator").setLevel(logging.WARNING)
 
@@ -127,8 +126,9 @@ class ForecastOperatorBaseModel(ABC):
             if self.spec.generate_report or self.spec.generate_metrics:
                 self.eval_metrics = self.generate_train_metrics()
                 if not self.target_cat_col:
-                    self.eval_metrics.rename({"Series 1": self.original_target_column},
-                                             axis=1, inplace=True)
+                    self.eval_metrics.rename(
+                        {"Series 1": self.original_target_column}, axis=1, inplace=True
+                    )
 
                 if self.spec.test_data:
                     try:
@@ -140,8 +140,11 @@ class ForecastOperatorBaseModel(ABC):
                             elapsed_time=elapsed_time,
                         )
                         if not self.target_cat_col:
-                            self.test_eval_metrics.rename({"Series 1": self.original_target_column},
-                                                     axis=1, inplace=True)
+                            self.test_eval_metrics.rename(
+                                {"Series 1": self.original_target_column},
+                                axis=1,
+                                inplace=True,
+                            )
                     except Exception:
                         logger.warn("Unable to generate Test Metrics.")
                         logger.debug(f"Full Traceback: {traceback.format_exc()}")
@@ -223,17 +226,23 @@ class ForecastOperatorBaseModel(ABC):
                     rc.Block(
                         first_10_title,
                         # series_subtext,
-                        rc.Select(blocks=first_5_rows_blocks) if self.target_cat_col else first_5_rows_blocks[0],
+                        rc.Select(blocks=first_5_rows_blocks)
+                        if self.target_cat_col
+                        else first_5_rows_blocks[0],
                     ),
                     rc.Block(
                         last_10_title,
                         # series_subtext,
-                        rc.Select(blocks=last_5_rows_blocks) if self.target_cat_col else last_5_rows_blocks[0],
+                        rc.Select(blocks=last_5_rows_blocks)
+                        if self.target_cat_col
+                        else last_5_rows_blocks[0],
                     ),
                     rc.Block(
                         summary_title,
                         # series_subtext,
-                        rc.Select(blocks=data_summary_blocks) if self.target_cat_col else data_summary_blocks[0],
+                        rc.Select(blocks=data_summary_blocks)
+                        if self.target_cat_col
+                        else data_summary_blocks[0],
                     ),
                     rc.Separator(),
                 )
@@ -308,7 +317,7 @@ class ForecastOperatorBaseModel(ABC):
                         horizon=self.spec.horizon,
                         test_data=test_data,
                         ci_interval_width=self.spec.confidence_interval_width,
-                        target_category_column=self.target_cat_col
+                        target_category_column=self.target_cat_col,
                     )
                     if (
                         series_name is not None
@@ -341,11 +350,12 @@ class ForecastOperatorBaseModel(ABC):
                 )
 
             # save the report and result CSV
-            self._save_report(
+            return self._save_report(
                 report_sections=report_sections,
                 result_df=result_df,
                 metrics_df=self.eval_metrics,
                 test_metrics_df=self.test_eval_metrics,
+                test_data=test_data,
             )
 
     def _test_evaluate_metrics(self, elapsed_time=0):
@@ -462,10 +472,12 @@ class ForecastOperatorBaseModel(ABC):
         result_df: pd.DataFrame,
         metrics_df: pd.DataFrame,
         test_metrics_df: pd.DataFrame,
+        test_data: pd.DataFrame,
     ):
         """Saves resulting reports to the given folder."""
 
         unique_output_dir = self.spec.output_directory.url
+        results = ForecastResults()
 
         if ObjectStorageDetails.is_oci_path(unique_output_dir):
             storage_options = default_signer()
@@ -491,13 +503,23 @@ class ForecastOperatorBaseModel(ABC):
                         f2.write(f1.read())
 
         # forecast csv report
-        result_df = result_df if self.target_cat_col else result_df.drop(DataColumns.Series, axis=1)
+        # todo: add test data into forecast.csv
+        # if self.spec.test_data is not None:
+        #     test_data_dict = test_data.get_dict_by_series()
+        #     for series_id, test_data_values in test_data_dict.items():
+        #         result_df[DataColumns.Series] = test_data_values[]
+        result_df = (
+            result_df
+            if self.target_cat_col
+            else result_df.drop(DataColumns.Series, axis=1)
+        )
         write_data(
             data=result_df,
             filename=os.path.join(unique_output_dir, self.spec.forecast_filename),
             format="csv",
             storage_options=storage_options,
         )
+        results.set_forecast(result_df)
 
         # metrics csv report
         if self.spec.generate_metrics:
@@ -507,10 +529,11 @@ class ForecastOperatorBaseModel(ABC):
                 else "Series 1"
             )
             if metrics_df is not None:
+                metrics_df_formatted = metrics_df.reset_index().rename(
+                    {"index": "metrics", "Series 1": metrics_col_name}, axis=1
+                )
                 write_data(
-                    data=metrics_df.reset_index().rename(
-                        {"index": "metrics", "Series 1": metrics_col_name}, axis=1
-                    ),
+                    data=metrics_df_formatted,
                     filename=os.path.join(
                         unique_output_dir, self.spec.metrics_filename
                     ),
@@ -518,6 +541,7 @@ class ForecastOperatorBaseModel(ABC):
                     storage_options=storage_options,
                     index=False,
                 )
+                results.set_metrics(metrics_df_formatted)
             else:
                 logger.warn(
                     f"Attempted to generate the {self.spec.metrics_filename} file with the training metrics, however the training metrics could not be properly generated."
@@ -526,10 +550,11 @@ class ForecastOperatorBaseModel(ABC):
             # test_metrics csv report
             if self.spec.test_data is not None:
                 if test_metrics_df is not None:
+                    test_metrics_df_formatted = test_metrics_df.reset_index().rename(
+                        {"index": "metrics", "Series 1": metrics_col_name}, axis=1
+                    )
                     write_data(
-                        data=test_metrics_df.reset_index().rename(
-                            {"index": "metrics", "Series 1": metrics_col_name}, axis=1
-                        ),
+                        data=test_metrics_df_formatted,
                         filename=os.path.join(
                             unique_output_dir, self.spec.test_metrics_filename
                         ),
@@ -537,6 +562,7 @@ class ForecastOperatorBaseModel(ABC):
                         storage_options=storage_options,
                         index=False,
                     )
+                    results.set_test_metrics(test_metrics_df_formatted)
                 else:
                     logger.warn(
                         f"Attempted to generate the {self.spec.test_metrics_filename} file with the test metrics, however the test metrics could not be properly generated."
@@ -554,6 +580,7 @@ class ForecastOperatorBaseModel(ABC):
                         storage_options=storage_options,
                         index=True,
                     )
+                    results.set_global_explanations(self.formatted_global_explanation)
                 else:
                     logger.warn(
                         f"Attempted to generate global explanations for the {self.spec.global_explanation_filename} file, but an issue occured in formatting the explanations."
@@ -569,6 +596,7 @@ class ForecastOperatorBaseModel(ABC):
                         storage_options=storage_options,
                         index=True,
                     )
+                    results.set_local_explanations(self.formatted_local_explanation)
                 else:
                     logger.warn(
                         f"Attempted to generate local explanations for the {self.spec.local_explanation_filename} file, but an issue occured in formatting the explanations."
@@ -589,10 +617,12 @@ class ForecastOperatorBaseModel(ABC):
                 index=True,
                 indent=4,
             )
+            results.set_model_parameters(self.model_parameters)
 
         # model pickle
         if self.spec.generate_model_pickle:
             self._save_model(unique_output_dir, storage_options)
+            results.set_models(self.models)
 
         logger.info(
             f"The outputs have been successfully "
@@ -612,8 +642,10 @@ class ForecastOperatorBaseModel(ABC):
                 index=True,
                 indent=4,
             )
+            results.set_errors_dict(self.errors_dict)
         else:
             logger.info("All modeling completed successfully.")
+        return results
 
     def preprocess(self, df, series_id):
         """The method that needs to be implemented on the particular model level."""
@@ -667,7 +699,10 @@ class ForecastOperatorBaseModel(ABC):
         )
 
     def _validate_automlx_explanation_mode(self):
-        if self.spec.model != SupportedModels.AutoMLX and self.spec.explanations_accuracy_mode == SpeedAccuracyMode.AUTOMLX:
+        if (
+            self.spec.model != SupportedModels.AutoMLX
+            and self.spec.explanations_accuracy_mode == SpeedAccuracyMode.AUTOMLX
+        ):
             raise ValueError(
                 "AUTOMLX explanation accuracy mode is only supported for AutoMLX models. "
                 "Please select mode other than AUTOMLX from the available explanations_accuracy_mode options"
@@ -738,14 +773,6 @@ class ForecastOperatorBaseModel(ABC):
                     logger.warn(
                         "No explanations generated. Ensure that additional data has been provided."
                     )
-                elif (
-                    self.spec.model == SupportedModels.AutoMLX
-                    and self.spec.explanations_accuracy_mode
-                    == SpeedAccuracyMode.AUTOMLX
-                ):
-                    logger.warning(
-                        "Global explanations not available for AutoMLX models with inherent explainability"
-                    )
                 else:
                     self.global_explanation[s_id] = dict(
                         zip(
@@ -794,7 +821,7 @@ class ForecastOperatorBaseModel(ABC):
     def get_explain_predict_fn(self, series_id, fcst_col_name="yhat"):
         def _custom_predict(
             data,
-            model=self.models[series_id],
+            model=self.models[series_id]["model"],
             dt_column_name=self.datasets._datetime_column_name,
         ):
             """

ads/opctl/operator/lowcode/forecast/model/forecast_datasets.py

@@ -1,8 +1,10 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2023, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2023, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+from typing import Dict, List
+
 import pandas as pd
 
 from ads.opctl import logger
@@ -167,7 +169,7 @@ class ForecastDatasets:
                 self.historical_data.data,
                 self.additional_data.data,
             ],
-            axis=1
+            axis=1,
         )
 
     def get_data_by_series(self, include_horizon=True):
@@ -416,3 +418,59 @@ class ForecastOutput:
         for df in self.series_id_map.values():
             output = pd.concat([output, df])
         return output.reset_index(drop=True)
+
+
+class ForecastResults:
+    """
+    Forecast Results contains all outputs from the forecast run.
+    This class is returned to users who use the Forecast's `operate` method.
+
+    """
+
+    def set_forecast(self, df: pd.DataFrame):
+        self.forecast = df
+
+    def get_forecast(self):
+        return getattr(self, "forecast", None)
+
+    def set_metrics(self, df: pd.DataFrame):
+        self.metrics = df
+
+    def get_metrics(self):
+        return getattr(self, "metrics", None)
+
+    def set_test_metrics(self, df: pd.DataFrame):
+        self.test_metrics = df
+
+    def get_test_metrics(self):
+        return getattr(self, "test_metrics", None)
+
+    def set_local_explanations(self, df: pd.DataFrame):
+        self.local_explanations = df
+
+    def get_local_explanations(self):
+        return getattr(self, "local_explanations", None)
+
+    def set_global_explanations(self, df: pd.DataFrame):
+        self.global_explanations = df
+
+    def get_global_explanations(self):
+        return getattr(self, "global_explanations", None)
+
+    def set_model_parameters(self, df: pd.DataFrame):
+        self.model_parameters = df
+
+    def get_model_parameters(self):
+        return getattr(self, "model_parameters", None)
+
+    def set_models(self, models: List):
+        self.models = models
+
+    def get_models(self):
+        return getattr(self, "models", None)
+
+    def set_errors_dict(self, errors_dict: Dict):
+        self.errors_dict = errors_dict
+
+    def get_errors_dict(self):
+        return getattr(self, "errors_dict", None)

ads/opctl/operator/lowcode/forecast/model/neuralprophet.py

@@ -172,8 +172,10 @@ class NeuralProphetOperatorModel(ForecastOperatorBaseModel):
                 ).values,
             )
 
-            self.models[s_id] = model
             self.trainers[s_id] = model.trainer
+            self.models[s_id] = {}
+            self.models[s_id]["model"] = model
+            self.models[s_id]["le"] = self.le[s_id]
 
             self.model_parameters[s_id] = {
                 "framework": SupportedModels.NeuralProphet,
@@ -355,7 +357,8 @@ class NeuralProphetOperatorModel(ForecastOperatorBaseModel):
 
             sec5_text = rc.Heading("Neural Prophet Model Parameters", level=2)
             model_states = []
-            for s_id, m in self.models.items():
+            for s_id, artifacts in self.models.items():
+                m = artifacts["model"]
                 model_states.append(
                     pd.Series(
                         m.state_dict(),

ads/opctl/operator/lowcode/forecast/model/prophet.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import logging
@@ -43,7 +43,11 @@ def _add_unit(num, unit):
 def _fit_model(data, params, additional_regressors):
     from prophet import Prophet
 
+    monthly_seasonality = params.pop("monthly_seasonality", False)
     model = Prophet(**params)
+    if monthly_seasonality:
+        model.add_seasonality(name="monthly", period=30.5, fourier_order=5)
+        params["monthly_seasonality"] = monthly_seasonality
     for add_reg in additional_regressors:
         model.add_regressor(add_reg)
     model.fit(data)
@@ -108,7 +112,10 @@ class ProphetOperatorModel(ForecastOperatorBaseModel):
                 upper_bound=self.get_horizon(forecast["yhat_upper"]).values,
                 lower_bound=self.get_horizon(forecast["yhat_lower"]).values,
             )
-            self.models[series_id] = model
+
+            self.models[series_id] = {}
+            self.models[series_id]["model"] = model
+            self.models[series_id]["le"] = self.le[series_id]
 
             params = vars(model).copy()
             for param in ["history", "history_dates", "stan_fit"]:
@@ -252,11 +259,11 @@ class ProphetOperatorModel(ForecastOperatorBaseModel):
         all_sections = []
         if len(series_ids) > 0:
             sec1 = _select_plot_list(
-                lambda s_id: self.models[s_id].plot(
+                lambda s_id: self.models[s_id]["model"].plot(
                     self.outputs[s_id], include_legend=True
                 ),
                 series_ids=series_ids,
-                target_category_column=self.target_cat_col
+                target_category_column=self.target_cat_col,
             )
             section_1 = rc.Block(
                 rc.Heading("Forecast Overview", level=2),
@@ -267,25 +274,25 @@ class ProphetOperatorModel(ForecastOperatorBaseModel):
             )
 
             sec2 = _select_plot_list(
-                lambda s_id: self.models[s_id].plot_components(self.outputs[s_id]),
+                lambda s_id: self.models[s_id]["model"].plot_components(self.outputs[s_id]),
                 series_ids=series_ids,
-                target_category_column=self.target_cat_col
+                target_category_column=self.target_cat_col,
             )
             section_2 = rc.Block(
                 rc.Heading("Forecast Broken Down by Trend Component", level=2), sec2
             )
 
             sec3_figs = {
-                s_id: self.models[s_id].plot(self.outputs[s_id]) for s_id in series_ids
+                s_id: self.models[s_id]["model"].plot(self.outputs[s_id]) for s_id in series_ids
             }
             for s_id in series_ids:
                 add_changepoints_to_plot(
-                    sec3_figs[s_id].gca(), self.models[s_id], self.outputs[s_id]
+                    sec3_figs[s_id].gca(), self.models[s_id]["model"], self.outputs[s_id]
                 )
             sec3 = _select_plot_list(
                 lambda s_id: sec3_figs[s_id],
                 series_ids=series_ids,
-                target_category_column=self.target_cat_col
+                target_category_column=self.target_cat_col,
             )
             section_3 = rc.Block(rc.Heading("Forecast Changepoints", level=2), sec3)
 
@@ -294,12 +301,14 @@ class ProphetOperatorModel(ForecastOperatorBaseModel):
             sec5_text = rc.Heading("Prophet Model Seasonality Components", level=2)
             model_states = []
             for s_id in series_ids:
-                m = self.models[s_id]
+                m = self.models[s_id]["model"]
                 model_states.append(
                     pd.Series(
                         m.seasonalities,
                         index=pd.Index(m.seasonalities.keys(), dtype="object"),
-                        name=s_id if self.target_cat_col else self.original_target_column,
+                        name=s_id
+                        if self.target_cat_col
+                        else self.original_target_column,
                         dtype="object",
                     )
                 )
@@ -330,11 +339,15 @@ class ProphetOperatorModel(ForecastOperatorBaseModel):
                 self.formatted_local_explanation = aggregate_local_explanations
 
                 if not self.target_cat_col:
-                    self.formatted_global_explanation = self.formatted_global_explanation.rename(
-                        {"Series 1": self.original_target_column},
-                        axis=1,
+                    self.formatted_global_explanation = (
+                        self.formatted_global_explanation.rename(
+                            {"Series 1": self.original_target_column},
+                            axis=1,
+                        )
+                    )
+                    self.formatted_local_explanation.drop(
+                        "Series", axis=1, inplace=True
                     )
-                    self.formatted_local_explanation.drop("Series", axis=1, inplace=True)
 
                 # Create a markdown section for the global explainability
                 global_explanation_section = rc.Block(

ads/opctl/operator/lowcode/forecast/whatifserve/score.py

@@ -151,34 +151,42 @@ def get_forecast(future_df, model_name, series_id, model_object, date_col, targe
         pred_obj = model_object.predict(future_regressor=future_reg)
         return pred_obj.forecast[series_id].tolist()
     elif model_name == SupportedModels.Prophet and series_id in model_object:
-        model = model_object[series_id]
+        model = model_object[series_id]['model']
+        label_encoder = model_object[series_id]['le']
         processed = future_df.rename(columns={date_col_name: 'ds', target_column: 'y'})
-        forecast = model.predict(processed)
+        encoded_df = label_encoder.transform(processed)
+        forecast = model.predict(encoded_df)
         return forecast['yhat'].tolist()
     elif model_name == SupportedModels.NeuralProphet and series_id in model_object:
-        model = model_object[series_id]
+        model = model_object[series_id]['model']
+        label_encoder = model_object[series_id]['le']
         model.restore_trainer()
         accepted_regressors = list(model.config_regressors.regressors.keys())
         data = future_df.rename(columns={date_col_name: 'ds', target_column: 'y'})
-        future = data[accepted_regressors + ["ds"]].reset_index(drop=True)
+        encoded_df = label_encoder.transform(data)
+        future = encoded_df[accepted_regressors + ["ds"]].reset_index(drop=True)
         future["y"] = None
         forecast = model.predict(future)
         return forecast['yhat1'].tolist()
     elif model_name == SupportedModels.Arima and series_id in model_object:
-        model = model_object[series_id]
-        future_df = future_df.set_index(date_col_name)
-        x_pred = future_df.drop(target_cat_col, axis=1)
+        model = model_object[series_id]['model']
+        label_encoder = model_object[series_id]['le']
+        predict_cols = model_object[series_id]["predict_component_cols"]
+        encoded_df = label_encoder.transform(future_df)
+        x_pred = encoded_df.set_index(date_col_name)
+        x_pred = x_pred.drop(target_cat_col, axis=1)
         yhat, conf_int = model.predict(
             n_periods=horizon,
-            X=x_pred,
+            X=x_pred[predict_cols],
             return_conf_int=True
         )
         yhat_clean = pd.DataFrame(yhat, index=yhat.index, columns=["yhat"])
         return yhat_clean['yhat'].tolist()
     elif model_name == SupportedModels.AutoMLX and series_id in model_object:
-        # automlx model
-        model = model_object[series_id]
-        x_pred = future_df.drop(target_cat_col, axis=1)
+        model = model_object[series_id]['model']
+        label_encoder = model_object[series_id]['le']
+        encoded_df = label_encoder.transform(future_df)
+        x_pred = encoded_df.drop(target_cat_col, axis=1)
         x_pred = x_pred.set_index(date_col_name)
         forecast = model.forecast(
             X=x_pred,

{oracle_ads-2.13.0.dist-info → oracle_ads-2.13.1rc0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: oracle_ads
-Version: 2.13.0
+Version: 2.13.1rc0
 Summary: Oracle Accelerated Data Science SDK
 Keywords: Oracle Cloud Infrastructure,OCI,Machine Learning,ML,Artificial Intelligence,AI,Data Science,Cloud,Oracle
 Author: Oracle Data Science
@@ -39,7 +39,7 @@ Requires-Dist: httpx
 Requires-Dist: oracle_ads[opctl] ; extra == "anomaly"
 Requires-Dist: autots ; extra == "anomaly"
 Requires-Dist: oracledb ; extra == "anomaly"
-Requires-Dist: report-creator==1.0.32 ; extra == "anomaly"
+Requires-Dist: report-creator==1.0.37 ; extra == "anomaly"
 Requires-Dist: rrcf==0.4.4 ; extra == "anomaly"
 Requires-Dist: scikit-learn<1.6.0 ; extra == "anomaly"
 Requires-Dist: salesforce-merlion[all]==2.0.4 ; extra == "anomaly"
@@ -78,7 +78,7 @@ Requires-Dist: sktime ; extra == "forecast"
 Requires-Dist: statsmodels ; extra == "forecast"
 Requires-Dist: plotly ; extra == "forecast"
 Requires-Dist: oracledb ; extra == "forecast"
-Requires-Dist: report-creator==1.0.32 ; extra == "forecast"
+Requires-Dist: report-creator==1.0.37 ; extra == "forecast"
 Requires-Dist: geopandas<1.0.0 ; extra == "geo"
 Requires-Dist: fiona<=1.9.6 ; extra == "geo"
 Requires-Dist: oracle_ads[viz] ; extra == "geo"
@@ -122,11 +122,11 @@ Requires-Dist: scrubadub==2.0.1 ; extra == "pii"
 Requires-Dist: scrubadub_spacy ; extra == "pii"
 Requires-Dist: spacy-transformers==1.2.5 ; extra == "pii"
 Requires-Dist: spacy==3.6.1 ; extra == "pii"
-Requires-Dist: report-creator==1.0.32 ; extra == "pii"
+Requires-Dist: report-creator>=1.0.32 ; extra == "pii"
 Requires-Dist: oracle_ads[opctl] ; extra == "recommender"
 Requires-Dist: scikit-surprise ; extra == "recommender"
 Requires-Dist: plotly ; extra == "recommender"
-Requires-Dist: report-creator==1.0.32 ; extra == "recommender"
+Requires-Dist: report-creator==1.0.37 ; extra == "recommender"
 Requires-Dist: pyspark>=3.0.0 ; extra == "spark"
 Requires-Dist: oracle_ads[viz] ; extra == "tensorflow"
 Requires-Dist: tensorflow<=2.15.1 ; extra == "tensorflow"

{oracle_ads-2.13.0.dist-info → oracle_ads-2.13.1rc0.dist-info}/RECORD

@@ -564,9 +564,11 @@ ads/model/transformer/onnx_transformer.py,sha256=2aiG_-OaDaM0JJhM4w2vblZyI6q-1GB
 ads/mysqldb/__init__.py,sha256=yBa9sP_49XF0GDWWG-u1Q5ry-vXfmO61oUjNp7mdN74,204
 ads/mysqldb/mysql_db.py,sha256=nG9vRO_BItFB2z6hTptodMCMB-2fiuNVCrgTdVoSrjY,7828
 ads/opctl/__init__.py,sha256=uPSJLEAIl2RMMz5zWhhTYYEeWejfcMQTOK2qQFVVaPM,435
+ads/opctl/anomaly_detection.py,sha256=9D2U7K_5W9O__AjKNnJoEk-cbYjp8G6w5905-i004mU,414
 ads/opctl/cli.py,sha256=5R7CLyk7UDODhvlVMj2i8i7_gFzYU2GsIs5kUbLQK68,20408
 ads/opctl/cmds.py,sha256=Z22y1yW82RY-BV1c7ooE5HtFdzILypgSOE2FKzswBUo,29135
 ads/opctl/constants.py,sha256=F-JcVhdidIwPweGmq2auHjvSfXpfkUljngIZXVb_1mQ,2183
+ads/opctl/forecast.py,sha256=ZInj8FyXHkdjiEmXDc-jH1xT7JAGHEKwP0Lnq39xWGQ,418
 ads/opctl/index.yaml,sha256=cf9j3VXcNY-DvFlAZQLZj8-hA9QArWlirPtN1sRKqyM,68
 ads/opctl/schema.yaml.yml,sha256=L4eoHVFLu5tHPDOD53-dVGbscKkXG86i4IbRX-bVL2g,546
 ads/opctl/script.py,sha256=3AgTOjDnvmheu4ROrn56d38h8wZVOZwne_ix2x3U6bY,1181
@@ -702,7 +704,7 @@ ads/opctl/operator/lowcode/feature_store_marketplace/models/serializable_yaml_mo
 ads/opctl/operator/lowcode/forecast/MLoperator,sha256=xM8yBUQObjG_6Mg36f3Vv8b9N3L8_5RUZJE2riOjXuw,5981
 ads/opctl/operator/lowcode/forecast/README.md,sha256=kbCCEdo-0pwKlZp9ctnWUK6Z31n69IsnG0i26b202Zg,9768
 ads/opctl/operator/lowcode/forecast/__init__.py,sha256=sAqmLhogrLXb3xI7dPOj9HmSkpTnLh9wkzysuGd8AXk,204
-ads/opctl/operator/lowcode/forecast/__main__.py,sha256=2NmZ4Z-Hu9ViuH6LOQ27ciVN7uryho9Fxs3adfWQkbk,2894
+ads/opctl/operator/lowcode/forecast/__main__.py,sha256=FTQhYCZEAbQO2sCOpepermKimSktFd9pERNu1rC-K3A,2926
 ads/opctl/operator/lowcode/forecast/cmd.py,sha256=uwU-QvnYwxoRFXZv7_JFkzAUnjTNoSsHEme2FF-9Rl0,1151
 ads/opctl/operator/lowcode/forecast/const.py,sha256=HJQFM35t-pG4g6z63YABx2ehuKfo9yBHklVbZrGpVzY,2615
 ads/opctl/operator/lowcode/forecast/environment.yaml,sha256=eVMf9pcjADI14_GRGdZOB_gK5_MyG_-cX037TXqzFho,330
@@ -712,18 +714,18 @@ ads/opctl/operator/lowcode/forecast/operator_config.py,sha256=fcq0WrqW4AYkcW6d_L
 ads/opctl/operator/lowcode/forecast/schema.yaml,sha256=nDrY-8Qyv-_6Olxi4CoUgyQe65h7I9CPYghtSVGIxVE,12437
 ads/opctl/operator/lowcode/forecast/utils.py,sha256=0ssrXBAEL5hjQX4avLPkSwFp3sKE8QV5M3K5InqvzYg,14137
 ads/opctl/operator/lowcode/forecast/model/__init__.py,sha256=sAqmLhogrLXb3xI7dPOj9HmSkpTnLh9wkzysuGd8AXk,204
-ads/opctl/operator/lowcode/forecast/model/arima.py,sha256=sWGTUxisV8ytUA-_MK54bdP2FVO_9BMD8-EsulJEYxE,11430
-ads/opctl/operator/lowcode/forecast/model/automlx.py,sha256=lXJoeMFHapyd5aYLi81T4WOV4ilheVz0FrNW6yE2dg4,19362
+ads/opctl/operator/lowcode/forecast/model/arima.py,sha256=5e0LI-rwya1aovnOlll9ZHt2qYy8Jr--OA8w_cuCdD0,11617
+ads/opctl/operator/lowcode/forecast/model/automlx.py,sha256=xQWgy2XjyXUlYzmETcomYC28xOE3xvn0q2AuGQEJHD4,19965
 ads/opctl/operator/lowcode/forecast/model/autots.py,sha256=RyLeD3dwMfrb6St-QFoH2MM8vH3inepVamRRovI-bwM,13086
-ads/opctl/operator/lowcode/forecast/model/base_model.py,sha256=h0PGYUKfO2CSH34EK3YtYnZHnpiRJThvIkwyIiKqxDI,33531
+ads/opctl/operator/lowcode/forecast/model/base_model.py,sha256=LWU_W394J3yhjAbl98iRF9cTqWJ1Orp4l9x32KVjNQg,34510
 ads/opctl/operator/lowcode/forecast/model/factory.py,sha256=hSRPPWdpIRSMYPUFMIUuxc2TPZt-SG18MiqhtdfL3mg,3488
-ads/opctl/operator/lowcode/forecast/model/forecast_datasets.py,sha256=BFZL-F2pec5Gb5UTRcFlNPi3LT65z4pGzRJvhgxK0TE,16562
+ads/opctl/operator/lowcode/forecast/model/forecast_datasets.py,sha256=K22itixKOcWMrMGL8CqfhnQZ18lnWUpFuuYvy7OKbcU,18120
 ads/opctl/operator/lowcode/forecast/model/ml_forecast.py,sha256=NSZ2L6gRw4S68BUF0Vyu-cUPSsq8LRxgoVajW9Ra63k,9640
-ads/opctl/operator/lowcode/forecast/model/neuralprophet.py,sha256=URtnP4oEMP7tGwe0WfWtfMFftAXQzN3K9RurAv_cgnY,19251
-ads/opctl/operator/lowcode/forecast/model/prophet.py,sha256=yiCIP0bR0jg-b2XHVJSfO7CFZ3_GXEnpLkW_MkV45Jo,14983
+ads/opctl/operator/lowcode/forecast/model/neuralprophet.py,sha256=Vu3z97CYAAEaumg-4W5PdgC21izd7aFxWBdWzBJSs4U,19394
+ads/opctl/operator/lowcode/forecast/model/prophet.py,sha256=slbpvD0Zz1zrRttxouL_cERjIP_SMxtnUMZ1_kVwu6g,15534
 ads/opctl/operator/lowcode/forecast/whatifserve/__init__.py,sha256=JNDDjLrNorKXMHUuXMifqXea3eheST-lnrcwCl2bWrk,242
 ads/opctl/operator/lowcode/forecast/whatifserve/deployment_manager.py,sha256=fTu5h18dyNi61wX4u0bcevBVd5QCx2avpW4g1Ry-xwM,11168
-ads/opctl/operator/lowcode/forecast/whatifserve/score.py,sha256=KpWx7fGFGPb5VUKIoMpEDbUs6q9j3hT-Zax7rsbfYuw,8172
+ads/opctl/operator/lowcode/forecast/whatifserve/score.py,sha256=JjEDtrqUfL4x9t-vvafXMLNwY9-vgc6QPX_Ee-wmI58,8709
 ads/opctl/operator/lowcode/pii/MLoperator,sha256=GKCuiXRwfGLyBqELbtgtg-kJPtNWNVA-kSprYTqhF64,6406
 ads/opctl/operator/lowcode/pii/README.md,sha256=2P3tpKv6v__Eehj6iLfTXgyDhS4lmi1BTfEdmJhT0K4,9237
 ads/opctl/operator/lowcode/pii/__init__.py,sha256=sAqmLhogrLXb3xI7dPOj9HmSkpTnLh9wkzysuGd8AXk,204
@@ -843,8 +845,8 @@ ads/type_discovery/unknown_detector.py,sha256=yZuYQReO7PUyoWZE7onhhtYaOg6088wf1y
 ads/type_discovery/zipcode_detector.py,sha256=3AlETg_ZF4FT0u914WXvTT3F3Z6Vf51WiIt34yQMRbw,1421
 ads/vault/__init__.py,sha256=x9tMdDAOdF5iDHk9u2di_K-ze5Nq068x25EWOBoWwqY,245
 ads/vault/vault.py,sha256=hFBkpYE-Hfmzu1L0sQwUfYcGxpWmgG18JPndRl0NOXI,8624
-oracle_ads-2.13.0.dist-info/entry_points.txt,sha256=9VFnjpQCsMORA4rVkvN8eH6D3uHjtegb9T911t8cqV0,35
-oracle_ads-2.13.0.dist-info/LICENSE.txt,sha256=zoGmbfD1IdRKx834U0IzfFFFo5KoFK71TND3K9xqYqo,1845
-oracle_ads-2.13.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-oracle_ads-2.13.0.dist-info/METADATA,sha256=ZKRWF3LwXQmV0JIdEXnkKVz8GzFRACsNzXmSbRyJMFU,16279
-oracle_ads-2.13.0.dist-info/RECORD,,
+oracle_ads-2.13.1rc0.dist-info/entry_points.txt,sha256=9VFnjpQCsMORA4rVkvN8eH6D3uHjtegb9T911t8cqV0,35
+oracle_ads-2.13.1rc0.dist-info/LICENSE.txt,sha256=zoGmbfD1IdRKx834U0IzfFFFo5KoFK71TND3K9xqYqo,1845
+oracle_ads-2.13.1rc0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+oracle_ads-2.13.1rc0.dist-info/METADATA,sha256=Bp8bLw33VEHDWbLQHmE3RF91Kig2XcIEgwVJ8D5uiY8,16282
+oracle_ads-2.13.1rc0.dist-info/RECORD,,