oracle-ads 2.11.9__tar.gz → 2.11.11__tar.gz

{oracle_ads-2.11.9 → oracle_ads-2.11.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oracle_ads
-Version: 2.11.9
+Version: 2.11.11
 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
@@ -20,7 +20,7 @@ Requires-Dist: cloudpickle>=1.6.0
 Requires-Dist: fsspec>=0.8.7
 Requires-Dist: gitpython>=3.1.2
 Requires-Dist: jinja2>=2.11.2
-Requires-Dist: matplotlib>=3.1.3
+Requires-Dist: matplotlib>=3.1.3, <=3.8.4
 Requires-Dist: numpy>=1.19.2
 Requires-Dist: oci>=2.125.3
 Requires-Dist: ocifs>=1.1.3
@@ -34,10 +34,8 @@ Requires-Dist: tabulate>=0.8.9
 Requires-Dist: tqdm>=4.59.0
 Requires-Dist: oracle_ads[opctl] ; extra == "anomaly"
 Requires-Dist: autots ; extra == "anomaly"
-Requires-Dist: oracle-automlx[forecasting]==23.4.1 ; extra == "anomaly"
-Requires-Dist: oracle-automlx[classic]==23.4.1 ; extra == "anomaly"
 Requires-Dist: oracledb ; extra == "anomaly"
-Requires-Dist: report-creator ; extra == "anomaly"
+Requires-Dist: report-creator==1.0.9 ; extra == "anomaly"
 Requires-Dist: jupyter_server ; extra == "aqua"
 Requires-Dist: hdfs[kerberos] ; extra == "bds"
 Requires-Dist: ibis-framework[impala] ; extra == "bds"
@@ -61,14 +59,12 @@ Requires-Dist: oci-cli ; extra == "forecast"
 Requires-Dist: py-cpuinfo ; extra == "forecast"
 Requires-Dist: rich ; extra == "forecast"
 Requires-Dist: autots[additional] ; extra == "forecast"
-Requires-Dist: holidays==0.21.13 ; extra == "forecast"
-Requires-Dist: neuralprophet ; extra == "forecast"
+Requires-Dist: mlforecast ; extra == "forecast"
+Requires-Dist: neuralprophet>=0.7.0 ; extra == "forecast"
 Requires-Dist: numpy ; extra == "forecast"
 Requires-Dist: oci-cli ; extra == "forecast"
-Requires-Dist: optuna==3.1.0 ; extra == "forecast"
+Requires-Dist: optuna ; extra == "forecast"
 Requires-Dist: oracle-ads ; extra == "forecast"
-Requires-Dist: oracle-automlx[forecasting]==23.4.1 ; extra == "forecast"
-Requires-Dist: oracle-automlx[classic]==23.4.1 ; extra == "forecast"
 Requires-Dist: pmdarima ; extra == "forecast"
 Requires-Dist: prophet ; extra == "forecast"
 Requires-Dist: shap ; extra == "forecast"
@@ -76,13 +72,14 @@ Requires-Dist: sktime ; extra == "forecast"
 Requires-Dist: statsmodels ; extra == "forecast"
 Requires-Dist: plotly ; extra == "forecast"
 Requires-Dist: oracledb ; extra == "forecast"
-Requires-Dist: report-creator ; extra == "forecast"
+Requires-Dist: report-creator==1.0.9 ; extra == "forecast"
 Requires-Dist: geopandas ; extra == "geo"
 Requires-Dist: oracle_ads[viz] ; extra == "geo"
 Requires-Dist: transformers ; extra == "huggingface"
 Requires-Dist: langchain-community<0.0.32 ; extra == "llm"
 Requires-Dist: langchain>=0.1.10,<0.1.14 ; extra == "llm"
 Requires-Dist: evaluate>=0.4.0 ; extra == "llm"
+Requires-Dist: langchain-core<0.1.51 ; extra == "llm"
 Requires-Dist: ipython>=7.23.1, <8.0 ; extra == "notebook"
 Requires-Dist: ipywidgets~=7.6.3 ; extra == "notebook"
 Requires-Dist: lightgbm<4.0.0 ; extra == "onnx"
@@ -115,7 +112,7 @@ 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 ; extra == "pii"
+Requires-Dist: report-creator==1.0.9 ; extra == "pii"
 Requires-Dist: pyspark>=3.0.0 ; extra == "spark"
 Requires-Dist: oracle_ads[viz] ; extra == "tensorflow"
 Requires-Dist: tensorflow ; extra == "tensorflow"

{oracle_ads-2.11.9 → oracle_ads-2.11.11}/THIRD_PARTY_LICENSES.txt

@@ -447,6 +447,12 @@ python-fire
 * Source code: https://github.com/google/python-fire
 * Project home: https://github.com/google/python-fire
 
+mlforecast
+* Copyright 2024 Nixtla
+* License: Apache License 2.0
+* Source code: https://github.com/Nixtla/mlforecast
+* Project home: https://github.com/Nixtla/mlforecast
+
 =======
 =============================== Licenses ===============================
 ------------------------------------------------------------------------

{oracle_ads-2.11.9 → oracle_ads-2.11.11}/ads/aqua/__init__.py

@@ -7,7 +7,7 @@
 import os
 
 from ads import logger, set_auth
-from ads.aqua.utils import fetch_service_compartment
+from ads.aqua.common.utils import fetch_service_compartment
 from ads.config import OCI_RESOURCE_PRINCIPAL_VERSION
 
 ENV_VAR_LOG_LEVEL = "ADS_AQUA_LOG_LEVEL"

oracle_ads-2.11.9/ads/aqua/base.py → oracle_ads-2.11.11/ads/aqua/app.py

@@ -4,6 +4,7 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import os
+from dataclasses import fields
 from typing import Dict, Union
 
 import oci
@@ -11,15 +12,15 @@ from oci.data_science.models import UpdateModelDetails, UpdateModelProvenanceDet
 
 from ads import set_auth
 from ads.aqua import logger
-from ads.aqua.data import Tags
-from ads.aqua.exception import AquaRuntimeError, AquaValueError
-from ads.aqua.utils import (
-    UNKNOWN,
+from ads.aqua.common.enums import Tags
+from ads.aqua.common.errors import AquaRuntimeError, AquaValueError
+from ads.aqua.common.utils import (
     _is_valid_mvs,
     get_artifact_path,
     is_valid_ocid,
     load_config,
 )
+from ads.aqua.constants import UNKNOWN
 from ads.common import oci_client as oc
 from ads.common.auth import default_signer
 from ads.common.utils import extract_region
@@ -160,7 +161,7 @@ class AquaApp:
         """
         # TODO: tag should be selected based on which operation (eval/FT) invoke this method
         #   currently only used by fine-tuning flow.
-        tag = Tags.AQUA_FINE_TUNING.value
+        tag = Tags.AQUA_FINE_TUNING
 
         if not model_version_set_id:
             try:
@@ -277,8 +278,8 @@ class AquaApp:
         oci_model = self.ds_client.get_model(model_id).data
         oci_aqua = (
             (
-                Tags.AQUA_TAG.value in oci_model.freeform_tags
-                or Tags.AQUA_TAG.value.lower() in oci_model.freeform_tags
+                Tags.AQUA_TAG in oci_model.freeform_tags
+                or Tags.AQUA_TAG.lower() in oci_model.freeform_tags
             )
             if oci_model.freeform_tags
             else False
@@ -319,3 +320,22 @@ class AquaApp:
                 bucket=AQUA_TELEMETRY_BUCKET, namespace=AQUA_TELEMETRY_BUCKET_NS
             )
         return self._telemetry
+
+
+class CLIBuilderMixin:
+    """
+    CLI builder from API interface. To be used with the DataClass only.
+    """
+
+    def build_cli(self) -> str:
+        """
+        Method to turn the dataclass attributes to CLI
+        """
+        cmd = f"ads aqua {self._command}"
+        params = [
+            f"--{field.name} {getattr(self,field.name)}"
+            for field in fields(self.__class__)
+            if getattr(self, field.name)
+        ]
+        cmd = f"{cmd} {' '.join(params)}"
+        return cmd

oracle_ads-2.11.11/ads/aqua/cli.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2024 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+import os
+
+from ads.aqua import (
+    ENV_VAR_LOG_LEVEL,
+    ODSC_MODEL_COMPARTMENT_OCID,
+    logger,
+    set_log_level,
+)
+from ads.aqua.common.errors import AquaCLIError, AquaConfigError
+from ads.aqua.evaluation import AquaEvaluationApp
+from ads.aqua.finetuning import AquaFineTuningApp
+from ads.aqua.model import AquaModelApp
+from ads.aqua.modeldeployment import AquaDeploymentApp
+from ads.common.utils import LOG_LEVELS
+from ads.config import NB_SESSION_OCID
+
+
+class AquaCommand:
+    """Contains the command groups for project Aqua.
+
+    Acts as an entry point for managing different components of the Aqua
+    project including model management, fine-tuning, deployment, and
+    evaluation.
+    """
+
+    model = AquaModelApp
+    fine_tuning = AquaFineTuningApp
+    deployment = AquaDeploymentApp
+    evaluation = AquaEvaluationApp
+
+    def __init__(
+        self,
+        debug: bool = None,
+        verbose: bool = None,
+        log_level: str = os.environ.get(ENV_VAR_LOG_LEVEL, "ERROR").upper(),
+    ):
+        """
+        Initialize the command line interface settings for the Aqua project.
+
+        FLAGS
+        -----
+        log_level (str):
+            Sets the logging level for the application.
+            Default is retrieved from environment variable `ADS_AQUA_LOG_LEVEL`,
+            or 'ERROR' if not set. Example values include 'DEBUG', 'INFO',
+            'WARNING', 'ERROR', and 'CRITICAL'.
+        debug (bool):
+            Sets the logging level for the application to `DEBUG`.
+        verbose (bool):
+            Sets the logging level for the application to `INFO`.
+
+        Raises
+        ------
+        AquaCLIError:
+            When `--verbose` and `--debug` being used together.
+            When missing required `ODSC_MODEL_COMPARTMENT_OCID` env var.
+        """
+        if verbose is not None and debug is not None:
+            raise AquaCLIError(
+                "Cannot use `--debug` and `--verbose` at the same time. "
+                "Please select either `--debug` for `DEBUG` level logging or "
+                "`--verbose` for `INFO` level logging."
+            )
+        elif verbose is not None:
+            self._validate_value("--verbose", verbose)
+            aqua_log_level = "INFO"
+        elif debug is not None:
+            self._validate_value("--debug", debug)
+            aqua_log_level = "DEBUG"
+        else:
+            if log_level.upper() not in LOG_LEVELS:
+                logger.warning(
+                    f"Log level should be one of {LOG_LEVELS}. Setting default to ERROR."
+                )
+                log_level = "ERROR"
+            aqua_log_level = log_level.upper()
+
+        set_log_level(aqua_log_level)
+
+        if not ODSC_MODEL_COMPARTMENT_OCID:
+            if NB_SESSION_OCID:
+                raise AquaConfigError(
+                    f"Aqua is not available for the notebook session {NB_SESSION_OCID}. For more information, "
+                    f"please refer to the documentation."
+                )
+            raise AquaConfigError(
+                "ODSC_MODEL_COMPARTMENT_OCID environment variable is not set for Aqua."
+            )
+
+    @staticmethod
+    def _validate_value(flag, value):
+        """Check if the given value for bool flag is valid.
+
+        Raises
+        ------
+        AquaCLIError:
+            When the given value for bool flag is invalid.
+        """
+        if value not in [True, False]:
+            raise AquaCLIError(
+                f"Invalid input `{value}` for flag: {flag}, a boolean value is required. "
+                "If you intend to chain a function call to the result, please separate the "
+                "flag and the subsequent function call with separator `-`."
+            )

{oracle_ads-2.11.9/ads/aqua → oracle_ads-2.11.11/ads/aqua/common}/decorator.py

@@ -7,6 +7,7 @@
 
 import sys
 from functools import wraps
+from typing import TYPE_CHECKING, Union
 
 from oci.exceptions import (
     ClientError,
@@ -19,9 +20,12 @@ from oci.exceptions import (
 )
 from tornado.web import HTTPError
 
-from ads.aqua.exception import AquaError
+from ads.aqua.common.errors import AquaError
 from ads.aqua.extension.base_handler import AquaAPIhandler
 
+if TYPE_CHECKING:
+    from ads.aqua.extension.aqua_ws_msg_handler import AquaWSMsgHandler
+
 
 def handle_exceptions(func):
     """Writes errors raised during call to JSON.
@@ -53,11 +57,13 @@ def handle_exceptions(func):
     """
 
     @wraps(func)
-    def inner_function(self: AquaAPIhandler, *args, **kwargs):
+    def inner_function(
+        self: Union[AquaAPIhandler, "AquaWSMsgHandler"], *args, **kwargs
+    ):
         try:
             return func(self, *args, **kwargs)
         except ServiceError as error:
-            self.write_error(
+            return self.write_error(
                 status_code=error.status or 500,
                 message=error.message,
                 reason=error.message,
@@ -69,25 +75,25 @@ def handle_exceptions(func):
             MissingEndpointForNonRegionalServiceClientError,
             RequestException,
         ) as error:
-            self.write_error(
+            return self.write_error(
                 status_code=400,
                 reason=f"{type(error).__name__}: {str(error)}",
                 exc_info=sys.exc_info(),
             )
         except ConnectTimeout as error:
-            self.write_error(
+            return self.write_error(
                 status_code=408,
                 reason=f"{type(error).__name__}: {str(error)}",
                 exc_info=sys.exc_info(),
             )
         except (MultipartUploadError, CompositeOperationError) as error:
-            self.write_error(
+            return self.write_error(
                 status_code=500,
                 reason=f"{type(error).__name__}: {str(error)}",
                 exc_info=sys.exc_info(),
             )
         except AquaError as error:
-            self.write_error(
+            return self.write_error(
                 status_code=error.status,
                 reason=error.reason,
                 service_payload=error.service_payload,
@@ -100,7 +106,7 @@ def handle_exceptions(func):
                 exc_info=sys.exc_info(),
             )
         except Exception as ex:
-            self.write_error(
+            return self.write_error(
                 status_code=500,
                 reason=f"{type(ex).__name__}: {str(ex)}",
                 exc_info=sys.exc_info(),

oracle_ads-2.11.11/ads/aqua/common/enums.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2024 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+"""
+aqua.common.enums
+~~~~~~~~~~~~~~
+This module contains the set of enums used in AQUA.
+"""
+from ads.common.extended_enum import ExtendedEnumMeta
+
+
+class DataScienceResource(str, metaclass=ExtendedEnumMeta):
+    MODEL_DEPLOYMENT = "datasciencemodeldeployment"
+    MODEL = "datasciencemodel"
+
+
+class Resource(str, metaclass=ExtendedEnumMeta):
+    JOB = "jobs"
+    JOBRUN = "jobruns"
+    MODEL = "models"
+    MODEL_DEPLOYMENT = "modeldeployments"
+    MODEL_VERSION_SET = "model-version-sets"
+
+
+class Tags(str, metaclass=ExtendedEnumMeta):
+    TASK = "task"
+    LICENSE = "license"
+    ORGANIZATION = "organization"
+    AQUA_TAG = "OCI_AQUA"
+    AQUA_SERVICE_MODEL_TAG = "aqua_service_model"
+    AQUA_FINE_TUNED_MODEL_TAG = "aqua_fine_tuned_model"
+    AQUA_MODEL_NAME_TAG = "aqua_model_name"
+    AQUA_EVALUATION = "aqua_evaluation"
+    AQUA_FINE_TUNING = "aqua_finetuning"
+    READY_TO_FINE_TUNE = "ready_to_fine_tune"
+    READY_TO_IMPORT = "ready_to_import"
+    BASE_MODEL_CUSTOM = "aqua_custom_base_model"
+    AQUA_EVALUATION_MODEL_ID = "evaluation_model_id"
+
+
+class InferenceContainerType(str, metaclass=ExtendedEnumMeta):
+    CONTAINER_TYPE_VLLM = "vllm"
+    CONTAINER_TYPE_TGI = "tgi"
+
+
+class InferenceContainerTypeFamily(str, metaclass=ExtendedEnumMeta):
+    AQUA_VLLM_CONTAINER_FAMILY = "odsc-vllm-serving"
+    AQUA_TGI_CONTAINER_FAMILY = "odsc-tgi-serving"
+
+
+class InferenceContainerParamType(str, metaclass=ExtendedEnumMeta):
+    PARAM_TYPE_VLLM = "VLLM_PARAMS"
+    PARAM_TYPE_TGI = "TGI_PARAMS"
+
+
+class HuggingFaceTags(str, metaclass=ExtendedEnumMeta):
+    TEXT_GENERATION_INFERENCE = "text-generation-inference"
+
+
+class RqsAdditionalDetails(str, metaclass=ExtendedEnumMeta):
+    METADATA = "metadata"
+    CREATED_BY = "createdBy"
+    DESCRIPTION = "description"
+    MODEL_VERSION_SET_ID = "modelVersionSetId"
+    MODEL_VERSION_SET_NAME = "modelVersionSetName"
+    PROJECT_ID = "projectId"
+    VERSION_LABEL = "versionLabel"

oracle_ads-2.11.9/ads/aqua/exception.py → oracle_ads-2.11.11/ads/aqua/common/errors.py

@@ -10,6 +10,14 @@ aqua.exception
 This module contains the set of Aqua exceptions.
 """
 
+from ads.common.extended_enum import ExtendedEnumMeta
+
+
+class ExitCode(str, metaclass=ExtendedEnumMeta):
+    SUCCESS = 0
+    COMMON_ERROR = 1
+    INVALID_CONFIG = 10
+
 
 class AquaError(Exception):
     """AquaError
@@ -18,6 +26,8 @@ class AquaError(Exception):
     will inherit.
     """
 
+    exit_code = 1
+
     def __init__(
         self,
         reason: str,
@@ -80,3 +90,21 @@ class AquaResourceAccessError(AquaError):
 
     def __init__(self, reason, status=404, service_payload=None):
         super().__init__(reason, status, service_payload)
+
+
+class AquaConfigError(AquaError):
+    """Exception raised when config for AQUA is invalid."""
+
+    exit_code = ExitCode.INVALID_CONFIG
+
+    def __init__(self, reason, status=404, service_payload=None):
+        super().__init__(reason, status, service_payload)
+
+
+class AquaCLIError(AquaError):
+    """Exception raised when AQUA CLI encounter error."""
+
+    exit_code = ExitCode.COMMON_ERROR
+
+    def __init__(self, reason, status=None, service_payload=None):
+        super().__init__(reason, status, service_payload)