oracle-ads 2.12.2__py3-none-any.whl → 2.12.4__py3-none-any.whl

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

@@ -1,20 +1,19 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2023 Oracle and/or its affiliates.
+# 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 ..const import SupportedModels, AUTO_SELECT
+from ..const import AUTO_SELECT, SupportedModels
+from ..model_evaluator import ModelEvaluator
 from ..operator_config import ForecastOperatorConfig
 from .arima import ArimaOperatorModel
 from .automlx import AutoMLXOperatorModel
 from .autots import AutoTSOperatorModel
 from .base_model import ForecastOperatorBaseModel
+from .forecast_datasets import ForecastDatasets
 from .neuralprophet import NeuralProphetOperatorModel
 from .prophet import ProphetOperatorModel
-from .forecast_datasets import ForecastDatasets
-from .ml_forecast import MLForecastOperatorModel
-from ..model_evaluator import ModelEvaluator
+
 
 class UnSupportedModelError(Exception):
     def __init__(self, model_type: str):
@@ -33,9 +32,9 @@ class ForecastOperatorModelFactory:
         SupportedModels.Prophet: ProphetOperatorModel,
         SupportedModels.Arima: ArimaOperatorModel,
         SupportedModels.NeuralProphet: NeuralProphetOperatorModel,
-        SupportedModels.LGBForecast: MLForecastOperatorModel,
+        # SupportedModels.LGBForecast: MLForecastOperatorModel,
         SupportedModels.AutoMLX: AutoMLXOperatorModel,
-        SupportedModels.AutoTS: AutoTSOperatorModel
+        SupportedModels.AutoTS: AutoTSOperatorModel,
     }
 
     @classmethod
@@ -65,14 +64,14 @@ class ForecastOperatorModelFactory:
         model_type = operator_config.spec.model
         if model_type == AUTO_SELECT:
             model_type = cls.auto_select_model(datasets, operator_config)
-            operator_config.spec.model_kwargs = dict()
+            operator_config.spec.model_kwargs = {}
         if model_type not in cls._MAP:
             raise UnSupportedModelError(model_type)
         return cls._MAP[model_type](config=operator_config, datasets=datasets)
 
     @classmethod
     def auto_select_model(
-            cls, datasets: ForecastDatasets, operator_config: ForecastOperatorConfig
+        cls, datasets: ForecastDatasets, operator_config: ForecastOperatorConfig
     ) -> str:
         """
         Selects AutoMLX or Arima model based on column count.
@@ -90,8 +89,10 @@ class ForecastOperatorModelFactory:
         str
             The type of the model.
         """
-        all_models = operator_config.spec.model_kwargs.get("model_list", cls._MAP.keys())
+        all_models = operator_config.spec.model_kwargs.get(
+            "model_list", cls._MAP.keys()
+        )
         num_backtests = operator_config.spec.model_kwargs.get("num_backtests", 5)
         sample_ratio = operator_config.spec.model_kwargs.get("sample_ratio", 0.20)
         model_evaluator = ModelEvaluator(all_models, num_backtests, sample_ratio)
-        return model_evaluator.find_best_model(datasets, operator_config)
+        return model_evaluator.find_best_model(datasets, operator_config)

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

@@ -2,7 +2,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 numpy as np
+import traceback
+
 import pandas as pd
 
 from ads.common.decorator import runtime_dependency
@@ -164,7 +165,7 @@ class MLForecastOperatorModel(ForecastOperatorBaseModel):
             self.errors_dict[self.spec.model] = {
                 "model_name": self.spec.model,
                 "error": str(e),
-                "error_trace": traceback.format_exc()
+                "error_trace": traceback.format_exc(),
             }
             logger.warn(f"Encountered Error: {e}. Skipping.")
             logger.warn(traceback.format_exc())
@@ -173,7 +174,7 @@ class MLForecastOperatorModel(ForecastOperatorBaseModel):
     def _build_model(self) -> pd.DataFrame:
         data_train = self.datasets.get_all_data_long(include_horizon=False)
         data_test = self.datasets.get_all_data_long_forecast_horizon()
