oracle-ads 2.10.0__py3-none-any.whl → 2.11.0__py3-none-any.whl

ads/aqua/extension/model_handler.py

@@ -0,0 +1,59 @@
+#!/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 urllib.parse import urlparse
+
+from tornado.web import HTTPError
+
+from ads.aqua.decorator import handle_exceptions
+from ads.aqua.extension.base_handler import AquaAPIhandler
+from ads.aqua.model import AquaModelApp
+
+
+class AquaModelHandler(AquaAPIhandler):
+    """Handler for Aqua Model REST APIs."""
+
+    @handle_exceptions
+    def get(self, model_id=""):
+        """Handle GET request."""
+        if not model_id:
+            return self.list()
+        return self.read(model_id)
+
+    def read(self, model_id):
+        """Read the information of an Aqua model."""
+        return self.finish(AquaModelApp().get(model_id))
+
+    @handle_exceptions
+    def delete(self, id=""):
+        """Handles DELETE request for clearing cache"""
+        url_parse = urlparse(self.request.path)
+        paths = url_parse.path.strip("/")
+        if paths.startswith("aqua/model/cache"):
+            return self.finish(AquaModelApp().clear_model_list_cache())
+        else:
+            raise HTTPError(400, f"The request {self.request.path} is invalid.")
+
+    def list(self):
+        """List Aqua models."""
+        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))
+
+class AquaModelLicenseHandler(AquaAPIhandler):
+    """Handler for Aqua Model license REST APIs."""
+
+    @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/ui_handler.py

