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

ads/model/base_properties.py

@@ -0,0 +1,238 @@
+#!/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/
+
+import dataclasses
+import json
+import os
+from typing import Any, Dict, Optional, Union
+
+from ads.common.config import Config, ConfigSection
+from ads.common.serializer import Serializable
+
+
+@dataclasses.dataclass(repr=False)
+class BaseProperties(Serializable):
+    """Represents base properties class.
+
+    Methods
+    -------
+    with_prop(name: str, value: Any) -> BaseProperties
+        Sets property value.
+    with_dict(obj_dict: Dict) -> BaseProperties
+        Populates properties values from dict.
+    with_env() -> BaseProperties
+        Populates properties values from environment variables.
+    to_dict() -> Dict
+        Serializes instance of class into a dictionary.
+    with_config(config: ads.config.ConfigSection) -> BaseProperties
+        Sets properties values from the config profile.
+    from_dict(obj_dict: Dict[str, Any]) -> "BaseProperties"
+        Creates an instance of the properties class from a dictionary.
+    from_config(uri: str, profile: str, auth: Optional[Dict] = None) -> "BaseProperties":
+        Loads properties from the config file.
+    to_config(uri: str, profile: str, force_overwrite: Optional[bool] = False, auth: Optional[Dict] = None) -> None
+        Saves properties to the config file.
+    """
+
+    def __setattr__(self, name: str, value: Any):
+        """Adds type validation when attribute assignment is attempted."""
+        if value is None:
+            self.__dict__[name] = value
+        elif name in self.__annotations__:
+            if hasattr(self.__annotations__[name], "__origin__"):
+                if self.__annotations__[name].__origin__ is Union and not isinstance(
+                    value, self.__annotations__[name].__args__
+                ):
+                    raise TypeError(
+                        f"Field `{name}` was expected to be of type `{self.__annotations__[name].__args__}` "
+                        f"but type `{type(value)}` was provided."
+                    )
+
+            elif self.__annotations__[name] != type(value):
+                raise TypeError(
+                    f"Field `{name}` was expected to be of type `{self.__annotations__[name]}` "
+                    f"but type `{type(value)}` was provided."
+                )
+
+            self.__dict__[name] = value
+
+    def with_prop(self, name: str, value: Any) -> "BaseProperties":
+        """Sets property value.
+
+        Parameters
+        ----------
+        name: str
+            Property name.
+        value:
+            Property value.
+
+        Returns
+        -------
+        BaseProperties
+            Instance of the BaseProperties.
+        """
+        setattr(self, name, value)
+        return self
+
+    def with_dict(self, obj_dict: Dict[str, Any]) -> "BaseProperties":
+        """Sets properties from a dict.
+
+        Parameters
+        ----------
+        obj_dict: Dict[str, Any]
+            List of properties and values in dictionary format.
+
+        Returns
+        -------
+        BaseProperties
+            Instance of the BaseProperties.
+
+        Raises
+        ------
+        TypeError
+            If input object has a wrong type.
+        """
+        if obj_dict is None:
+            return self
+
+        if not isinstance(obj_dict, Dict):
+            raise TypeError("The `obj_dict` should be a dictionary.")
+
+        for key, value in obj_dict.items():
+            # if expected type of input value is not a string, but
+            # actual type of the value is string, then try to convert value to the
+            # expected format by using JSON.loads()
+            if (
+                not value is None
+                and key in self.__annotations__
+                and self.__annotations__[key] != str
+                and isinstance(value, str)
+            ):
+                try:
+                    value = json.loads(value)
+                except:
+                    pass
+
+            self.with_prop(key, value)
+        return self
+
+    @classmethod
+    def from_dict(cls, obj_dict: Dict[str, Any]) -> "BaseProperties":
+        """Creates an instance of the properties class from a dictionary.
+
+        Parameters
+        ----------
+        obj_dict: Dict[str, Any]
+            List of properties and values in dictionary format.
+
+        Returns
+        -------
+        BaseProperties
+            Instance of the BaseProperties.
+        """
+        return cls().with_dict(obj_dict)
+
+    def with_env(self) -> "BaseProperties":
+        """Sets properties values from environment variables.
+
+        Returns
+        -------
+        BaseProperties
+            Instance of the BaseProperties.
+        """
+        self.with_dict(
+            {env_k.lower(): env_v for env_k, env_v in sorted(os.environ.items())}
+        )
+        self._adjust_with_env()
+        return self
+
+    def with_config(self, config: ConfigSection) -> "BaseProperties":
+        """Sets properties values from the config profile.
+
+        Returns
+        -------
+        BaseProperties
+            Instance of the BaseProperties.
+        """
+        if not isinstance(config, ConfigSection):
+            raise TypeError("`config` should be an instance of `ConfigSection`.")
+
+        return self.with_dict(config.to_dict())
+
+    def to_dict(self, **kwargs):
+        """Serializes instance of class into a dictionary.
+
+        Returns
+        -------
+        Dict
+            A dictionary.
+        """
+        return dataclasses.asdict(self)
+
+    def to_config(
+        self,
+        uri: str,
+        profile: str,
+        force_overwrite: Optional[bool] = False,
+        auth: Optional[Dict] = None,
+    ) -> None:
+        """Saves properties to the config file.
+
+        Parameters
+        ----------
+        uri: str
+            The URI of the config file.
+            Can be local path or OCI object storage URI.
+        profile: str
+            The config profile name.
+        force_overwrite: (bool, optional). Defaults to False.
+            Whether to overwrite existing files or not.
+        auth: (Dict, optional). Defaults to None.
+            The default authentication 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.
+
+        Returns
+        -------
+        None
+            Nothing
+        """
+        config = Config(uri=uri, auth=auth)
+        config.section_set(key=profile, info=self.to_dict(), replace=force_overwrite)
+        config.save(force_overwrite=force_overwrite)
+
+    @classmethod
+    def from_config(
+        cls,
+        uri: str,
+        profile: str,
+        auth: Optional[Dict] = None,
+    ) -> "BaseProperties":
+        """Loads properties from the config file.
+
+        Parameters
+        ----------
+        uri: str
+            The URI of the config file.
+            Can be local path or OCI object storage URI.
+        profile: str
+            The config profile name.
+        auth: (Dict, optional). Defaults to None.
+            The default authentication 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.
+
+        Returns
+        -------
+        BaseProperties
+            Instance of the BaseProperties.
+        """
+        config = Config(uri=uri, auth=auth).load()
+        return cls().with_config(config[profile])
+
+    def _adjust_with_env(self) -> None:
+        """Adjusts env variables. The method is used in `with_env` method."""
+        pass

