oracle-ads 2.11.9__py3-none-any.whl → 2.11.10__py3-none-any.whl

ads/aqua/extension/__init__.py

@@ -14,6 +14,7 @@ from ads.aqua.extension.evaluation_handler import __handlers__ as __eval_handler
 from ads.aqua.extension.finetune_handler import __handlers__ as __finetune_handlers__
 from ads.aqua.extension.model_handler import __handlers__ as __model_handlers__
 from ads.aqua.extension.ui_handler import __handlers__ as __ui_handlers__
+from ads.aqua.extension.ui_websocket_handler import __handlers__ as __ws_handlers__
 
 __handlers__ = (
     __finetune_handlers__
@@ -22,6 +23,7 @@ __handlers__ = (
     + __deployment_handlers__
     + __ui_handlers__
     + __eval_handlers__
+    + __ws_handlers__
 )
 
 

ads/aqua/extension/aqua_ws_msg_handler.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python
+# -*- coding: utf-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 traceback
+from abc import abstractmethod
+from http.client import responses
+from typing import List
+
+from tornado.web import HTTPError
+
+from ads.aqua import logger
+from ads.aqua.common.decorator import handle_exceptions
+from ads.aqua.extension.base_handler import AquaAPIhandler
+from ads.aqua.extension.models.ws_models import (
+    AquaWsError,
+    BaseRequest,
+    BaseResponse,
+    ErrorResponse,
+    RequestResponseType,
+)
+from ads.config import AQUA_TELEMETRY_BUCKET, AQUA_TELEMETRY_BUCKET_NS
+from ads.telemetry.client import TelemetryClient
+
+
+class AquaWSMsgHandler:
+    message: str
+
+    def __init__(self, message: str):
+        self.message = message
+        try:
+            self.telemetry = TelemetryClient(
+                bucket=AQUA_TELEMETRY_BUCKET, namespace=AQUA_TELEMETRY_BUCKET_NS
+            )
+        except:
+            pass
+
+    @staticmethod
+    @abstractmethod
+    def get_message_types() -> List[RequestResponseType]:
+        """This method should be implemented by the child class.
+        This method should return a list of RequestResponseType that the child class can handle
+        """
+        pass
+
+    @abstractmethod
+    @handle_exceptions
+    def process(self) -> BaseResponse:
+        """This method should be implemented by the child class.
+        This method will contain the core logic to be executed for handling the message
+        """
+        pass
+
+    def write_error(self, status_code, **kwargs):
+        """AquaWSMSGhandler errors are JSON, not human pages."""
+        reason = kwargs.get("reason")
+        service_payload = kwargs.get("service_payload", {})
+        default_msg = responses.get(status_code, "Unknown HTTP Error")
+        message = AquaAPIhandler.get_default_error_messages(
+            service_payload, str(status_code), kwargs.get("message", default_msg)
+        )
+        reply = {
+            "status": status_code,
+            "message": message,
+            "service_payload": service_payload,
+            "reason": reason,
+        }
+        exc_info = kwargs.get("exc_info")
+        if exc_info:
+            logger.error("".join(traceback.format_exception(*exc_info)))
+            e = exc_info[1]
+            if isinstance(e, HTTPError):
+                reply["message"] = e.log_message or message
+                reply["reason"] = e.reason
+            else:
+                logger.warning(reply["message"])
+        # telemetry may not be present if there is an error while initializing
+        if hasattr(self, "telemetry"):
+            self.telemetry.record_event_async(
+                category="aqua/error",
+                action=str(status_code),
+                value=reason,
+            )
+        response = AquaWsError(
+            status=status_code,
+            message=message,
+            service_payload=service_payload,
+            reason=reason,
+        )
+        base_message = BaseRequest.from_json(self.message, ignore_unknown=True)
+        return ErrorResponse(
+            message_id=base_message.message_id,
+            kind=RequestResponseType.Error,
+            data=response,
+        )

ads/aqua/extension/base_handler.py

@@ -137,10 +137,3 @@ class AquaAPIhandler(APIHandler):
             return messages[status_code]
         else:
             return default_msg
-
-
-# todo: remove after error handler is implemented
-class Errors(str):
-    INVALID_INPUT_DATA_FORMAT = "Invalid format of input data."
-    NO_INPUT_DATA = "No input data provided."
-    MISSING_REQUIRED_PARAMETER = "Missing required parameter: '{}'"

ads/aqua/extension/common_handler.py

@@ -6,11 +6,15 @@
 
 from importlib import metadata
 
+import requests
+from tornado.web import HTTPError
+
 from ads.aqua import ODSC_MODEL_COMPARTMENT_OCID
-from ads.aqua.decorator import handle_exceptions
-from ads.aqua.exception import AquaResourceAccessError
+from ads.aqua.common.decorator import handle_exceptions
+from ads.aqua.common.errors import AquaResourceAccessError, AquaRuntimeError
+from ads.aqua.common.utils import fetch_service_compartment, known_realm
 from ads.aqua.extension.base_handler import AquaAPIhandler
-from ads.aqua.utils import known_realm, fetch_service_compartment
+from ads.aqua.extension.errors import Errors
 
 
 class ADSVersionHandler(AquaAPIhandler):
@@ -33,9 +37,11 @@ class CompatibilityCheckHandler(AquaAPIhandler):
 
         Returns
         -------
-            status dict:
-                ok or compatible
-        Raises:
+        status dict:
+            ok or compatible
+
+        Raises
+        ------
             AquaResourceAccessError: raised when aqua is not accessible in the given session/region.
 
         """

ads/aqua/extension/deployment_handler.py

@@ -7,9 +7,11 @@ from urllib.parse import urlparse
 
 from tornado.web import HTTPError
 
-from ads.aqua.decorator import handle_exceptions
-from ads.aqua.deployment import AquaDeploymentApp, MDInferenceResponse, ModelParams
-from ads.aqua.extension.base_handler import AquaAPIhandler, Errors
+from ads.aqua.common.decorator import handle_exceptions
+from ads.aqua.extension.errors import Errors
+from ads.aqua.extension.base_handler import AquaAPIhandler
+from ads.aqua.modeldeployment import AquaDeploymentApp, MDInferenceResponse
+from ads.aqua.modeldeployment.entities import ModelParams
 from ads.config import COMPARTMENT_OCID, PROJECT_OCID
 
 
@@ -93,6 +95,11 @@ class AquaDeploymentHandler(AquaAPIhandler):
         description = input_data.get("description")
         instance_count = input_data.get("instance_count")
         bandwidth_mbps = input_data.get("bandwidth_mbps")
+        web_concurrency = input_data.get("web_concurrency")
+        server_port = input_data.get("server_port")
+        health_check_port = input_data.get("health_check_port")
+        env_var = input_data.get("env_var")
+        container_family = input_data.get("container_family")
 
         self.finish(
             AquaDeploymentApp().create(
@@ -107,6 +114,11 @@ class AquaDeploymentHandler(AquaAPIhandler):
                 access_log_id=access_log_id,
                 predict_log_id=predict_log_id,
                 bandwidth_mbps=bandwidth_mbps,
+                web_concurrency=web_concurrency,
+                server_port=server_port,
+                health_check_port=health_check_port,
+                env_var=env_var,
+                container_family=container_family,
             )
         )
 
@@ -192,8 +204,62 @@ class AquaDeploymentInferenceHandler(AquaAPIhandler):
         )
 
 
+class AquaDeploymentParamsHandler(AquaAPIhandler):
+    """Handler for Aqua deployment params REST APIs.
+
+    Methods
+    -------
+    get(self, model_id)
+        Retrieves a list of model deployment parameters.
+    post(self, *args, **kwargs)
+        Validates parameters for the given model id.
+    """
+
+    @handle_exceptions
+    def get(self, model_id):
+        """Handle GET request."""
+        instance_shape = self.get_argument("instance_shape")
+        return self.finish(
+            AquaDeploymentApp().get_deployment_default_params(
+                model_id=model_id, instance_shape=instance_shape
+            )
+        )
+
+    @handle_exceptions
+    def post(self, *args, **kwargs):
+        """Handles post request for the deployment param handler API.
+
+        Raises
+        ------
+        HTTPError
+            Raises HTTPError if inputs are missing or are invalid.
+        """
+        try:
+            input_data = self.get_json_body()
+        except Exception:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+
+        if not input_data:
+            raise HTTPError(400, Errors.NO_INPUT_DATA)
+
+        model_id = input_data.get("model_id")
+        if not model_id:
+            raise HTTPError(400, Errors.MISSING_REQUIRED_PARAMETER.format("model_id"))
+
+        params = input_data.get("params")
+        container_family = input_data.get("container_family")
+        return self.finish(
+            AquaDeploymentApp().validate_deployment_params(
+                model_id=model_id,
+                params=params,
+                container_family=container_family,
+            )
+        )
+
+
 __handlers__ = [
-    ("deployments/?([^/]*)", AquaDeploymentHandler),
+    ("deployments/?([^/]*)/params", AquaDeploymentParamsHandler),
     ("deployments/config/?([^/]*)", AquaDeploymentHandler),
+    ("deployments/?([^/]*)", AquaDeploymentHandler),
     ("inference", AquaDeploymentInferenceHandler),
 ]

ads/aqua/extension/errors.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+# -*- coding: utf-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/
+
+
+class Errors(str):
+    INVALID_INPUT_DATA_FORMAT = "Invalid format of input data."
+    NO_INPUT_DATA = "No input data provided."
+    MISSING_REQUIRED_PARAMETER = "Missing required parameter: '{}'"

ads/aqua/extension/evaluation_handler.py

@@ -7,9 +7,11 @@ from urllib.parse import urlparse
 
 from tornado.web import HTTPError
 
-from ads.aqua.decorator import handle_exceptions
-from ads.aqua.evaluation import AquaEvaluationApp, CreateAquaEvaluationDetails
-from ads.aqua.extension.base_handler import AquaAPIhandler, Errors
+from ads.aqua.common.decorator import handle_exceptions
+from ads.aqua.evaluation import AquaEvaluationApp
+from ads.aqua.evaluation.entities import CreateAquaEvaluationDetails
+from ads.aqua.extension.errors import Errors
+from ads.aqua.extension.base_handler import AquaAPIhandler
 from ads.aqua.extension.utils import validate_function_parameters
 from ads.config import COMPARTMENT_OCID
 

ads/aqua/extension/evaluation_ws_msg_handler.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+# -*- coding: utf-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/
+
+from typing import List, Union
+
+from tornado.web import HTTPError
+
+from ads.aqua.common.decorator import handle_exceptions
+from ads.aqua.evaluation import AquaEvaluationApp
+from ads.aqua.extension.aqua_ws_msg_handler import AquaWSMsgHandler
+from ads.aqua.extension.models.ws_models import (
+    ListEvaluationsRequest,
+    ListEvaluationsResponse,
+    RequestResponseType,
+)
+from ads.config import COMPARTMENT_OCID
+
+
+class AquaEvaluationWSMsgHandler(AquaWSMsgHandler):
+    @staticmethod
+    def get_message_types() -> List[RequestResponseType]:
+        return [RequestResponseType.ListEvaluations]
+
+    def __init__(self, message: Union[str, bytes]):
+        super().__init__(message)
+
+    @handle_exceptions
+    def process(self) -> ListEvaluationsResponse:
+        list_eval_request = ListEvaluationsRequest.from_json(self.message)
+
+        eval_list = AquaEvaluationApp().list(
+            list_eval_request.compartment_id or COMPARTMENT_OCID,
+            list_eval_request.project_id,
+        )
+        response = ListEvaluationsResponse(
+            message_id=list_eval_request.message_id,
+            kind=RequestResponseType.ListEvaluations,
+            data=eval_list,
+        )
+        return response

ads/aqua/extension/finetune_handler.py

@@ -8,10 +8,12 @@ from urllib.parse import urlparse
 
 from tornado.web import HTTPError
 
-from ads.aqua.decorator import handle_exceptions
-from ads.aqua.extension.base_handler import AquaAPIhandler, Errors
+from ads.aqua.common.decorator import handle_exceptions
+from ads.aqua.extension.errors import Errors
+from ads.aqua.extension.base_handler import AquaAPIhandler
 from ads.aqua.extension.utils import validate_function_parameters
-from ads.aqua.finetune import AquaFineTuningApp, CreateFineTuningDetails
+from ads.aqua.finetuning import AquaFineTuningApp
+from ads.aqua.finetuning.entities import CreateFineTuningDetails
 
 
 class AquaFineTuneHandler(AquaAPIhandler):
@@ -59,7 +61,43 @@ class AquaFineTuneHandler(AquaAPIhandler):
         return self.finish(AquaFineTuningApp().get_finetuning_config(model_id=model_id))
 
 
+class AquaFineTuneParamsHandler(AquaAPIhandler):
+    """Handler for Aqua finetuning params REST APIs."""
+
+    @handle_exceptions
+    def get(self, model_id):
+        """Handle GET request."""
+        return self.finish(
+            AquaFineTuningApp().get_finetuning_default_params(model_id=model_id)
+        )
+
+    @handle_exceptions
+    def post(self, *args, **kwargs):
+        """Handles post request for the finetuning param handler API.
+
+        Raises
+        ------
+        HTTPError
+            Raises HTTPError if inputs are missing or are invalid.
+        """
+        try:
+            input_data = self.get_json_body()
+        except Exception:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+
+        if not input_data:
+            raise HTTPError(400, Errors.NO_INPUT_DATA)
+
+        params = input_data.get("params", None)
+        return self.finish(
+            AquaFineTuningApp().validate_finetuning_params(
+                params=params,
+            )
+        )
+
+
 __handlers__ = [
+    ("finetuning/?([^/]*)/params", AquaFineTuneParamsHandler),
     ("finetuning/?([^/]*)", AquaFineTuneHandler),
     ("finetuning/config/?([^/]*)", AquaFineTuneHandler),
 ]

ads/aqua/extension/model_handler.py

@@ -3,11 +3,13 @@
 # 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 re
+from typing import Optional
 from urllib.parse import urlparse
 
 from tornado.web import HTTPError
-
-from ads.aqua.decorator import handle_exceptions
+from ads.aqua.extension.errors import Errors
+from ads.aqua.common.decorator import handle_exceptions
 from ads.aqua.extension.base_handler import AquaAPIhandler
 from ads.aqua.model import AquaModelApp
 
@@ -41,7 +43,56 @@ class AquaModelHandler(AquaAPIhandler):
         compartment_id = self.get_argument("compartment_id", default=None)
         # project_id is no needed.
         project_id = self.get_argument("project_id", default=None)
-        return self.finish(AquaModelApp().list(compartment_id, project_id))
+        model_type = self.get_argument("model_type", default=None)
+        return self.finish(
+            AquaModelApp().list(
+                compartment_id=compartment_id,
+                project_id=project_id,
+                model_type=model_type,
+            )
+        )
+
+    @handle_exceptions
+    def post(self, *args, **kwargs):
+        """
+        Handles post request for the registering any Aqua model.
+        Raises
+        ------
+        HTTPError
+            Raises HTTPError if inputs are missing or are invalid
+        """
+        try:
+            input_data = self.get_json_body()
+        except Exception:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+
+        if not input_data:
+            raise HTTPError(400, Errors.NO_INPUT_DATA)
+
+        # required input parameters
+        model = input_data.get("model")
+        if not model:
+            raise HTTPError(400, Errors.MISSING_REQUIRED_PARAMETER.format("model"))
+        os_path = input_data.get("os_path")
+        if not os_path:
+            raise HTTPError(400, Errors.MISSING_REQUIRED_PARAMETER.format("os_path"))
+
+        inference_container = input_data.get("inference_container")
+        finetuning_container = input_data.get("finetuning_container")
+        compartment_id = input_data.get("compartment_id")
+        project_id = input_data.get("project_id")
+
+        return self.finish(
+            AquaModelApp().register(
+                model=model,
+                os_path=os_path,
+                inference_container=inference_container,
+                finetuning_container=finetuning_container,
+                compartment_id=compartment_id,
+                project_id=project_id,
+            )
+        )
+
 
 class AquaModelLicenseHandler(AquaAPIhandler):
     """Handler for Aqua Model license REST APIs."""
@@ -49,10 +100,11 @@ class AquaModelLicenseHandler(AquaAPIhandler):
     @handle_exceptions
     def get(self, model_id):
         """Handle GET request."""
-        
+
         model_id = model_id.split("/")[0]
         return self.finish(AquaModelApp().load_license(model_id))
 
+
 __handlers__ = [
     ("model/?([^/]*)", AquaModelHandler),
     ("model/?([^/]*)/license", AquaModelLicenseHandler),

ads/aqua/extension/models/ws_models.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python
+# -*- coding: utf-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/
+
+from dataclasses import dataclass
+from typing import List, Optional
+
+from ads.aqua.evaluation.entities import AquaEvaluationSummary
+from ads.aqua.model.entities import AquaModelSummary
+from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.serializer import DataClassSerializable
+
+
+class RequestResponseType(str, metaclass=ExtendedEnumMeta):
+    ListEvaluations = "ListEvaluations"
+    ListModels = "ListModels"
+    Error = "Error"
+
+
+@dataclass
+class BaseResponse(DataClassSerializable):
+    message_id: str
+    kind: RequestResponseType
+    data: object
+
+
+@dataclass
+class BaseRequest(DataClassSerializable):
+    message_id: str
+    kind: RequestResponseType
+
+
+@dataclass
+class ListEvaluationsRequest(BaseRequest):
+    compartment_id: Optional[str] = None
+    limit: Optional[int] = None
+    project_id: Optional[str] = None
+    kind = RequestResponseType.ListEvaluations
+
+
+@dataclass
+class ListModelsRequest(BaseRequest):
+    compartment_id: Optional[str] = None
+
+
+@dataclass
+class ListEvaluationsResponse(BaseResponse):
+    data: List[AquaEvaluationSummary]
+
+
+@dataclass
+class ListModelsResponse(BaseResponse):
+    data: List[AquaModelSummary]
+
+
+@dataclass
+class AquaWsError(DataClassSerializable):
+    status: str
+    message: str
+    service_payload: Optional[dict]
+    reason: Optional[str]
+
+
+@dataclass
+class ErrorResponse(BaseResponse):
+    data: AquaWsError
+    kind = RequestResponseType.Error

ads/aqua/extension/ui_handler.py

@@ -3,17 +3,30 @@
 # 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/
 
+from dataclasses import dataclass
 from urllib.parse import urlparse
 
 from tornado.web import HTTPError
 
-from ads.aqua.data import Tags
-from ads.aqua.decorator import handle_exceptions
+from ads.aqua.common.decorator import handle_exceptions
+from ads.aqua.common.enums import Tags
+from ads.aqua.extension.errors import Errors
 from ads.aqua.extension.base_handler import AquaAPIhandler
+from ads.aqua.extension.utils import validate_function_parameters
+from ads.aqua.model.entities import ImportModelDetails
 from ads.aqua.ui import AquaUIApp
 from ads.config import COMPARTMENT_OCID
 
 
+@dataclass
+class CLIDetails:
+    """Interface to capture payload and command details for generating ads cli command"""
+
+    command: str
+    subcommand: str
+    payload: dict
+
+
 class AquaUIHandler(AquaAPIhandler):
     """
     Handler for Aqua UI REST APIs.
@@ -63,6 +76,8 @@ class AquaUIHandler(AquaAPIhandler):
             return self.get_shape_availability()
         elif paths.startswith("aqua/bucket/versioning"):
             return self.is_bucket_versioned()
+        elif paths.startswith("aqua/containers"):
+            return self.list_containers()
         else:
             raise HTTPError(400, f"The request {self.request.path} is invalid.")
 
@@ -92,6 +107,10 @@ class AquaUIHandler(AquaAPIhandler):
         """Lists the compartments in a compartment specified by ODSC_MODEL_COMPARTMENT_OCID env variable."""
         return self.finish(AquaUIApp().list_compartments())
 
+    def list_containers(self):
+        """Lists the AQUA containers."""
+        return self.finish(AquaUIApp().list_containers())
+
     def get_default_compartment(self):
         """Returns user compartment ocid."""
         return self.finish(AquaUIApp().get_default_compartment())
@@ -103,7 +122,7 @@ class AquaUIHandler(AquaAPIhandler):
         return self.finish(
             AquaUIApp().list_model_version_sets(
                 compartment_id=compartment_id,
-                target_tag=Tags.AQUA_FINE_TUNING.value,
+                target_tag=Tags.AQUA_FINE_TUNING,
                 **kwargs,
             )
         )
@@ -115,7 +134,7 @@ class AquaUIHandler(AquaAPIhandler):
         return self.finish(
             AquaUIApp().list_model_version_sets(
                 compartment_id=compartment_id,
-                target_tag=Tags.AQUA_EVALUATION.value,
+                target_tag=Tags.AQUA_EVALUATION,
                 **kwargs,
             )
         )
@@ -175,6 +194,46 @@ class AquaUIHandler(AquaAPIhandler):
         return self.finish(AquaUIApp().is_bucket_versioned(bucket_uri=bucket_uri))
 
 
+class AquaCLIHandler(AquaAPIhandler):
+    """Handler for Aqua model import
+    command_interface_map is a map of command+subcommand to corresponding API dataclas.
+    Eg. In command `ads aqua model register ....`, command is `model` and subcommand is `register`
+    The key in the map will be f"{command}_{sub_command}" and value will be a DataClass
+    """
+
+    command_interface_map = {"model_register": ImportModelDetails}
+
+    @handle_exceptions
+    def post(self, *args, **kwargs):
+        """Handles cli command construction
+
+        Raises
+        ------
+        HTTPError
+            Raises HTTPError if inputs are missing or are invalid.
+        """
+        try:
+            input_data = self.get_json_body()
+        except Exception:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+
+        if not input_data:
+            raise HTTPError(400, Errors.NO_INPUT_DATA)
+
+        validate_function_parameters(data_class=CLIDetails, input_data=input_data)
+        command_details = CLIDetails(**input_data)
+
+        interface = AquaCLIHandler.command_interface_map[
+            f"{command_details.command}_{command_details.subcommand}"
+        ]
+
+        validate_function_parameters(
+            data_class=interface, input_data=command_details.payload
+        )
+        payload = interface(**command_details.payload)
+        self.finish({"command": payload.build_cli()})
+
+
 __handlers__ = [
     ("logging/?([^/]*)", AquaUIHandler),
     ("compartments/?([^/]*)", AquaUIHandler),
@@ -187,4 +246,6 @@ __handlers__ = [
     ("subnets/?([^/]*)", AquaUIHandler),
     ("shapes/limit/?([^/]*)", AquaUIHandler),
     ("bucket/versioning/?([^/]*)", AquaUIHandler),
+    ("containers/?([^/]*)", AquaUIHandler),
+    ("cli/?([^/]*)", AquaCLIHandler),
 ]