[ODSC_52446_52447] Get loggroups logids and compartment list

ads/aqua/base.py

@@ -3,10 +3,10 @@
 # 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 oci
-from oci.exceptions import ClientError, ServiceError
-
-from ads.aqua.exception import AquaClientError, AquaServiceError
 from ads.common.auth import default_signer
+from ads.aqua.exception import AquaServiceError, AquaClientError
+from oci.exceptions import ServiceError, ClientError
+from ads.common import oci_client as oc
 from ads.common.utils import extract_region
 
 
@@ -15,7 +15,9 @@ class AquaApp:
 
  def __init__(self) -> None:
  self._auth = default_signer()
- self.client = oci.data_science.DataScienceClient(**self._auth)
+ self.ds_client = oc.OCIClientFactory(**self._auth).data_science
+ self.logging_client = oc.OCIClientFactory(**self._auth).logging_management
+ self.identity_client = oc.OCIClientFactory(**self._auth).identity
  self.region = extract_region(self._auth)
 
  def list_resource(

ads/aqua/deployment.py

@@ -14,21 +14,28 @@
  ModelDeploymentContainerRuntime,
  ModelDeploymentMode,
 )
+from ads.common.utils import get_console_link
 from ads.common.serializer import DataClassSerializable
-from ads.aqua.exception import AquaClientError, AquaServiceError
 from ads.config import COMPARTMENT_OCID
 
+
+# todo: move this to constants or have separate functions
 AQUA_SERVICE_MODEL = "aqua_service_model"
-CONSOLE_LINK_URL = (
- "https://cloud.oracle.com/data-science/model-deployments/{}?region={}"
-)
 
 logger = logging.getLogger(__name__)
 
 
+@dataclass
+class ShapeInfo:
+ instance_shape: str
+ ocpus: float
+ memory_in_gbs: float
+
+
 @dataclass(repr=False)
 class AquaDeployment(DataClassSerializable):
  """Represents an Aqua Model Deployment"""
+
  id: str
  display_name: str
  aqua_service_model: str
@@ -37,10 +44,8 @@ class AquaDeployment(DataClassSerializable):
  created_on: str
  created_by: str
  endpoint: str
- instance_shape: str
- ocpus: float
- memory_in_gbs: float
  console_link: str
+ shape_info: ShapeInfo
 
 
 class AquaDeploymentApp(AquaApp):
@@ -202,7 +207,9 @@ def list(self, **kwargs) -> List["AquaDeployment"]:
  compartment_id = kwargs.pop("compartment_id", COMPARTMENT_OCID)
 
  model_deployments = self.list_resource(
- self.client.list_model_deployments, compartment_id=compartment_id, **kwargs
+ self.ds_client.list_model_deployments,
+ compartment_id=compartment_id,
+ **kwargs,
  )
 
  results = []
@@ -241,15 +248,16 @@ def get(self, model_deployment_id: str, **kwargs) -> "AquaDeployment":
  # add error handler
  # if not kwargs.get("model_deployment_id", None):
  # raise AquaClientError("Aqua model deployment ocid must be provided to fetch the deployment.")
- 
+
  # add error handler