-        self.models = dict()
+        self.models = {}
         model_kwargs = self.set_kwargs()
         self.forecast_output = ForecastOutput(
             confidence_interval_width=self.spec.confidence_interval_width,

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

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2023 Oracle and/or its affiliates.
+# 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/
 
 import os
@@ -9,13 +8,17 @@ from dataclasses import dataclass, field
 from typing import Dict, List
 
 from ads.common.serializer import DataClassSerializable
+from ads.opctl.operator.common.operator_config import (
+    InputData,
+    OperatorConfig,
+    OutputDirectory,
+)
 from ads.opctl.operator.common.utils import _load_yaml_from_uri
-from ads.opctl.operator.common.operator_config import OperatorConfig, OutputDirectory, InputData
-
-from .const import SupportedMetrics, SpeedAccuracyMode
-from .const import SupportedModels
 from ads.opctl.operator.lowcode.common.utils import find_output_dirname
 
+from .const import SpeedAccuracyMode, SupportedMetrics, SupportedModels
+
+
 @dataclass(repr=True)
 class TestData(InputData):
     """Class representing operator specification test data details."""
@@ -90,13 +93,17 @@ class ForecastOperatorSpec(DataClassSerializable):
 
     def __post_init__(self):
         """Adjusts the specification details."""
-        self.output_directory = self.output_directory or OutputDirectory(url=find_output_dirname(self.output_directory))
+        self.output_directory = self.output_directory or OutputDirectory(
+            url=find_output_dirname(self.output_directory)
+        )
         self.metric = (self.metric or "").lower() or SupportedMetrics.SMAPE.lower()
-        self.model = self.model or SupportedModels.Auto
+        self.model = self.model or SupportedModels.Prophet
         self.confidence_interval_width = self.confidence_interval_width or 0.80
         self.report_filename = self.report_filename or "report.html"
         self.preprocessing = (
-            self.preprocessing if self.preprocessing is not None else DataPreprocessor(enabled=True)
+            self.preprocessing
+            if self.preprocessing is not None
+            else DataPreprocessor(enabled=True)
         )
         # For Report Generation. When user doesn't specify defaults to True
         self.generate_report = (
@@ -138,7 +145,7 @@ class ForecastOperatorSpec(DataClassSerializable):
         )
         self.target_column = self.target_column or "Sales"
         self.errors_dict_filename = "errors.json"
-        self.model_kwargs = self.model_kwargs or dict()
+        self.model_kwargs = self.model_kwargs or {}
 
 
 @dataclass(repr=True)

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

@@ -374,12 +374,12 @@ spec:
     model:
       type: string
       required: false
-      default: auto-select
+      default: prophet
       allowed:
         - prophet
         - arima
         - neuralprophet
-        - lgbforecast
+        # - lgbforecast
         - automlx
         - autots
         - auto-select

ads/oracledb/oracle_db.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2021, 2023 Oracle and/or its affiliates.
+# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 """
@@ -17,19 +16,20 @@ If user uses DSN string copied from OCI console with OCI database setup for TLS
 Note: We need to account for cx_Oracle though oracledb can operate in thick mode. The end user may be is using one of the old conda packs or an environment where cx_Oracle is the only available driver.
 """
 
-from ads.common.utils import ORACLE_DEFAULT_PORT
-
 import logging
-import numpy as np
 import os
-import pandas as pd
 import tempfile
-from time import time
-from typing import Dict, Optional, List, Union, Iterator
 import zipfile
+from time import time
+from typing import Dict, Iterator, List, Optional, Union
+
+import numpy as np
+import pandas as pd
+
 from ads.common.decorator.runtime_dependency import (
     OptionalDependency,
 )
+from ads.common.utils import ORACLE_DEFAULT_PORT
 
 logger = logging.getLogger("ads.oracle_connector")
 CX_ORACLE = "cx_Oracle"
@@ -40,17 +40,17 @@ try:
     import oracledb as oracle_driver  # Both the driver share same signature for the APIs that we are using.
 
     PYTHON_DRIVER_NAME = PYTHON_ORACLEDB
-except:
+except ModuleNotFoundError:
     logger.info("oracledb package not found. Trying to load cx_Oracle")
     try:
         import cx_Oracle as oracle_driver
 
         PYTHON_DRIVER_NAME = CX_ORACLE
-    except ModuleNotFoundError:
+    except ModuleNotFoundError as err2:
         raise ModuleNotFoundError(
             f"Neither `oracledb` nor `cx_Oracle` module was not found. Please run "
             f"`pip install {OptionalDependency.DATA}`."
-        )
+        ) from err2
 
 
 class OracleRDBMSConnection(oracle_driver.Connection):
@@ -75,7 +75,7 @@ class OracleRDBMSConnection(oracle_driver.Connection):
                 logger.info(
                     "Running oracledb driver in thick mode. For mTLS based connection, thick mode is default."
                 )
-            except:
+            except Exception:
                 logger.info(
                     "Could not use thick mode. The driver is running in thin mode. System might prompt for passphrase"
                 )
@@ -154,7 +154,6 @@ class OracleRDBMSConnection(oracle_driver.Connection):
         batch_size=100000,
         encoding="utf-8",
     ):
-
         if if_exists not in ["fail", "replace", "append"]:
             raise ValueError(
                 f"Unknown option `if_exists`={if_exists}. Valid options are 'fail', 'replace', 'append'"
@@ -173,7 +172,6 @@ class OracleRDBMSConnection(oracle_driver.Connection):
         df_orcl.columns = df_orcl.columns.str.replace(r"\W+", "_", regex=True)
         table_exist = True
         with self.cursor() as cursor:
-
             if if_exists != "replace":
                 try:
                     cursor.execute(f"SELECT 1 from {table_name} FETCH NEXT 1 ROWS ONLY")
@@ -275,7 +273,6 @@ class OracleRDBMSConnection(oracle_driver.Connection):
                     yield lst[i : i + batch_size]
 
             for batch in chunks(record_data, batch_size=batch_size):
-
                 cursor.executemany(sql, batch, batcherrors=True)
 
                 for error in cursor.getbatcherrors():
@@ -304,7 +301,6 @@ class OracleRDBMSConnection(oracle_driver.Connection):
     def query(
         self, sql: str, bind_variables: Optional[Dict], chunksize=None
     ) -> Union[pd.DataFrame, Iterator[pd.DataFrame]]:
-
         start_time = time()
 
         cursor = self.cursor()
@@ -315,10 +311,8 @@ class OracleRDBMSConnection(oracle_driver.Connection):
             cursor.execute(sql, **bind_variables)
             columns = [row[0] for row in cursor.description]
             df = iter(
-                (
-                    pd.DataFrame(data=rows, columns=columns)
-                    for rows in self._fetch_by_batch(cursor, chunksize)
-                )
+                pd.DataFrame(data=rows, columns=columns)
+                for rows in self._fetch_by_batch(cursor, chunksize)
             )
 
         else:
@@ -332,3 +326,21 @@ class OracleRDBMSConnection(oracle_driver.Connection):
             )
 
         return df
+
+
+def get_adw_connection(vault_secret_id: str) -> "oracledb.Connection":
+    """Creates ADW connection from the credentials stored in the vault"""
+    import oracledb
+
+    from ads.secrets.adb import ADBSecretKeeper
+
+    secret = vault_secret_id
+
+    logging.getLogger().debug("A secret id was used to retrieve credentials.")
+    creds = ADBSecretKeeper.load_secret(secret).to_dict()
+    user = creds.pop("user_name", None)
+    password = creds.pop("password", None)
+    if not user or not password:
+        raise ValueError(f"The user or password is missing in {secret}")
+    logging.getLogger().debug("Downloaded secrets successfully.")
+    return oracledb.connect(user=user, password=password, **creds)

ads/secrets/adb.py

@@ -1,17 +1,18 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2021, 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 ads
-from ads.secrets import SecretKeeper, Secret
 import json
 import os
 import tempfile
 import zipfile
+
 from tqdm.auto import tqdm
 
+import ads
+from ads.secrets import Secret, SecretKeeper
+
 logger = ads.getLogger("ads.secrets")
 
 from dataclasses import dataclass, field
@@ -25,7 +26,7 @@ class ADBSecret(Secret):
 
     user_name: str
     password: str
-    service_name: str
+    service_name: str = field(default=None)
     wallet_location: str = field(
         default=None, metadata={"serializable": False}
     )  # Not saved in vault
@@ -40,6 +41,7 @@ class ADBSecret(Secret):
     wallet_secret_ids: list = field(
         repr=False, default_factory=list
     )  # Not exposed through environment or `to_dict` function
+    dsn: str = field(default=None)
 
     def __post_init__(self):
         self.wallet_file_name = (
@@ -76,6 +78,22 @@ class ADBSecretKeeper(SecretKeeper):
     >>> print(adw_keeper.secret_id) # Prints the secret_id of the stored credentials
     >>> adw_keeper.export_vault_details("adw_employee_att.json", format="json") # Save the secret id and vault info to a json file
 
+
+    >>> # Saving credentials for TLS connection
+    >>> from ads.secrets.adw import ADBSecretKeeper
+    >>> vault_id = "ocid1.vault.oc1..<unique_ID>"
+    >>> kid = "ocid1.ke..<unique_ID>"
+
+    >>> import ads
+    >>> ads.set_auth("resource_principal") # If using resource principal for authentication
+    >>> connection_parameters={
+    ...     "user_name":"admin",
+    ...     "password":"<your password>",
+    ...     "dsn":"<dsn string>"
+    ... }
+    >>> adw_keeper = ADBSecretKeeper(vault_id=vault_id, key_id=kid, **connection_parameters)
+    >>> adw_keeper.save("adw_employee", "My DB credentials", freeform_tags={"schema":"emp"})
+
     >>> # Loading credentails
     >>> import ads
     >>> ads.set_auth("resource_principal") # If using resource principal for authentication
@@ -133,6 +151,7 @@ class ADBSecretKeeper(SecretKeeper):
         wallet_dir: str = None,
         repository_path: str = None,
         repository_key: str = None,
+        dsn: str = None,
         **kwargs,
     ):
         """
@@ -152,6 +171,8 @@ class ADBSecretKeeper(SecretKeeper):
             Path to credentials repository. For more details refer `ads.database.connection`
         repository_key: (str, optional). Default None.
             Configuration key for loading the right configuration from repository. For more details refer `ads.database.connection`
+        dsn: (str, optional). Default None.
+            dsn string copied from the OCI console for TLS connection
         kwargs:
             vault_id: str. OCID of the vault where the secret is stored. Required for saving secret.
             key_id: str. OCID of the key used for encrypting the secret. Required for saving secret.
@@ -180,6 +201,7 @@ class ADBSecretKeeper(SecretKeeper):
             password=password,
             service_name=service_name,
             wallet_location=wallet_location,
+            dsn=dsn,
         )
         self.wallet_dir = wallet_dir
 
