oracle-ads 2.13.8__py3-none-any.whl → 2.13.9rc0__py3-none-any.whl

ads/opctl/backend/ads_ml_pipeline.py

@@ -1,164 +0,0 @@
-#!/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 Dict, Union
-from ads.common.auth import create_signer, AuthContext
-from ads.common.oci_client import OCIClientFactory
-from ads.opctl.backend.base import Backend
-from ads.opctl.backend.ads_ml_job import JobRuntimeFactory
-from ads.opctl.decorator.common import print_watch_command
-from ads.pipeline import Pipeline, PipelineRun, PipelineStep, CustomScriptStep
-
-from ads.jobs import PythonRuntime
-
-
-class PipelineBackend(Backend):
-    def __init__(self, config: Dict) -> None:
-        """
-        Initialize a MLPipeline object given config dictionary.
-
-        Parameters
-        ----------
-        config: dict
-            dictionary of configurations
-        """
-        self.config = config
-        self.oci_auth = create_signer(
-            config["execution"].get("auth"),
-            config["execution"].get("oci_config", None),
-            config["execution"].get("oci_profile", None),
-        )
-        self.auth_type = config["execution"].get("auth")
-        self.profile = config["execution"].get("oci_profile", None)
-        self.client = OCIClientFactory(**self.oci_auth).data_science
-
-    @print_watch_command
-    def apply(self) -> Dict:
-        """
-        Create Pipeline and Pipeline Run from YAML.
-        """
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            pipeline = Pipeline.from_dict(self.config)
-            pipeline.create()
-            pipeline_run = pipeline.run()
-            print("PIPELINE OCID:", pipeline.id)
-            print("PIPELINE RUN OCID:", pipeline_run.id)
-            return {"job_id": pipeline.id, "run_id": pipeline_run.id}
-
-    @print_watch_command
-    def run(self) -> Dict:
-        """
-        Create Pipeline and Pipeline Run from OCID.
-        """
-        pipeline_id = self.config["execution"]["ocid"]
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            pipeline = Pipeline.from_ocid(ocid=pipeline_id)
-            pipeline_run = pipeline.run()
-            print("PIPELINE OCID:", pipeline.id)
-            print("PIPELINE RUN OCID:", pipeline_run.id)
-            return {"job_id": pipeline.id, "run_id": pipeline_run.id}
-
-    def delete(self) -> None:
-        """
-        Delete Pipeline or Pipeline Run from OCID.
-        """
-        if self.config["execution"].get("id"):
-            pipeline_id = self.config["execution"]["id"]
-            with AuthContext(auth=self.auth_type, profile=self.profile):
-                Pipeline.from_ocid(pipeline_id).delete()
-                print(f"Pipeline {pipeline_id} has been deleted.")
-        elif self.config["execution"].get("run_id"):
-            run_id = self.config["execution"]["run_id"]
-            with AuthContext(auth=self.auth_type, profile=self.profile):
-                PipelineRun.from_ocid(run_id).delete()
-                print(f"Pipeline run {run_id} has been deleted.")
-
-    def cancel(self) -> None:
-        """
-        Cancel Pipeline Run from OCID.
-        """
-        run_id = self.config["execution"]["run_id"]
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            PipelineRun.from_ocid(run_id).cancel()
-            print(f"Pipeline run {run_id} has been cancelled.")
-
-    def watch(self) -> None:
-        """
-        Watch Pipeline Run from OCID.
-        """
-        run_id = self.config["execution"]["run_id"]
-        log_type = self.config["execution"].get("log_type")
-        interval = self.config["execution"].get("interval")
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            PipelineRun.from_ocid(run_id).watch(
-                interval=interval,
-                log_type=log_type
-            )
-
-    def init(
-        self,
-        uri: Union[str, None] = None,
-        overwrite: bool = False,
-        runtime_type: Union[str, None] = None,
-        **kwargs: Dict,
-    ) -> Union[str, None]:
-        """Generates a starter YAML specification for an MLPipeline.
-
-        Parameters
-        ----------
-        overwrite: (bool, optional). Defaults to False.
-            Overwrites the result specification YAML if exists.
-        uri: (str, optional), Defaults to None.
-            The filename to save the resulting specification template YAML.
-        runtime_type: (str, optional). Defaults to None.
-                The resource runtime type.
-        **kwargs: Dict
-            The optional arguments.
-
-        Returns
-        -------
-        Union[str, None]
-            The YAML specification for the given resource if `uri` was not provided.
-            `None` otherwise.
-        """
-
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            # define a pipeline step
-            pipeline_step = (
-                PipelineStep("pipeline_step_name_1")
-                .with_description("A step running a python script")
-                .with_infrastructure(CustomScriptStep().init())
-                .with_runtime(
-                    JobRuntimeFactory.get_runtime(
-                        key=runtime_type or PythonRuntime().type
-                    ).init()
-                )
-            )
-
-            # define a pipeline
-            pipeline = (
-                Pipeline(
-                    name="Pipeline Name",
-                    spec=(self.config.get("infrastructure", {}) or {}),
-                )
-                .with_step_details([pipeline_step])
-                .with_dag(["pipeline_step_name_1"])
-                .init()
-            )
-
-            note = (
-                "# This YAML specification was auto generated by the `ads opctl init` command.\n"
-                "# The more details about the jobs YAML specification can be found in the ADS documentation:\n"
-                "# https://accelerated-data-science.readthedocs.io/en/latest/user_guide/pipeline/quick_start.html \n\n"
-            )
-
-            return pipeline.to_yaml(
-                uri=uri,
-                overwrite=overwrite,
-                note=note,
-                filter_by_attribute_map=True,
-                **kwargs,
-            )