- model_deployment = self.client.get_model_deployment(
+ model_deployment = self.ds_client.get_model_deployment(
  model_deployment_id=model_deployment_id, **kwargs
  ).data
-
- aqua_service_model=(
- model_deployment.freeform_tags.get(AQUA_SERVICE_MODEL, None) 
- if model_deployment.freeform_tags else None
+
+ aqua_service_model = (
+ model_deployment.freeform_tags.get(AQUA_SERVICE_MODEL, None)
+ if model_deployment.freeform_tags
+ else None
  )
 
  # add error handler
@@ -259,9 +267,11 @@ def get(self, model_deployment_id: str, **kwargs) -> "AquaDeployment":
  return AquaDeploymentApp.from_oci_model_deployment(
  model_deployment, self.region
  )
- 
+
  @classmethod
- def from_oci_model_deployment(cls, oci_model_deployment, region) -> "AquaDeployment":
+ def from_oci_model_deployment(
+ cls, oci_model_deployment, region
+ ) -> "AquaDeployment":
  """Converts oci model deployment response to AquaDeployment instance.
 
  Parameters
@@ -277,31 +287,39 @@ def from_oci_model_deployment(cls, oci_model_deployment, region) -> "AquaDeploym
  The instance of the Aqua model deployment.
  """
  instance_configuration = (
- oci_model_deployment
- .model_deployment_configuration_details
- .model_configuration_details
- .instance_configuration
+ oci_model_deployment.model_deployment_configuration_details.model_configuration_details.instance_configuration
  )
  instance_shape_config_details = (
  instance_configuration.model_deployment_instance_shape_config_details
  )
+ shape_info = ShapeInfo(
+ instance_shape=instance_configuration.instance_shape_name,
+ ocpus=(
+ instance_shape_config_details.ocpus
+ if instance_shape_config_details
+ else None
+ ),
+ memory_in_gbs=(
+ instance_shape_config_details.memory_in_gbs
+ if instance_shape_config_details
+ else None
+ ),
+ )
  return AquaDeployment(
  id=oci_model_deployment.id,
  display_name=oci_model_deployment.display_name,
- aqua_service_model=oci_model_deployment.freeform_tags.get(AQUA_SERVICE_MODEL),
+ aqua_service_model=oci_model_deployment.freeform_tags.get(
+ AQUA_SERVICE_MODEL
+ ),
+ shape_info=shape_info,
  state=oci_model_deployment.lifecycle_state,
  description=oci_model_deployment.description,
  created_on=str(oci_model_deployment.time_created),
  created_by=oci_model_deployment.created_by,
  endpoint=oci_model_deployment.model_deployment_url,
- instance_shape=instance_configuration.instance_shape_name,
- ocpus=(
- instance_shape_config_details.ocpus
- if instance_shape_config_details else None
+ console_link=get_console_link(
+  resource="model-deployments",
+ ocid=oci_model_deployment.id,
+ region=region,
  ),
- memory_in_gbs=(
- instance_shape_config_details.memory_in_gbs
- if instance_shape_config_details else None
- ),
- console_link=CONSOLE_LINK_URL.format(oci_model_deployment.id, region)
- ) 
+ )

ads/aqua/extension/__init__.py

@@ -15,13 +15,15 @@
 from ads.aqua.extension.playground_handler import (
  __handlers__ as __playground_handlers__,
 )
+from ads.aqua.extension.ui_handler import __handlers__ as __ui_handlers__
 
 __handlers__ = (
  __playground_handlers__
  + __job_handlers__
  + __model_handlers__
  + __common_handlers__
  + __deployment_handlers__
+ + __ui_handlers__
 )
 
 

ads/aqua/extension/deployment_handler.py

@@ -32,7 +32,6 @@ class AquaDeploymentHandler(AquaAPIhandler):
 
  def get(self, id=""):
  """Handle GET request."""
- # todo: handle list, read and logs for model deployment
  if not id:
  return self.list()
  return self.read(id)
@@ -112,7 +111,8 @@ def post(self, *args, **kwargs):
  AquaDeploymentApp().create(
  compartment_id=compartment_id,
  project_id=project_id,
- # todo: replace model_id with aqua_model.id
+ # todo: replace model_id with aqua_model.id, use current model for deploy
+ # but replace with model by reference is implemented
  model_id=model_id,
  aqua_service_model=aqua_service_model,
  display_name=display_name,

ads/aqua/extension/ui_handler.py

@@ -0,0 +1,75 @@
+#!/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 tornado.web import HTTPError
+from urllib.parse import urlparse
+from ads.aqua.extension.base_handler import AquaAPIhandler
+from ads.aqua.ui import AquaUIApp
+
+
+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"):
+ return self.list_compartments()
+ else:
+ raise HTTPError(400, f"The request {self.request.path} is invalid.")
+
+ def list_log_groups(self, **kwargs):
+ """Lists all log groups for the specified compartment or tenancy."""
+ compartment_id = self.get_argument("compartment_id")
+ try:
+ return self.finish(
+ AquaUIApp().list_log_groups(compartment_id=compartment_id, **kwargs)
+ )
+ except Exception as ex:
+ raise HTTPError(500, str(ex))
+
+ def list_logs(self, log_group_id: str, **kwargs):
+ """Lists the specified log group's log objects."""
+ try:
+ return self.finish(
+ AquaUIApp().list_logs(log_group_id=log_group_id, **kwargs)
+ )
+ except Exception as ex:
+ raise HTTPError(500, str(ex))
+
+ def list_compartments(self, **kwargs):
+ """Lists the compartments in a compartment specified by ODSC_MODEL_COMPARTMENT_OCID env variable."""
+ try:
+ return self.finish(AquaUIApp().list_compartments(**kwargs))
+ except Exception as ex:
+ raise HTTPError(500, str(ex))
+
+
+__handlers__ = [
+ ("logging/?([^/]*)", AquaUIHandler),
+ ("compartments/?([^/]*)", AquaUIHandler),
+]

ads/aqua/model.py

@@ -8,8 +8,7 @@
 from typing import List
 
 import fsspec
-import oci
-from oci.exceptions import ClientError, ServiceError
+from oci.data_science.models import ModelSummary
 
 from ads.aqua import logger
 from ads.aqua.base import AquaApp
@@ -90,11 +89,10 @@ def get(self, model_id) -> "AquaModel":
  The instance of the Aqua model.
  """
  # add error handler
- oci_model = self.client.get_model(model_id).data
-
+ oci_model = self.ds_client.get_model(model_id).data
  # add error handler
- # if not self._if_show(oci_model):
- #  raise AquaClientError(f"Target model {oci_model.id} is not Aqua model.")
+ if not self._if_show(oci_model):
+ raise AquaClientError(f"Target model {oci_model.id} is not Aqua model.")
 
  custom_metadata_list = oci_model.custom_metadata_list
  artifact_path = self._get_artifact_path(custom_metadata_list)
@@ -113,6 +111,8 @@ def get(self, model_id) -> "AquaModel":
  if oci_model.freeform_tags.get(Tags.AQUA_FINE_TUNED_MODEL_TAG.value)
  else False,
  model_card=str(self._read_file(f"{artifact_path}/{README}")),
+ # todo: add proper tags
+ tags={},
  )
 
  def list(
@@ -136,7 +136,9 @@ def list(
  compartment_id = compartment_id or COMPARTMENT_OCID
 
  service_model = self.list_resource(
- self.client.list_models, compartment_id=ODSC_MODEL_COMPARTMENT_OCID
+ self.ds_client.list_models,
+ compartment_id=ODSC_MODEL_COMPARTMENT_OCID,
+ project_id=project_id,
  )
  fine_tuned_models = self._rqs(compartment_id)
  models = fine_tuned_models + service_model
@@ -153,11 +155,7 @@ def process_model(model):
  tags.update(model.defined_tags)
  tags.update(model.freeform_tags)
 
- model_id = (
- model.id
- if isinstance(model, oci.data_science.models.ModelSummary)
- else model.identifier
- )
+ model_id = model.id if isinstance(model, ModelSummary) else model.identifier
  return AquaModelSummary(
  compartment_id=model.compartment_id,
  icon=icon,
@@ -215,7 +213,7 @@ def _get_artifact_path(self, custom_metadata_list: List) -> str:
 
  def _read_file(self, file_path: str) -> str:
  try:
- with fsspec.open(file_path, "rb", **self._auth) as f:
+ with fsspec.open(file_path, "r", **self._auth) as f:
  return f.read()
  except Exception as e:
  logger.error(f"Failed to retreive model icon. {e}")