ads/model/common/.model-ignore

@@ -0,0 +1,66 @@
+# 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/
+
+# This file captures the file names, extensions and directories to be ignored
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+
+# pyenv
+.python-version
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# mypy
+.mypy_cache
+
+# pytest
+.pytest_cache
+
+# log
+logs/
+*.log
+
+# MacOS
+.DS_Store

ads/model/common/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2020, 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/common/utils.py

@@ -0,0 +1,142 @@
+#!/usr/bin/env python
+
+# 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/
+
+import json
+import os
+import tempfile
+from typing import Any, Dict, Optional
+from zipfile import ZipFile
+
+import yaml
+
+from ads.common import utils
+from ads.common.extended_enum import ExtendedEnum
+
+DEPRECATE_AS_ONNX_WARNING = "This attribute `as_onnx` will be deprecated in the future. You can choose specific format by setting `model_save_serializer`."
+DEPRECATE_USE_TORCH_SCRIPT_WARNING = "This attribute `use_torch_script` will be deprecated in the future. You can choose specific format by setting `model_save_serializer`."
+
+
+class MetadataArtifactPathType(ExtendedEnum):
+    """
+    Enum for defining metadata artifact path type.
+    Can be either local path or OSS path. It can also be the content itself.
+    """
+
+    LOCAL = "local"
+    OSS = "oss"
+    CONTENT = "content"
+
+
+def _extract_locals(
+    locals: Dict[str, Any], filter_out_nulls: Optional[bool] = True
+) -> Dict[str, Any]:
+    """Extract arguments from local variables.
+    If input dictionary contains `kwargs`, then it will not be included to
+    the result dictionary.
+
+    Properties
+    ----------
+    locals: Dict[str, Any]
+        A dictionary, the result of `locals()` method.
+        However can be any dictionary.
+    filter_out_nulls: (bool, optional). Defaults to `True`.
+        Whether `None` values should be filtered out from the result dict or not.
+
+    Returns
+    -------
+    Dict[str, Any]
+        A new dictionary with the result values.
+    """
+    result = {}
+    keys_to_filter_out = ("kwargs",)
+    consolidated_dict = {**locals.get("kwargs", {}), **locals}
+    for key, value in consolidated_dict.items():
+        if key not in keys_to_filter_out and not (filter_out_nulls and value is None):
+            result[key] = value
+    return result
+
+
+def _is_json_serializable(data: Any) -> bool:
+    """Check is data input is json serialization.
+
+    Parameters
+    ----------
+    data: (Any)
+        data to be passed to model for prediction.
+
+    Returns
+    -------
+    bool
+        Whether data is json serializable.
+    """
+    result = True
+    try:
+        json.dumps(data)
+    except:
+        result = False
+    return result
+
+
+def fetch_manifest_from_conda_location(env_location: str):
+    """
+    Convenience method to fetch the manifest file from a conda environment.
+
+    :param env_location: Absolute path to the environment.
+    :type env_location: str
+    """
+    manifest_location = None
+    for file in os.listdir(env_location):
+        if file.endswith("_manifest.yaml"):
+            manifest_location = f"{env_location}/{file}"
+            break
+    env = {}
+    if not manifest_location:
+        raise Exception(
+            f"Could not locate manifest file in the provided conda environment: {env_location}. Dir Listing - "
+            f"{os.listdir(env_location)}"
+        )
+
+    with open(manifest_location) as mlf:
+        env = yaml.load(mlf, Loader=yaml.FullLoader)
+    manifest = env["manifest"]
+    return manifest
+
+
+def zip_artifact(artifact_dir: str) -> str:
+    """Prepares model artifacts ZIP archive.
+
+    Parameters
+    ----------
+    artifact_dir: str
+        Path to the model artifact.
+
+    Returns
+    -------
+    str
+        Path to the model artifact ZIP archive file.
+    """
+    if not artifact_dir:
+        raise ValueError("The `artifact_dir` must be provided.")
+    if not os.path.exists(artifact_dir):
+        raise ValueError(f"The {artifact_dir} not exists.")
+    if not os.path.isdir(artifact_dir):
+        raise ValueError("The `artifact_dir` must be a folder.")
+
+    files_to_upload = utils.get_files(artifact_dir)
+    # Set delete=False when creating NamedTemporaryFile,
+    # Otherwise, the file will be delete when download_artifact() close the file.
+    artifact = tempfile.NamedTemporaryFile(suffix=".zip", delete=False)
+    # Close the file since NamedTemporaryFile() opens the file by default.
+    artifact.close()
+    artifact_zip_path = artifact.name
+
+    with ZipFile(artifact_zip_path, "w") as zf:
+        for matched_file in files_to_upload:
+            zf.write(
+                os.path.join(artifact_dir, matched_file),
+                arcname=matched_file,
+            )
+
+    return artifact_zip_path