ads/opctl/backend/ads_model_deployment.py

@@ -1,209 +0,0 @@
-#!/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/
-
-import json
-from typing import Dict, Union
-from ads.common.auth import AuthContext, create_signer
-from ads.common.oci_client import OCIClientFactory
-from ads.model.deployment import ModelDeployment, ModelDeploymentInfrastructure
-from ads.model.deployment.model_deployment_runtime import (
-    ModelDeploymentCondaRuntime,
-    ModelDeploymentContainerRuntime,
-)
-from ads.opctl.backend.base import Backend, RuntimeFactory
-
-
-class ModelDeploymentBackend(Backend):
-    def __init__(self, config: Dict) -> None:
-        """
-        Initialize a ModelDeployment object given config dictionary.
-
-        Parameters
-        ----------
-        config: dict
-            dictionary of configurations
-        """
-        self.config = config
-        self.oci_auth = create_signer(
-            config["execution"].get("auth"),
-            config["execution"].get("oci_config", None),
-            config["execution"].get("oci_profile", None),
-        )
-        self.auth_type = config["execution"].get("auth")
-        self.profile = config["execution"].get("oci_profile", None)
-        self.client = OCIClientFactory(**self.oci_auth).data_science
-
-    def init(
-        self,
-        uri: Union[str, None] = None,
-        overwrite: bool = False,
-        runtime_type: Union[str, None] = None,
-        **kwargs: Dict,
-    ) -> Union[str, None]:
-        """Generates a starter YAML specification for a Data Science Job.
-
-        Parameters
-        ----------
-        overwrite: (bool, optional). Defaults to False.
-            Overwrites the result specification YAML if exists.
-        uri: (str, optional), Defaults to None.
-            The filename to save the resulting specification template YAML.
-        runtime_type: (str, optional). Defaults to None.
-                The resource runtime type.
-        **kwargs: Dict
-            The optional arguments.
-
-        Returns
-        -------
-        Union[str, None]
-            The YAML specification for the given resource if `uri` was not provided.
-            `None` otherwise.
-        """
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            # define a job
-            object = (
-                ModelDeployment()
-                .with_display_name("Model Deployment")
-                .with_description("The model deployment description")
-                .with_freeform_tags(key1="value1")
-                .with_infrastructure(
-                    ModelDeploymentInfrastructure(
-                        **(self.config.get("infrastructure", {}) or {})
-                    ).init()
-                )
-                .with_runtime(
-                    ModelDeploymentRuntimeFactory.get_runtime(
-                        key=runtime_type or ModelDeploymentCondaRuntime().type
-                    ).init()
-                )
-            )
-
-            note = (
-                "# This YAML specification was auto generated by the `ads opctl init` command.\n"
-                "# The more details about the jobs YAML specification can be found in the ADS documentation:\n"
-                "# https://accelerated-data-science.readthedocs.io/en/latest/user_guide/model_registration/model_deploy_byoc.html \n\n"
-            )
-
-            return object.to_yaml(
-                uri=uri,
-                overwrite=overwrite,
-                note=note,
-                filter_by_attribute_map=True,
-                **kwargs,
-            )
-
-    def apply(self) -> None:
-        """
-        Deploy model deployment from YAML.
-        """
-        wait_for_completion = self.config["execution"].get("wait_for_completion")
-        max_wait_time = self.config["execution"].get("max_wait_time")
-        poll_interval = self.config["execution"].get("poll_interval")
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            model_deployment = ModelDeployment.from_dict(self.config)
-            model_deployment.deploy(
-                wait_for_completion=wait_for_completion,
-                max_wait_time=max_wait_time,
-                poll_interval=poll_interval,
-            )
-            print("Model Deployment id: ", model_deployment.model_deployment_id)
-
-    def delete(self) -> None:
-        """
-        Delete model deployment from OCID.
-        """
-        model_deployment_id = self.config["execution"].get("run_id")
-        wait_for_completion = self.config["execution"].get("wait_for_completion")
-        max_wait_time = self.config["execution"].get("max_wait_time")
-        poll_interval = self.config["execution"].get("poll_interval")
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            model_deployment = ModelDeployment.from_id(model_deployment_id)
-            model_deployment.delete(
-                wait_for_completion=wait_for_completion,
-                max_wait_time=max_wait_time,
-                poll_interval=poll_interval,
-            )
-            print(
-                f"Model Deployment {model_deployment.model_deployment_id} has been deleted."
-            )
-
-    def activate(self) -> None:
-        """
-        Activate model deployment from OCID.
-        """
-        model_deployment_id = self.config["execution"].get("run_id")
-        wait_for_completion = self.config["execution"].get("wait_for_completion")
-        max_wait_time = self.config["execution"].get("max_wait_time")
-        poll_interval = self.config["execution"].get("poll_interval")
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            model_deployment = ModelDeployment.from_id(model_deployment_id)
-            model_deployment.activate(
-                wait_for_completion=wait_for_completion,
-                max_wait_time=max_wait_time,
-                poll_interval=poll_interval,
-            )
-            print(
-                f"Model Deployment {model_deployment.model_deployment_id} has been activated."
-            )
-
-    def deactivate(self) -> None:
-        """
-        Deactivate model deployment from OCID.
-        """
-        model_deployment_id = self.config["execution"].get("run_id")
-        wait_for_completion = self.config["execution"].get("wait_for_completion")
-        max_wait_time = self.config["execution"].get("max_wait_time")
-        poll_interval = self.config["execution"].get("poll_interval")
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            model_deployment = ModelDeployment.from_id(model_deployment_id)
-            model_deployment.deactivate(
-                wait_for_completion=wait_for_completion,
-                max_wait_time=max_wait_time,
-                poll_interval=poll_interval,
-            )
-            print(
-                f"Model Deployment {model_deployment.model_deployment_id} has been deactivated."
-            )
-
-    def watch(self) -> None:
-        """
-        Watch Model Deployment from OCID.
-        """
-        model_deployment_id = self.config["execution"].get("run_id")
-        log_type = self.config["execution"].get("log_type")
-        interval = self.config["execution"].get("interval")
-        log_filter = self.config["execution"].get("log_filter")
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            model_deployment = ModelDeployment.from_id(model_deployment_id)
-            model_deployment.watch(
-                log_type=log_type, interval=interval, log_filter=log_filter
-            )
-
-    def predict(self) -> None:
-        ocid = self.config["execution"].get("ocid")
-        data = self.config["execution"].get("payload")
-        model_name = self.config["execution"].get("model_name")
-        model_version = self.config["execution"].get("model_version")
-        with AuthContext(auth=self.auth_type, profile=self.profile):
-            model_deployment = ModelDeployment.from_id(ocid)
-            try:
-                data = json.loads(data)
-            except:
-                pass
-            print(
-                model_deployment.predict(
-                    data=data, model_name=model_name, model_version=model_version
-                )
-            )
-
-
-class ModelDeploymentRuntimeFactory(RuntimeFactory):
-    """Mode Deployment runtime factory."""
-
-    _MAP = {
-        ModelDeploymentCondaRuntime().type: ModelDeploymentCondaRuntime,
-        ModelDeploymentContainerRuntime().type: ModelDeploymentContainerRuntime,
-    }

