Merge pull request #25 from oracle/2.6.x

Release version 2.6.9

Author: mrDzurb

.gitignore

@@ -10,8 +10,6 @@ __pycache__/
 .Python
 env/
 build/
-docs/build/
-docs/docs_html/
 develop-eggs/
 dist/
 downloads/
@@ -26,7 +24,6 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
-ads_latest.zip
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

README.md

@@ -138,7 +138,7 @@ Multiple extra dependencies can be installed together. For example:
   df = pd.read_csv(f"oci://{bucket_name}@{namespace}/{key}", storage_options=default_signer())
 ```
 
-### Load data from ADB 
+### Load data from ADB
 
 This example uses SQL injection safe binding variables.
 

ads/__init__.py

@@ -7,8 +7,8 @@
 from __future__ import print_function, division, absolute_import
 import os
 import logging
-import sys
 import json
+from typing import Callable, Dict, Optional, Union
 
 __version__ = ""
 with open(
@@ -25,52 +25,20 @@
 from ads.feature_engineering.accessor.series_accessor import ADSSeriesAccessor
 from ads.feature_engineering.accessor.dataframe_accessor import ADSDataFrameAccessor
 from ads.common import auth
+from ads.common.auth import set_auth
 
 os.environ["GIT_PYTHON_REFRESH"] = "quiet"
 
 
 debug_mode = os.environ.get("DEBUG_MODE", False)
 documentation_mode = os.environ.get("DOCUMENTATION_MODE", "False") == "True"
-oci_config_path = oci.config.DEFAULT_LOCATION  # "~/.oci/config"
-oci_key_profile = "DEFAULT"
 test_mode = os.environ.get("TEST_MODE", False)
-resource_principal_mode = bool(os.environ.get("RESOURCE_PRINCIPAL_MODE", False))
+resource_principal_mode = bool(
+    os.environ.get("RESOURCE_PRINCIPAL_MODE", False)
+)  # deprecated with is_resource_principal_mode() from ads.common.utils
 orig_ipython_traceback = None
 
 
-def set_auth(
-    auth="api_key", oci_config_location=oci.config.DEFAULT_LOCATION, profile="DEFAULT"
-):
-    """
-    Enable/disable resource principal identity or keypair identity in a notebook session.
-
-    Parameters
-    ----------
-    auth: {'api_key', 'resource_principal'}, default 'api_key'
-         Enable/disable resource principal identity or keypair identity in a notebook session
-    oci_config_location: str, default oci.config.DEFAULT_LOCATION, which is '~/.oci/config'
-        config file location
-    profile: str, default 'DEFAULT'
-         profile name for api keys config file
-    """
-    global resource_principal_mode
-    global oci_config_path
-    global oci_key_profile
-    oci_key_profile = profile
-
-    if auth == "api_key":
-        resource_principal_mode = False
-        if os.path.exists(os.path.expanduser(oci_config_location)):
-            oci_config_path = oci_config_location
-        else:
-            logging.warning(
-                f"{oci_config_location} file does not exist, default value oci.config.DEFAULT_LOCATION used instead"
-            )
-            oci_config_path = oci.config.DEFAULT_LOCATION
-    elif auth == "resource_principal":
-        resource_principal_mode = True
-
-
 def getLogger(name="ads"):
     logger = logging.getLogger(name)
     logger.setLevel(logging.WARNING)

ads/ads_version.json

@@ -1,3 +1,3 @@
 {
-  "version": "2.6.8"
+  "version": "2.6.9"
 }

ads/catalog/__init__.py

@@ -4,6 +4,16 @@
 # Copyright (c) 2020, 2022 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+import warnings
+
+warnings.warn(
+    (
+        "The `ads.catalog` is deprecated in `oracle-ads 2.6.9` and will be removed in `oracle-ads 3.0`."
+    ),
+    DeprecationWarning,
+    stacklevel=2,
+)
+
 import logging
 
 logger = logging.getLogger(__name__)

ads/catalog/model.py

@@ -4,6 +4,18 @@
 # Copyright (c) 2020, 2022 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+import warnings
+
+warnings.warn(
+    (
+        "The `ads.catalog.model` is deprecated in `oracle-ads 2.6.9` and will be removed in `oracle-ads 3.0`. "
+        "Use framework specific Model utility class for saving and deploying model. "
+        "Check https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/quick_start.html"
+    ),
+    DeprecationWarning,
+    stacklevel=2,
+)
+
 import json
 import os
 import shutil
@@ -23,7 +35,7 @@
     OptionalDependency,
 )
 from ads.common.model_artifact import ConflictStrategy, ModelArtifact
-from ads.common.model_metadata import (
+from ads.model.model_metadata import (
     METADATA_SIZE_LIMIT,
     MetadataSizeTooLarge,
     ModelCustomMetadata,
@@ -100,6 +112,10 @@ class ModelSummaryList(SummaryList):
         Filters the model list according to a lambda filter function, or list comprehension.
     """
 
+    @deprecated(
+        "2.6.6",
+        details="Use framework specific Model utility class for saving and deploying model. Check https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/quick_start.html",
+    )
     def __init__(
         self,
         model_catalog,
@@ -217,6 +233,10 @@ class Model:
         "defined_metadata_list",
     ]
 
+    @deprecated(
+        "2.6.6",
+        details="Use framework specific Model utility class for saving and deploying model. Check https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/quick_start.html",
+    )
     def __init__(
         self,
         model: OCIModel,
@@ -301,7 +321,7 @@ def _extract_metadata_taxonomy(model):
         metadata_taxonomy = ModelTaxonomyMetadata()
         if hasattr(model, "defined_metadata_list"):
             try:
-                metadata_taxonomy = ModelTaxonomyMetadata._from_oci_metadata_list(
+                metadata_taxonomy = ModelTaxonomyMetadata._from_oci_metadata(
                     model.defined_metadata_list
                 )
             except Exception as e:
@@ -314,7 +334,7 @@ def _extract_metadata_custom(model):
         metadata_custom = ModelCustomMetadata()
         if hasattr(model, "custom_metadata_list"):
             try:
-                metadata_custom = ModelCustomMetadata._from_oci_metadata_list(
+                metadata_custom = ModelCustomMetadata._from_oci_metadata(
                     model.custom_metadata_list
                 )
             except Exception as e:
@@ -430,13 +450,11 @@ def commit(self, force: bool = True) -> None:
         }
 
         if hasattr(self, "metadata_custom"):
-            attributes[
-                "custom_metadata_list"
-            ] = self.metadata_custom._to_oci_metadata_list()
+            attributes["custom_metadata_list"] = self.metadata_custom._to_oci_metadata()
         if hasattr(self, "metadata_taxonomy"):
             attributes[
                 "defined_metadata_list"
-            ] = self.metadata_taxonomy._to_oci_metadata_list()
+            ] = self.metadata_taxonomy._to_oci_metadata()
 
         update_model_details = UpdateModelDetails(**attributes)
         # freeform_tags=self._model.freeform_tags, defined_tags=self._model.defined_tags)
@@ -589,6 +607,10 @@ class ModelCatalog:
         Uploads the model artifact to cloud storage.
     """
 
+    @deprecated(
+        "2.6.6",
+        details="Use framework specific Model utility class for saving and deploying model. Check https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/quick_start.html",
+    )
     def __init__(
         self,
         compartment_id: Optional[str] = None,
@@ -1208,17 +1230,15 @@ def download_model(
 
         if hasattr(model_response.data, "custom_metadata_list"):
             try:
-                result.metadata_custom = ModelCustomMetadata._from_oci_metadata_list(
+                result.metadata_custom = ModelCustomMetadata._from_oci_metadata(
                     model_response.data.custom_metadata_list
                 )
             except:
                 result.metadata_custom = ModelCustomMetadata()
         if hasattr(model_response.data, "defined_metadata_list"):
             try:
-                result.metadata_taxonomy = (
-                    ModelTaxonomyMetadata._from_oci_metadata_list(
-                        model_response.data.defined_metadata_list
-                    )
+                result.metadata_taxonomy = ModelTaxonomyMetadata._from_oci_metadata(
+                    model_response.data.defined_metadata_list
                 )
             except:
                 result.metadata_taxonomy = ModelTaxonomyMetadata()
@@ -1248,6 +1268,10 @@ def download_model(
             )
         return result
 
+    @deprecated(
+        "2.6.6",
+        details="Use framework specific Model utility class for saving and deploying model. Check https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/quick_start.html",
+    )
     def upload_model(
         self,
         model_artifact: ModelArtifact,
@@ -1335,10 +1359,10 @@ def upload_model(
                 description=description,
                 project_id=project_id,
                 compartment_id=self.compartment_id,
-                custom_metadata_list=model_artifact.metadata_custom._to_oci_metadata_list()
+                custom_metadata_list=model_artifact.metadata_custom._to_oci_metadata()
                 if model_artifact.metadata_custom is not None
                 else [],
-                defined_metadata_list=model_artifact.metadata_taxonomy._to_oci_metadata_list()
+                defined_metadata_list=model_artifact.metadata_taxonomy._to_oci_metadata()
                 if model_artifact.metadata_taxonomy is not None
                 else [],
                 input_schema=model_artifact.schema_input.to_json()

ads/catalog/notebook.py

@@ -4,6 +4,16 @@
 # Copyright (c) 2020, 2022 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+import warnings
+
+warnings.warn(
+    (
+        "The `ads.catalog.notebook` is deprecated in `oracle-ads 2.6.9` and will be removed in `oracle-ads 3.0`."
+    ),
+    DeprecationWarning,
+    stacklevel=2,
+)
+
 from pandas import DataFrame
 import oci
 from oci.data_science.models import (

ads/catalog/project.py

@@ -4,6 +4,16 @@
 # Copyright (c) 2020, 2022 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+import warnings
+
+warnings.warn(
+    (
+        "The `ads.catalog.project` is deprecated in `oracle-ads 2.6.9` and will be removed in `oracle-ads 3.0`."
+    ),
+    DeprecationWarning,
+    stacklevel=2,
+)
+
 from ads.catalog.summary import SummaryList
 from ads.common import oci_client, auth
 from ads.common import utils

ads/catalog/summary.py

@@ -5,7 +5,15 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 from __future__ import print_function, absolute_import
-
+import warnings
+
+warnings.warn(
+    (
+        "The `ads.catalog.summary` is deprecated in `oracle-ads 2.6.9` and will be removed in `oracle-ads 3.0`."
+    ),
+    DeprecationWarning,
+    stacklevel=2,
+)
 import abc
 import ads.common.utils as utils
 from oci.util import to_dict