@@ -252,7 +274,7 @@ class ADBSecretKeeper(SecretKeeper):
             logger.debug(f"Setting wallet file to {self.data.wallet_location}")
             data.wallet_location = self.data.wallet_location
         elif data.wallet_secret_ids and len(data.wallet_secret_ids) > 0:
-            logger.debug(f"Secret ids corresponding to the wallet files found.")
+            logger.debug("Secret ids corresponding to the wallet files found.")
             # If the secret ids for wallet files are available in secret, then we
             # can generate the wallet file.
 

{oracle_ads-2.12.2.dist-info → oracle_ads-2.12.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: oracle_ads
-Version: 2.12.2
+Version: 2.12.4
 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
@@ -40,6 +40,7 @@ Requires-Dist: oracledb ; extra == "anomaly"
 Requires-Dist: report-creator==1.0.9 ; extra == "anomaly"
 Requires-Dist: rrcf==0.4.4 ; extra == "anomaly"
 Requires-Dist: scikit-learn ; extra == "anomaly"
+Requires-Dist: salesforce-merlion[all]==2.0.4 ; extra == "anomaly"
 Requires-Dist: jupyter_server ; extra == "aqua"
 Requires-Dist: hdfs[kerberos] ; extra == "bds"
 Requires-Dist: ibis-framework[impala] ; extra == "bds"