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

ads/model/extractor/pytorch_extractor.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 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.model.extractor.model_info_extractor import ModelInfoExtractor
+from ads.model.model_metadata import Framework
+from ads.common.decorator.runtime_dependency import (
+    runtime_dependency,
+    OptionalDependency,
+)
+
+
+class PyTorchExtractor(ModelInfoExtractor):
+    """Class that extract model metadata from pytorch models.
+
+    Attributes
+    ----------
+    model: object
+        The model to extract metadata from.
+    estimator: object
+        The estimator to extract metadata from.
+
+    Methods
+    -------
+    framework(self) -> str
+        Returns the framework of the model.
+    algorithm(self) -> object
+        Returns the algorithm of the model.
+    version(self) -> str
+        Returns the version of framework of the model.
+    hyperparameter(self) -> dict
+        Returns the hyperparameter of the model.
+    """
+
+    def __init__(self, model):
+        self.model = model
+
+    @property
+    def framework(self):
+        """Extracts the framework of the model.
+
+        Returns
+        ----------
+        str:
+           The framework of the model.
+        """
+        return Framework.PYTORCH
+
+    @property
+    def algorithm(self):
+        """Extracts the algorithm of the model.
+
+        Returns
+        ----------
+        object:
+           The algorithm of the model.
+        """
+        return self.model.__class__.__name__
+
+    @property
+    @runtime_dependency(module="torch", install_from=OptionalDependency.PYTORCH)
+    def version(self):
+        """Extracts the framework version of the model.
+
+        Returns
+        ----------
+        str:
+           The framework version of the model.
+        """
+        return torch.__version__
+
+    @property
+    def hyperparameter(self):
+        """Extracts the hyperparameters of the model.
+
+        Returns
+        ----------
+        dict:
+           The hyperparameters of the model.
+        """
+        return None
+
+
+class PytorchExtractor(PyTorchExtractor):
+    pass

ads/model/extractor/sklearn_extractor.py

@@ -0,0 +1,112 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 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 logging
+import re
+from collections import defaultdict
+
+from ads.model.extractor.model_info_extractor import (
+    ModelInfoExtractor,
+    normalize_hyperparameter,
+)
+from ads.model.model_metadata import Framework
+
+
+class SklearnExtractor(ModelInfoExtractor):
+    """Class that extract model metadata from sklearn models.
+
+    Attributes
+    ----------
+    model: object
+        The model to extract metadata from.
+    estimator: object
+        The estimator to extract metadata from.
+
+    Methods
+    -------
+    framework(self) -> str
+        Returns the framework of the model.
+    algorithm(self) -> object
+        Returns the algorithm of the model.
+    version(self) -> str
+        Returns the version of framework of the model.
+    hyperparameter(self) -> dict
+        Returns the hyperparameter of the model.
+    """
+
+    def __init__(self, model):
+        self.model = model
+
+    @property
+    def framework(self):
+        """Extracts the framework of the model.
+
+        Returns
+        ----------
+        str:
+           The framework of the model.
+        """
+        return Framework.SCIKIT_LEARN
+
+    @property
+    def algorithm(self):
+        """Extracts the algorithm of the model.
+
+        Returns
+        ----------
+        object:
+           The algorithm of the model.
+        """
+        return self.model.__class__.__name__
+
+    @property
+    def version(self):
+        """Extracts the framework version of the model.
+
+        Returns
+        ----------
+        str:
+           The framework version of the model.
+        """
+        import sklearn
+
+        return sklearn.__version__
+
+    @property
+    def hyperparameter(self):
+        """Extracts the hyperparameters of the model.
+
+        Returns
+        ----------
+        dict:
+           The hyperparameters of the model.
+        """
+        if hasattr(self.model, "get_params"):
+            hp_dict = self.model.get_params()
+            # make shallow copy to avoid modifying the model object
+            new_dict = hp_dict.copy()
+            # handle sklearn pipeline case
+            if "steps" in hp_dict:
+                new_dict["steps"] = defaultdict(list)
+                for i, (k, v) in enumerate(hp_dict["steps"]):
+                    new_dict["steps"][i] = {k: re.sub("[()]", "", str(v))}
+                    new_dict[k] = re.sub("[()]", "", str(v))
+            # handle sklearn model selection case
+            elif "param_grid" in hp_dict:
+                new_dict["estimator"] = str(hp_dict["estimator"])
+                new_dict["param_grid"] = defaultdict(list)
+                for k, v in hp_dict["param_grid"].items():
+                    new_dict["param_grid"][k] = v.tolist()
+                new_dict.update(self.model.best_params_)
+
+            return normalize_hyperparameter(new_dict)
+        else:
+            # for onnx model case.
+            logging.warning(
+                "Cannot extract the hyperparameters from this model automatically."
+            )
+            return {}