ads/opctl/backend/base.py

@@ -1,146 +0,0 @@
-#!/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 abc import abstractmethod
-from typing import Dict, Union
-
-
-class UnsupportedRuntime(Exception):
-    def __init__(self, runtime_type: str):
-        super().__init__(
-            f"The provided runtime: `{runtime_type}` "
-            "is not supported by given resource."
-        )
-
-
-class Backend:
-    """Interface for backend"""
-
-    def __init__(self, config: Dict) -> None:
-        self.config = config
-        self.auth_type = config["execution"].get("auth", "api_key")
-        self.profile = config["execution"].get("oci_profile", None)
-        self.oci_config = config["execution"].get("oci_config", None)
-
-    @abstractmethod
-    def run(self) -> Dict:
-        """
-        Initiate a run.
-
-        Returns
-        -------
-        Dict
-        """
-
-    def delete(self) -> None:
-        """
-        Delete a remote run.
-
-        Returns
-        -------
-        None
-        """
-
-    def watch(self) -> None:
-        """
-        Stream logs from a remote run.
-
-        Returns
-        -------
-        None
-        """
-
-    def cancel(self) -> None:
-        """
-        Cancel a remote run.
-
-        Returns
-        -------
-        None
-        """
-
-    def apply(self) -> Dict:
-        """
-        Initiate Data Science service from YAML.
-
-        Returns
-        -------
-        Dict
-        """
-
-    def activate(self) -> None:
-        """
-        Activate a remote service.
-
-        Returns
-        -------
-        None
-        """
-        raise NotImplementedError("`activate` has not been implemented yet.")
-
-    def deactivate(self) -> None:
-        """
-        Deactivate a remote service.
-
-        Returns
-        -------
-        None
-        """
-        raise NotImplementedError("`deactivate` has not been implemented yet.")
-
-    def run_diagnostics(self):
-        """
-        Implement Diagnostics check appropriate for the backend
-        """
-
-    def init(
-        self, uri: Union[str, None] = None, overwrite: bool = False, **kwargs: Dict
-    ) -> Union[str, None]:
-        """Generates a YAML specification for the resource.
-
-        Parameters
-        ----------
-        overwrite: (bool, optional). Defaults to False.
-            Overwrites the result specification YAML if exists.
-        uri: (str, optional)
-            The filename to save the resulting specification template YAML.
-        **kwargs: Dict
-            The optional arguments.
-
-            runtime_type: str
-                The resource runtime type.
-
-        Returns
-        -------
-        Union[str, None]
-            The YAML specification for the given resource if `uri` was not provided.
-            `None` otherwise.
-        """
-        raise NotImplementedError(
-            "The `init` has not been implemented yet for the given resource."
-        )
-
-    def predict(self) -> None:
-        """
-        Run model predict.
-
-        Returns
-        -------
-        None
-        """
-        raise NotImplementedError("`predict` has not been implemented yet.")
-
-
-class RuntimeFactory:
-    """Base factory for runtime."""
-
-    _MAP = {}
-
-    @classmethod
-    def get_runtime(cls, key: str, *args, **kwargs):
-        if key not in cls._MAP:
-            raise UnsupportedRuntime(key)
-        return cls._MAP[key](*args, **kwargs)