@@ -0,0 +1,201 @@
+#!/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 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.extension.base_handler import AquaAPIhandler
+from ads.aqua.ui import AquaUIApp
+from ads.config import COMPARTMENT_OCID
+
+
+class AquaUIHandler(AquaAPIhandler):
+    """
+    Handler for Aqua UI REST APIs.
+
+    Methods
+    -------
+    get(self, id="")
+        Routes the request to fetch log groups, log ids details or compartments
+    list_log_groups(self, id: str)
+        Reads the AQUA deployment information.
+    list_logs(self, log_group_id: str, **kwargs)
+        Lists the specified log group's log objects.
+    list_compartments(self, **kwargs)
+        Lists the compartments in a compartment specified by ODSC_MODEL_COMPARTMENT_OCID env variable.
+
+    Raises
+    ------
+    HTTPError: For various failure scenarios such as invalid input format, missing data, etc.
+    """
+
+    def get(self, id=""):
+        """Handle GET request."""
+        url_parse = urlparse(self.request.path)
+        paths = url_parse.path.strip("/")
+        if paths.startswith("aqua/logging"):
+            if not id:
+                return self.list_log_groups()
+            return self.list_logs(id)
+        elif paths.startswith("aqua/compartments/default"):
+            return self.get_default_compartment()
+        elif paths.startswith("aqua/compartments"):
+            return self.list_compartments()
+        elif paths.startswith("aqua/experiment"):
+            return self.list_experiments()
+        elif paths.startswith("aqua/versionsets"):
+            return self.list_model_version_sets()
+        elif paths.startswith("aqua/buckets"):
+            return self.list_buckets()
+        elif paths.startswith("aqua/job/shapes"):
+            return self.list_job_shapes()
+        elif paths.startswith("aqua/vcn"):
+            return self.list_vcn()
+        elif paths.startswith("aqua/subnets"):
+            return self.list_subnets()
+        elif paths.startswith("aqua/shapes/limit"):
+            return self.get_shape_availability()
+        elif paths.startswith("aqua/bucket/versioning"):
+            return self.is_bucket_versioned()
+        else:
+            raise HTTPError(400, f"The request {self.request.path} is invalid.")
+
+    @handle_exceptions
+    def delete(self, id=""):
+        """Handles DELETE request for clearing cache"""
+        # todo: added for dev work, to be deleted if there's no feature to refresh cache in Aqua
+        url_parse = urlparse(self.request.path)
+        paths = url_parse.path.strip("/")
+        if paths.startswith("aqua/compartments/cache"):
+            return self.finish(AquaUIApp().clear_compartments_list_cache())
+        else:
+            raise HTTPError(400, f"The request {self.request.path} is invalid.")
+
+    @handle_exceptions
+    def list_log_groups(self, **kwargs):
+        """Lists all log groups for the specified compartment or tenancy."""
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        return self.finish(
+            AquaUIApp().list_log_groups(compartment_id=compartment_id, **kwargs)
+        )
+
+    @handle_exceptions
+    def list_logs(self, log_group_id: str, **kwargs):
+        """Lists the specified log group's log objects."""
+        return self.finish(AquaUIApp().list_logs(log_group_id=log_group_id, **kwargs))
+
+    @handle_exceptions
+    def list_compartments(self):
+        """Lists the compartments in a compartment specified by ODSC_MODEL_COMPARTMENT_OCID env variable."""
+        return self.finish(AquaUIApp().list_compartments())
+
+    @handle_exceptions
+    def get_default_compartment(self):
+        """Returns user compartment ocid."""
+        return self.finish(AquaUIApp().get_default_compartment())
+
+    @handle_exceptions
+    def list_model_version_sets(self, **kwargs):
+        """Lists all model version sets for the specified compartment or tenancy."""
+
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        return self.finish(
+            AquaUIApp().list_model_version_sets(
+                compartment_id=compartment_id,
+                target_tag=Tags.AQUA_FINE_TUNING.value,
+                **kwargs,
+            )
+        )
+
+    @handle_exceptions
+    def list_experiments(self, **kwargs):
+        """Lists all experiments for the specified compartment or tenancy."""
+
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        return self.finish(
+            AquaUIApp().list_model_version_sets(
+                compartment_id=compartment_id,
+                target_tag=Tags.AQUA_EVALUATION.value,
+                **kwargs,
+            )
+        )
+
+    @handle_exceptions
+    def list_buckets(self, **kwargs):
+        """Lists all model version sets for the specified compartment or tenancy."""
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        versioned = self.get_argument("versioned", default=None)
+        versioned = True if versioned and versioned.lower() == "true" else False
+
+        return self.finish(
+            AquaUIApp().list_buckets(
+                compartment_id=compartment_id, versioned=versioned, **kwargs
+            )
+        )
+
+    @handle_exceptions
+    def list_job_shapes(self, **kwargs):
+        """Lists job shapes available in the specified compartment."""
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        return self.finish(
+            AquaUIApp().list_job_shapes(compartment_id=compartment_id, **kwargs)
+        )
+
+    @handle_exceptions
+    def list_vcn(self, **kwargs):
+        """Lists the virtual cloud networks (VCNs) in the specified compartment."""
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        return self.finish(
+            AquaUIApp().list_vcn(compartment_id=compartment_id, **kwargs)
+        )
+
+    @handle_exceptions
+    def list_subnets(self, **kwargs):
+        """Lists the subnets in the specified VCN and the specified compartment."""
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        vcn_id = self.get_argument("vcn_id")
+        return self.finish(
+            AquaUIApp().list_subnets(
+                compartment_id=compartment_id, vcn_id=vcn_id, **kwargs
+            )
+        )
+
+    @handle_exceptions
+    def get_shape_availability(self, **kwargs):
+        """For a given compartmentId, resource limit name, and scope, returns the number of available resources associated
+        with the given limit."""
+        compartment_id = self.get_argument("compartment_id", default=COMPARTMENT_OCID)
+        instance_shape = self.get_argument("instance_shape")
+
+        return self.finish(
+            AquaUIApp().get_shape_availability(
+                compartment_id=compartment_id, instance_shape=instance_shape, **kwargs
+            )
+        )
+
+    @handle_exceptions
+    def is_bucket_versioned(self):
+        """For a given compartmentId, resource limit name, and scope, returns the number of available resources associated
+        with the given limit."""
+        bucket_uri = self.get_argument("bucket_uri")
+        return self.finish(AquaUIApp().is_bucket_versioned(bucket_uri=bucket_uri))
+
+
+__handlers__ = [
+    ("logging/?([^/]*)", AquaUIHandler),
+    ("compartments/?([^/]*)", AquaUIHandler),
+    # TODO: change url to evaluation/experiements/?([^/]*)
+    ("experiment/?([^/]*)", AquaUIHandler),
+    ("versionsets/?([^/]*)", AquaUIHandler),
+    ("buckets/?([^/]*)", AquaUIHandler),
+    ("job/shapes/?([^/]*)", AquaUIHandler),
+    ("vcn/?([^/]*)", AquaUIHandler),
+    ("subnets/?([^/]*)", AquaUIHandler),
+    ("shapes/limit/?([^/]*)", AquaUIHandler),
+    ("bucket/versioning/?([^/]*)", AquaUIHandler),
+]

ads/aqua/extension/utils.py

@@ -0,0 +1,23 @@
+#!/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 fields
+from typing import Dict, Optional
+from requests import HTTPError
+
+from ads.aqua.extension.base_handler import Errors
+
+
+def validate_function_parameters(data_class, input_data: Dict):
+    """Validates if the required parameters are provided in input data."""    
+    required_parameters = [
+        field.name for field in fields(data_class) 
+        if field.type != Optional[field.type]
+    ]
+
+    for required_parameter in required_parameters:
+        if not input_data.get(required_parameter):
+            raise HTTPError(
+                400, Errors.MISSING_REQUIRED_PARAMETER.format(required_parameter)
+            )