ads/model/extractor/spark_extractor.py

@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 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.decorator.runtime_dependency import (
+    runtime_dependency,
+    OptionalDependency,
+)
+
+from ads.model.extractor.model_info_extractor import (
+    ModelInfoExtractor,
+    normalize_hyperparameter,
+)
+from ads.model.model_metadata import Framework
+
+
+class SparkExtractor(ModelInfoExtractor):
+    """Class that extract model metadata from pyspark models.
+
+    Attributes
+    ----------
+    model: object
+        The model to extract metadata from.
+    estimator: object
+        The estimator to extract metadata from.
+
+    Methods
+    -------
+    framework(self) -> str
+        Returns the framework of the model.
+    algorithm(self) -> object
+        Returns the algorithm of the model.
+    version(self) -> str
+        Returns the version of framework of the model.
+    hyperparameter(self) -> dict
+        Returns the hyperparameter of the model.
+    """
+
+    def __init__(self, model):
+        self.model = model
+
+    @property
+    def framework(self):
+        """Extracts the framework of the model.
+
+        Returns
+        ----------
+        str:
+           The framework of the model.
+        """
+        return Framework.SPARK
+
+    @property
+    def algorithm(self):
+        """Extracts the algorithm of the model.
+
+        Returns
+        ----------
+        object:
+           The algorithm of the model.
+        """
+        return self.model.__class__.__name__
+
+    @property
+    @runtime_dependency(module="pyspark", install_from=OptionalDependency.SPARK)
+    def version(self):
+        """Extracts the framework version of the model.
+
+        Returns
+        ----------
+        str:
+           The framework version of the model.
+        """
+        return pyspark.__version__
+
+    @property
+    def hyperparameter(self):
+        """Extracts the hyperparameters of the model.
+
+        Returns
+        ----------
+        dict:
+           The hyperparameters of the model
+        """
+        hyperparams = {str(stage): stage.explainParams() for stage in self.model.stages}
+        return normalize_hyperparameter(hyperparams)

ads/model/extractor/tensorflow_extractor.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 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.model.extractor.model_info_extractor import ModelInfoExtractor
+from ads.model.model_metadata import Framework
+from ads.common.decorator.runtime_dependency import (
+    runtime_dependency,
+    OptionalDependency,
+)
+
+
+class TensorflowExtractor(ModelInfoExtractor):
+    """Class that extract model metadata from tensorflow models.
+
+    Attributes
+    ----------
+    model: object
+        The model to extract metadata from.
+    estimator: object
+        The estimator to extract metadata from.
+
+    Methods
+    -------
+    framework(self) -> str
+        Returns the framework of the model.
+    algorithm(self) -> object
+        Returns the algorithm of the model.
+    version(self) -> str
+        Returns the version of framework of the model.
+    hyperparameter(self) -> dict
+        Returns the hyperparameter of the model.
+    """
+
+    def __init__(self, model):
+        self.model = model
+
+    @property
+    def framework(self):
+        """Extracts the framework of the model.
+
+        Returns
+        ----------
+        str:
+           The framework of the model.
+        """
+        return Framework.TENSORFLOW
+
+    @property
+    def algorithm(self):
+        """Extracts the algorithm of the model.
+
+        Returns
+        ----------
+        object:
+           The algorithm of the model.
+        """
+        return self.model.__class__.__name__
+
+    @property
+    @runtime_dependency(
+        module="tensorflow", short_name="tf", install_from=OptionalDependency.TENSORFLOW
+    )
+    def version(self):
+        """Extracts the framework version of the model.
+
+        Returns
+        ----------
+        str:
+           The framework version of the model.
+        """
+        return tf.__version__
+
+    @property
+    def hyperparameter(self):
+        """Extracts the hyperparameters of the model.
+
+        Returns
+        ----------
+        dict:
+           The hyperparameters of the model.
+        """
+        return None

