oracle-ads 2.13.9rc0__py3-none-any.whl → 2.13.10rc0__py3-none-any.whl

ads/opctl/operator/lowcode/forecast/README.md

@@ -0,0 +1,209 @@
+# Forecasting Operator
+
+The Forecasting Operator leverages historical time series data to generate accurate forecasts for future trends. This operator aims to simplify and expedite the data science process by automating the selection of appropriate models and hyperparameters, as well as identifying relevant features for a given prediction task.
+
+Below are the steps to configure and run the Forecasting Operator on different resources.
+
+## 1. Prerequisites
+
+Follow the [CLI Configuration](https://accelerated-data-science.readthedocs.io/en/latest/user_guide/cli/opctl/configure.html) steps from the ADS documentation. This step is mandatory as it sets up default values for different options while running the Forecasting Operator on OCI Data Science Jobs.
+
+## 2. Generating configs
+
+To generate starter configs, run the command below. This will create a list of YAML configs and place them in the `output` folder.
+
+```bash
+ads operator init -t forecast --overwrite --output ~/forecast/
+```
+
+The most important files expected to be generated are:
+
+- `forecast.yaml`: Contains forecast-related configuration.
+- `forecast_operator_local_python_backend.yaml`: This includes a local backend configuration for running forecasting in a local environment. The environment should be set up manually before running the operator.
+- `forecast_operator_local_container_backend.yaml`: This includes a local backend configuration for running forecasting within a local container. The container should be built before running the operator. Please refer to the instructions below for details on how to accomplish this.
+- `forecast_job_container_backend.yaml`: Contains Data Science job-related config to run forecasting in a Data Science job within a container (BYOC) runtime. The container should be built and published before running the operator. Please refer to the instructions below for details on how to accomplish this.
+- `forecast_job_python_backend.yaml`: Contains Data Science job-related config to run forecasting in a Data Science job within a conda runtime. The conda should be built and published before running the operator.
+
+All generated configurations should be ready to use without the need for any additional adjustments. However, they are provided as starter kit configurations that can be customized as needed.
+
+## 3. Running forecasting on the local conda environment
+
+To run forecasting locally, create and activate a new conda environment (`ads-forecasting`). Install all the required libraries listed in the `environment.yaml` file.
+
+```yaml
+- prophet
+- neuralprophet
+- pmdarima
+- statsmodels
+- report-creator
+- cerberus
+- sktime
+- optuna
+- oracle-ads>=2.9.0
+```
+
+Please review the previously generated `forecast.yaml` file using the `init` command, and make any necessary adjustments to the input and output file locations. By default, it assumes that the files should be located in the same folder from which the `init` command was executed.
+
+Use the command below to verify the forecasting config.
+
+```bash
+ads operator verify -f ~/forecast/forecast.yaml
+```
+
+Use the following command to run the forecasting within the `ads-forecasting` conda environment.
+
+```bash
+  ads operator run -f ~/forecast/forecast.yaml -b local
+```
+
+The operator will run in your local environment without requiring any additional modifications.
+
+## 4. Running forecasting on the local container
+
+To run the forecasting operator within a local container, follow these steps:
+
+Use the command below to build the forecast container.
+
+```bash
+ads operator build-image -t forecast
+```
+
+This will create a new `forecast:v1` image, with `/etc/operator` as the designated working directory within the container.
+
+
+Check the `backend_operator_local_container_config.yaml` config file. By default, it should have a `volume` section with the `.oci` configs folder mounted.
+
+```yaml
+volume:
+  - "/Users/<user>/.oci:/root/.oci"
+```
+
+Mounting the OCI configs folder is only required if an OCI Object Storage bucket will be used to store the input forecasting data or output forecasting result. The input/output folders can also be mounted to the container.
+
+```yaml
+volume:
+  - /Users/<user>/.oci:/root/.oci
+  - /Users/<user>/forecast/data:/etc/operator/data
+  - /Users/<user>/forecast/result:/etc/operator/result
+```
+
+The full config can look like:
+```yaml
+kind: operator.local
+spec:
+  image: forecast:v1
+  volume:
+  - /Users/<user>/.oci:/root/.oci
+  - /Users/<user>/forecast/data:/etc/operator/data
+  - /Users/<user>/forecast/result:/etc/operator/result
+type: container
+version: v1
+```
+
+Run the forecasting within a container using the command below:
+
+```bash
+    ads operator run -f ~/forecast/forecast.yaml --backend-config ~/forecast/backend_operator_local_container_config.yaml
+```
+
+## 5. Running forecasting in the Data Science job within container runtime
+
+To execute the forecasting operator within a Data Science job using container runtime, please follow the steps outlined below:
+
+You can use the following command to build the forecast container. This step can be skipped if you have already done this for running the operator within a local container.
+
+```bash
+ads operator build-image -t forecast
+```
+
+This will create a new `forecast:v1` image, with `/etc/operator` as the designated working directory within the container.
+
+Publish the `forecast:v1` container to the [Oracle Container Registry](https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/Registry/home.htm). To become familiar with OCI, read the documentation links posted below.
+
+- [Access Container Registry](https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/Registry/Concepts/registryoverview.htm#access)
+- [Create repositories](https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/Registry/Tasks/registrycreatingarepository.htm#top)
+- [Push images](https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/Registry/Tasks/registrypushingimagesusingthedockercli.htm#Pushing_Images_Using_the_Docker_CLI)
+
+To publish `forecast:v1` to OCR, use the command posted below:
+
+```bash
+ads operator publish-image forecast:v1 --registry <iad.ocir.io/tenancy/>
+```
+
+After the container is published to OCR, it can be used within Data Science jobs service. Check the `backend_job_container_config.yaml` config file. It should contain pre-populated infrastructure and runtime sections. The runtime section should contain an image property, something like `image: iad.ocir.io/<tenancy>/forecast:v1`. More details about supported options can be found in the ADS Jobs documentation - [Run a Container](https://accelerated-data-science.readthedocs.io/en/latest/user_guide/jobs/run_container.html).
+
+Adjust the `forecast.yaml` config with proper input/output folders. When the forecasting is run in the Data Science job, it will not have access to local folders. Therefore, input data and output folders should be placed in the Object Storage bucket. Open the `forecast.yaml` and adjust the following fields:
+
+```yaml
+historical_data:
+  url: oci://bucket@namespace/forecast/input_data/data.csv
+output_directory:
+  url: oci://bucket@namespace/forecast/result/
+test_data:
+  url: oci://bucket@namespace/forecast/input_data/test.csv
+```
+
+Run the forecasting on the Data Science jobs using the command posted below:
+
+```bash
+ads operator run -f ~/forecast/forecast.yaml --backend-config ~/forecast/backend_job_container_config.yaml
+```
+
+The logs can be monitored using the `ads opctl watch` command.
+
+```bash
+ads opctl watch <OCID>
+```
+
+## 6. Running forecasting in the Data Science job within conda runtime
+
+To execute the forecasting operator within a Data Science job using conda runtime, please follow the steps outlined below:
+
+You can use the following command to build the forecast conda environment.
+
+```bash
+ads operator build-conda -t forecast
+```
+
+This will create a new `forecast_v1` conda environment and place it in the folder specified within `ads opctl configure` command.
+
+Use the command below to Publish the `forecast_v1` conda environment to the Object Storage bucket.
+
+```bash
+ads opctl conda publish forecast_v1
+```
+More details about configuring CLI can be found here - [Configuring CLI](https://accelerated-data-science.readthedocs.io/en/latest/user_guide/cli/opctl/configure.html)
+
+
+After the conda environment is published to Object Storage, it can be used within Data Science jobs service. Check the `backend_job_python_config.yaml` config file. It should contain pre-populated infrastructure and runtime sections. The runtime section should contain a `conda` section.
+
+```yaml
+conda:
+  type: published
+  uri: oci://bucket@namespace/conda_environments/cpu/forecast/1/forecast_v1
+```
+
+More details about supported options can be found in the ADS Jobs documentation - [Run a Python Workload](https://accelerated-data-science.readthedocs.io/en/latest/user_guide/jobs/run_python.html).
+
+Adjust the `forecast.yaml` config with proper input/output folders. When the forecasting is run in the Data Science job, it will not have access to local folders. Therefore, input data and output folders should be placed in the Object Storage bucket. Open the `forecast.yaml` and adjust the following fields:
+
+```yaml
+historical_data:
+  url: oci://bucket@namespace/forecast/input_data/data.csv
+output_directory:
+  url: oci://bucket@namespace/forecast/result/
+test_data:
+  url: oci://bucket@namespace/forecast/input_data/test.csv
+```
+
+Run the forecasting on the Data Science jobs using the command posted below:
+
+```bash
+ads operator run -f ~/forecast/forecast.yaml --backend-config ~/forecast/backend_job_python_config.yaml
+```
+
+The logs can be monitored using the `ads opctl watch` command.
+
+```bash
+ads opctl watch <OCID>
+```

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

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

@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+
+# 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
+import os
+import sys
+from typing import Dict, List
+
+import yaml
+
+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 .whatifserve import ModelDeploymentManager
+
+
+def operate(operator_config: ForecastOperatorConfig) -> ForecastResults:
+    """Runs the forecasting operator."""
+    from .model.factory import ForecastOperatorModelFactory
+
+    datasets = ForecastDatasets(operator_config)
+    results = ForecastOperatorModelFactory.get_model(
+        operator_config, datasets
+    ).generate_report()
+    # saving to model catalog
+    spec = operator_config.spec
+    if spec.what_if_analysis and datasets.additional_data:
+        mdm = ModelDeploymentManager(spec, datasets.additional_data)
+        mdm.save_to_catalog()
+        if spec.what_if_analysis.model_deployment:
+            mdm.create_deployment()
+        mdm.save_deployment_info()
+    return results
+
+
+def verify(spec: Dict, **kwargs: Dict) -> bool:
+    """Verifies the forecasting operator config."""
+    operator = ForecastOperatorConfig.from_dict(spec)
+    msg_header = (
+        f"{'*' * 30} The operator config has been successfully verified {'*' * 30}"
+    )
+    print(msg_header)
+    print(operator.to_yaml())
+    print("*" * len(msg_header))
+
+
+def main(raw_args: List[str]):
+    """The entry point of the forecasting the operator."""
+    args, _ = _parse_input_args(raw_args)
+    if not args.file and not args.spec and not os.environ.get(ENV_OPERATOR_ARGS):
+        logger.info(
+            "Please specify -f[--file] or -s[--spec] or "
+            f"pass operator's arguments via {ENV_OPERATOR_ARGS} environment variable."
+        )
+        return
+
+    logger.info("-" * 100)
+    logger.info(f"{'Running' if not args.verify else 'Verifying'} the operator...")
+
+    # if spec provided as input string, then convert the string into YAML
+    yaml_string = ""
+    if args.spec or os.environ.get(ENV_OPERATOR_ARGS):
+        operator_spec_str = args.spec or os.environ.get(ENV_OPERATOR_ARGS)
+        try:
+            yaml_string = yaml.safe_dump(json.loads(operator_spec_str))
+        except json.JSONDecodeError:
+            yaml_string = yaml.safe_dump(yaml.safe_load(operator_spec_str))
+        except:
+            yaml_string = operator_spec_str
+
+    operator_config = ForecastOperatorConfig.from_yaml(
+        uri=args.file,
+        yaml_string=yaml_string,
+    )
+
+    # run operator
+    if args.verify:
+        verify(operator_config)
+    else:
+        operate(operator_config)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

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

@@ -0,0 +1,40 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2023, 2024 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
+
+from ads.opctl.operator.common.operator_yaml_generator import YamlGenerator
+from ads.opctl.operator.common.utils import _load_yaml_from_uri
+
+
+def init(**kwargs: Dict) -> str:
+    """
+    Generates operator config by the schema.
+
+    Properties
+    ----------
+    kwargs: (Dict, optional).
+        Additional key value arguments.
+
+        - type: str
+            The type of the operator.
+
+    Returns
+    -------
+    str
+        The YAML specification generated based on the schema.
+    """
+    # logger.info("==== Forecasting related options ====")
+
+    # model_type = click.prompt(
+    #     "Provide a model type:",
+    #     type=click.Choice(SupportedModels.values()),
+    #     default=SupportedModels.Auto,
+    # )
+    model_type = "prophet"
+
+    return YamlGenerator(
+        schema=_load_yaml_from_uri(__file__.replace("cmd.py", "schema.yaml"))
+    ).generate_example_dict(values={"model": model_type, "type": kwargs.get("type")})

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

@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+
+# 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 ads.common.extended_enum import ExtendedEnum
+from ads.opctl.operator.lowcode.common.const import DataColumns
+
+
+class SupportedModels(ExtendedEnum):
+    """Supported forecast models."""
+
+    Prophet = "prophet"
+    Arima = "arima"
+    NeuralProphet = "neuralprophet"
+    LGBForecast = "lgbforecast"
+    AutoMLX = "automlx"
+    AutoTS = "autots"
+    # Auto = "auto"
+
+
+class SpeedAccuracyMode(ExtendedEnum):
+    """
+    Enum representing different modes based on time taken and accuracy for explainability.
+    """
+
+    HIGH_ACCURACY = "HIGH_ACCURACY"
+    BALANCED = "BALANCED"
+    FAST_APPROXIMATE = "FAST_APPROXIMATE"
+    AUTOMLX = "AUTOMLX"
+    ratio = {}
+    ratio[HIGH_ACCURACY] = 1  # 100 % data used for generating explanations
+    ratio[BALANCED] = 0.5  # 50 % data used for generating explanations
+    ratio[FAST_APPROXIMATE] = 0  # constant
+    ratio[AUTOMLX] = 0  # constant
+
+
+class SupportedMetrics(ExtendedEnum):
+    """Supported forecast metrics."""
+
+    MAPE = "MAPE"
+    RMSE = "RMSE"
+    MSE = "MSE"
+    SMAPE = "sMAPE"
+    WMAPE = "wMAPE"
+    R2 = "r2"
+    EXPLAINED_VARIANCE = "Explained Variance"
+    MEAN_MAPE = "Mean MAPE"
+    MEAN_RMSE = "Mean RMSE"
+    MEAN_MSE = "Mean MSE"
+    MEAN_SMAPE = "Mean sMAPE"
+    MEAN_WMAPE = "Mean wMAPE"
+    MEAN_R2 = "Mean r2"
+    MEAN_EXPLAINED_VARIANCE = "Mean Explained Variance"
+    MEDIAN_MAPE = "Median MAPE"
+    MEDIAN_RMSE = "Median RMSE"
+    MEDIAN_MSE = "Median MSE"
+    MEDIAN_SMAPE = "Median sMAPE"
+    MEDIAN_WMAPE = "Median wMAPE"
+    MEDIAN_R2 = "Median r2"
+    MEDIAN_EXPLAINED_VARIANCE = "Median Explained Variance"
+    ELAPSED_TIME = "Elapsed Time"
+
+
+class ForecastOutputColumns(ExtendedEnum):
+    """The column names for the forecast.csv output file"""
+
+    DATE = "Date"
+    SERIES = DataColumns.Series
+    INPUT_VALUE = "input_value"
+    FITTED_VALUE = "fitted_value"
+    FORECAST_VALUE = "forecast_value"
+    UPPER_BOUND = "upper_bound"
+    LOWER_BOUND = "lower_bound"
+
+
+AUTOMLX_METRIC_MAP = {
+    "smape": "neg_sym_mean_abs_percent_error",
+    "mape": "neg_sym_mean_abs_percent_error",
+    "mase": "neg_mean_abs_scaled_error",
+    "mae": "neg_mean_absolute_error",
+    "mse": "neg_mean_squared_error",
+    "rmse": "neg_root_mean_squared_error",
+}
+
+MAX_COLUMNS_AUTOMLX = 15
+DEFAULT_TRIALS = 10
+SUMMARY_METRICS_HORIZON_LIMIT = 10
+PROPHET_INTERNAL_DATE_COL = "ds"
+RENDER_LIMIT = 5000
+AUTO_SELECT = "auto-select"
+BACKTEST_REPORT_NAME = "back_test.csv"

ads/opctl/operator/lowcode/forecast/environment.yaml

@@ -0,0 +1,20 @@
+name: Forecast
+channels:
+  - conda-forge
+dependencies:
+  - python=3.8
+  - pip
+  - pip:
+      - oracle-ads>=2.9.0
+      - prophet
+      - neuralprophet
+      - mlforecast
+      - pmdarima
+      - statsmodels
+      - report-creator
+      - cerberus
+      - sktime
+      - shap
+      - autots[additional]
+      - optuna
+      - fire

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

@@ -0,0 +1,26 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+class ForecastSchemaYamlError(Exception):
+    """Exception raised when there is an issue with the schema."""
+
+    def __init__(self, error: str):
+        super().__init__(
+            "Invalid forecast operator specification. Check the YAML structure and ensure it "
+            "complies with the required schema for forecast operator. \n"
+            f"{error}"
+        )
+
+
+class ForecastInputDataError(Exception):
+    """Exception raised when there is an issue with input data."""
+
+    def __init__(self, error: str):
+        super().__init__(
+            "Invalid input data. Check the input data and ensure it "
+            "complies with the validation criteria. \n"
+            f"{error}"
+        )

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/