ads/model/extractor/xgboost_extractor.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 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 logging
+
+from ads.model.extractor.model_info_extractor import ModelInfoExtractor
+from ads.model.model_metadata import Framework
+from ads.common.decorator.runtime_dependency import (
+    runtime_dependency,
+    OptionalDependency,
+)
+import json
+
+
+class XgboostExtractor(ModelInfoExtractor):
+    """Class that extract model metadata from xgboost models.
+
+    Attributes
+    ----------
+    model: object
+        The model to extract metadata from.
+    estimator: object
+        The estimator to extract metadata from.
+
+    Methods
+    -------
+    framework(self) -> str
+        Returns the framework of the model.
+    algorithm(self) -> object
+        Returns the algorithm of the model.
+    version(self) -> str
+        Returns the version of framework of the model.
+    hyperparameter(self) -> dict
+        Returns the hyperparameter of the model.
+    """
+
+    def __init__(self, model):
+        self.model = model
+
+    @property
+    def framework(self):
+        """Extracts the framework of the model.
+
+        Returns
+        ----------
+        str:
+           The framework of the model.
+        """
+        return Framework.XGBOOST
+
+    @property
+    def algorithm(self):
+        """Extracts the algorithm of the model.
+
+        Returns
+        ----------
+        object:
+           The algorithm of the model.
+        """
+        return self.model.__class__.__name__
+
+    @property
+    @runtime_dependency(module="xgboost", install_from=OptionalDependency.BOOSTED)
+    def version(self):
+        """Extracts the framework version of the model.
+
+        Returns
+        ----------
+        str:
+           The framework version of the model.
+        """
+        return xgboost.__version__
+
+    @property
+    def hyperparameter(self):
+        """Extracts the hyperparameters of the model.
+
+        Returns
+        ----------
+        dict:
+           The hyperparameters of the model.
+        """
+        if hasattr(self.model, "get_params"):
+            return self.model.get_params()
+        elif hasattr(self.model, "save_config"):
+            return json.loads(self.model.save_config())
+        else:
+            logging.warning(
+                "Cannot extract the hyperparameters from this model automatically."
+            )
+            return {}

ads/model/framework/__init__.py

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

ads/model/framework/automl_model.py

@@ -0,0 +1,178 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2022, 2023 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 Callable, Dict, List, Optional
+from ads.common import logger
+from ads.model.extractor.automl_extractor import AutoMLExtractor
+from ads.model.generic_model import FrameworkSpecificModel
+from ads.model.model_properties import ModelProperties
+from ads.model.serde.common import SERDE
+from ads.common.decorator.deprecate import deprecated
+
+
+class AutoMLModel(FrameworkSpecificModel):
+    """AutoMLModel class for estimators from AutoML framework.
+
+    Attributes
+    ----------
+    algorithm: str
+        "ensemble", the algorithm name of the model.
+    artifact_dir: str
+        Artifact directory to store the files needed for deployment.
+    auth: Dict
+        Default authentication is set using the `ads.set_auth` API. To override the
+        default, use the `ads.common.auth.api_keys` or `ads.common.auth.resource_principal` to create
+        an authentication signer to instantiate an IdentityClient object.
+    estimator: Callable
+        A trained automl estimator/model using oracle automl.
+    framework: str
+        "oracle_automl", the framework name of the estimator.
+    hyperparameter: dict
+        The hyperparameters of the estimator.
+    metadata_custom: ModelCustomMetadata
+        The model custom metadata.
+    metadata_provenance: ModelProvenanceMetadata
+        The model provenance metadata.
+    metadata_taxonomy: ModelTaxonomyMetadata
+        The model taxonomy metadata.
+    model_artifact: ModelArtifact
+        This is built by calling prepare.
+    model_deployment: ModelDeployment
+        A ModelDeployment instance.
+    model_file_name: str
+        Name of the serialized model. Default to "model.pkl".
+    model_id: str
+        The model ID.
+    properties: ModelProperties
+        ModelProperties object required to save and deploy model.
+        For more details, check https://accelerated-data-science.readthedocs.io/en/latest/ads.model.html#module-ads.model.model_properties.
+    runtime_info: RuntimeInfo
+        A RuntimeInfo instance.
+    schema_input: Schema
+        Schema describes the structure of the input data.
+    schema_output: Schema
+        Schema describes the structure of the output data.
+    serialize: bool
+        Whether to serialize the model to pkl file by default. If False, you need to serialize the model manually,
+        save it under artifact_dir and update the score.py manually.
+    version: str
+        The framework version of the model.
+
+    Methods
+    -------
+    delete_deployment(...)
+        Deletes the current model deployment.
+    deploy(..., **kwargs)
+        Deploys a model.
+    from_model_artifact(uri, model_file_name, artifact_dir, ..., **kwargs)
+        Loads model from the specified folder, or zip/tar archive.
+    from_model_catalog(model_id, model_file_name, artifact_dir, ..., **kwargs)
+        Loads model from model catalog.
+    introspect(...)
+        Runs model introspection.
+    predict(data, ...)
+        Returns prediction of input data run against the model deployment endpoint.
+    prepare(..., **kwargs)
+        Prepare and save the score.py, serialized model and runtime.yaml file.
+    reload(...)
+        Reloads the model artifact files: `score.py` and the `runtime.yaml`.
+    save(..., **kwargs)
+        Saves model artifacts to the model catalog.
+    summary_status(...)
+        Gets a summary table of the current status.
+    verify(data, ...)
+        Tests if deployment works in local environment.
+
+    Examples
+    --------
+    >>> import tempfile
+    >>> import logging
+    >>> import warnings
+    >>> from ads.automl.driver import AutoML
+    >>> from ads.automl.provider import OracleAutoMLProvider
+    >>> from ads.dataset.dataset_browser import DatasetBrowser
+    >>> from ads.model.framework.automl_model import AutoMLModel
+    >>> from ads.model.model_metadata import UseCaseType
+    >>> ds = DatasetBrowser.sklearn().open("wine").set_target("target")
+    >>> train, test = ds.train_test_split(test_size=0.1, random_state = 42)
+
+    >>> ml_engine = OracleAutoMLProvider(n_jobs=-1, loglevel=logging.ERROR)
+    >>> oracle_automl = AutoML(train, provider=ml_engine)
+    >>> model, baseline = oracle_automl.train(
+    ...                model_list=['LogisticRegression', 'DecisionTreeClassifier'],
+    ...                random_state = 42,
+    ...                time_budget = 500
+    ...        )
+
+    >>> automl_model.prepare(inference_conda_env=inference_conda_env, force_overwrite=True)
+    >>> automl_model.verify(...)
+    >>> automl_model.save()
+    >>> model_deployment = automl_model.deploy(wait_for_completion=False)
+    """
+
+    _PREFIX = "automl"
+
+    @deprecated(
+        details=f"Working with AutoML has moved from within ADS to working directly with the automlx library. Please use `GenericModel` https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/frameworks/genericmodel.html class instead. An example can be found at https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/frameworks/automlmodel.html",
+        raise_error=True,
+    )
+    def __init__(
+        self,
+        estimator: Callable,
+        artifact_dir: str,
+        properties: Optional[ModelProperties] = None,
+        auth: Dict = None,
+        model_save_serializer: Optional[SERDE] = None,
+        model_input_serializer: Optional[SERDE] = None,
+        **kwargs,
+    ):
+        """
+        Initiates a AutoMLModel instance.
+
+        Parameters
+        ----------
+        estimator: Callable
+            Any model object generated by automl framework.
+        artifact_dir: str
+            Directory for generate artifact.
+        properties: (ModelProperties, optional). Defaults to None.
+            ModelProperties object required to save and deploy model.
+        auth: (Dict, optional). Defaults to None.
+            The default authetication is set using `ads.set_auth` API. If you need to override the
+            default, use the `ads.common.auth.api_keys` or `ads.common.auth.resource_principal` to create appropriate
+            authentication signer and kwargs required to instantiate IdentityClient object.
+        model_save_serializer: (SERDE or str, optional). Defaults to None.
+            Instance of ads.model.SERDE. Used for serialize/deserialize model.
+        model_input_serializer: (SERDE, optional). Defaults to None.
+            Instance of ads.model.SERDE. Used for serialize/deserialize data.
+
+        Returns
+        -------
+        AutoMLModel
+            AutoMLModel instance.
+
+        Raises
+        ------
+        TypeError
+            If the input model is not an AutoML model.
+        """
+        if not str(type(estimator)).startswith("<class 'ads.common.model.ADSModel'"):
+            raise TypeError(f"{str(type(estimator))} is not supported in AutoMLModel.")
+        super().__init__(
+            estimator=estimator,
+            artifact_dir=artifact_dir,
+            properties=properties,
+            auth=auth,
+            model_save_serializer=model_save_serializer,
+            model_input_serializer=model_input_serializer,
+            **kwargs,
+        )
+        self._extractor = AutoMLExtractor(estimator)
+        self.framework = self._extractor.framework
+        self.algorithm = self._extractor.algorithm
+        self.version = self._extractor.version
+        self.hyperparameter = self._extractor.hyperparameter