Merge branch 'main' into track_md_logs_for_error_logging

Author: agrimk

ads/aqua/cli.py

@@ -14,6 +14,7 @@
 from ads.aqua.finetuning import AquaFineTuningApp
 from ads.aqua.model import AquaModelApp
 from ads.aqua.modeldeployment import AquaDeploymentApp
+from ads.aqua.verify_policies import AquaVerifyPoliciesApp
 from ads.common.utils import LOG_LEVELS
 
 
@@ -29,6 +30,7 @@ class AquaCommand:
     fine_tuning = AquaFineTuningApp
     deployment = AquaDeploymentApp
     evaluation = AquaEvaluationApp
+    verify_policies = AquaVerifyPoliciesApp
 
     def __init__(
         self,

ads/aqua/constants.py

@@ -55,6 +55,8 @@
 SUPPORTED_FILE_FORMATS = ["jsonl"]
 MODEL_BY_REFERENCE_OSS_PATH_KEY = "artifact_location"
 
+AQUA_CHAT_TEMPLATE_METADATA_KEY = "chat_template"
+
 CONSOLE_LINK_RESOURCE_TYPE_MAPPING = {
     "datasciencemodel": "models",
     "datasciencemodeldeployment": "model-deployments",

ads/aqua/extension/model_handler.py

@@ -11,12 +11,15 @@
 from ads.aqua.common.enums import CustomInferenceContainerTypeFamily
 from ads.aqua.common.errors import AquaRuntimeError
 from ads.aqua.common.utils import get_hf_model_info, is_valid_ocid, list_hf_models
+from ads.aqua.constants import AQUA_CHAT_TEMPLATE_METADATA_KEY
 from ads.aqua.extension.base_handler import AquaAPIhandler
 from ads.aqua.extension.errors import Errors
 from ads.aqua.model import AquaModelApp
 from ads.aqua.model.entities import AquaModelSummary, HFModelSummary
 from ads.config import SERVICE
+from ads.model import DataScienceModel
 from ads.model.common.utils import MetadataArtifactPathType
+from ads.model.service.oci_datascience_model import OCIDataScienceModel
 
 
 class AquaModelHandler(AquaAPIhandler):
@@ -320,26 +323,65 @@ def post(self, *args, **kwargs):  # noqa: ARG002
         )
 
 
-class AquaModelTokenizerConfigHandler(AquaAPIhandler):
+class AquaModelChatTemplateHandler(AquaAPIhandler):
     def get(self, model_id):
         """
-        Handles requests for retrieving the Hugging Face tokenizer configuration of a specified model.
-        Expected request format: GET /aqua/models/<model-ocid>/tokenizer
+        Handles requests for retrieving the chat template from custom metadata of a specified model.
+        Expected request format: GET /aqua/models/<model-ocid>/chat-template
 
         """
 
         path_list = urlparse(self.request.path).path.strip("/").split("/")
-        # Path should be /aqua/models/ocid1.iad.ahdxxx/tokenizer
-        # path_list=['aqua','models','<model-ocid>','tokenizer']
+        # Path should be /aqua/models/ocid1.iad.ahdxxx/chat-template
+        # path_list=['aqua','models','<model-ocid>','chat-template']
         if (
             len(path_list) == 4
             and is_valid_ocid(path_list[2])
-            and path_list[3] == "tokenizer"
+            and path_list[3] == "chat-template"
         ):
-            return self.finish(AquaModelApp().get_hf_tokenizer_config(model_id))
+            try:
+                oci_data_science_model = OCIDataScienceModel.from_id(model_id)
+            except Exception as e:
+                raise HTTPError(404, f"Model not found for id: {model_id}. Details: {str(e)}")
+            return self.finish(oci_data_science_model.get_custom_metadata_artifact("chat_template"))
 
         raise HTTPError(400, f"The request {self.request.path} is invalid.")
 
+    @handle_exceptions
+    def post(self, model_id: str):
+        """
+        Handles POST requests to add a custom chat_template metadata artifact to a model.
+
+        Expected request format:
+        POST /aqua/models/<model-ocid>/chat-template
+        Body: { "chat_template": "<your_template_string>" }
+
+        """
+        try:
+            input_body = self.get_json_body()
+        except Exception as e:
+            raise HTTPError(400, f"Invalid JSON body: {str(e)}")
+
+        chat_template = input_body.get("chat_template")
+        if not chat_template:
+            raise HTTPError(400, "Missing required field: 'chat_template'")
+
+        try:
+            data_science_model = DataScienceModel.from_id(model_id)
+        except Exception as e:
+            raise HTTPError(404, f"Model not found for id: {model_id}. Details: {str(e)}")
+
+        try:
+            result = data_science_model.create_custom_metadata_artifact(
+                metadata_key_name=AQUA_CHAT_TEMPLATE_METADATA_KEY,
+                path_type=MetadataArtifactPathType.CONTENT,
+                artifact_path_or_content=chat_template.encode()
+            )
+        except Exception as e:
+            raise HTTPError(500, f"Failed to create metadata artifact: {str(e)}")
+
+        return self.finish(result)
+
 
 class AquaModelDefinedMetadataArtifactHandler(AquaAPIhandler):
     """
@@ -381,7 +423,7 @@ def post(self, model_id: str, metadata_key: str):
     ("model/?([^/]*)", AquaModelHandler),
     ("model/?([^/]*)/license", AquaModelLicenseHandler),
     ("model/?([^/]*)/readme", AquaModelReadmeHandler),
-    ("model/?([^/]*)/tokenizer", AquaModelTokenizerConfigHandler),
+    ("model/?([^/]*)/chat-template", AquaModelChatTemplateHandler),
     ("model/hf/search/?([^/]*)", AquaHuggingFaceHandler),
     (
         "model/?([^/]*)/definedMetadata/?([^/]*)",

ads/aqua/model/constants.py

@@ -26,6 +26,7 @@ class ModelTask(ExtendedEnum):
     TEXT_GENERATION = "text-generation"
     IMAGE_TEXT_TO_TEXT = "image-text-to-text"
     IMAGE_TO_TEXT = "image-to-text"
+    TIME_SERIES_FORECASTING = "time-series-forecasting"
 
 
 class FineTuningMetricCategories(ExtendedEnum):

ads/aqua/modeldeployment/deployment.py

@@ -48,7 +48,11 @@
 )
 from ads.aqua.data import AquaResourceIdentifier
 from ads.aqua.model import AquaModelApp
-from ads.aqua.model.constants import AquaModelMetadataKeys, ModelCustomMetadataFields
+from ads.aqua.model.constants import (
+    AquaModelMetadataKeys,
+    ModelCustomMetadataFields,
+    ModelTask,
+)
 from ads.aqua.model.utils import (
     extract_base_model_from_ft,
     extract_fine_tune_artifacts_path,
@@ -215,6 +219,14 @@ def create(
                 freeform_tags=freeform_tags,
                 defined_tags=defined_tags,
             )
+            task_tag = aqua_model.freeform_tags.get(Tags.TASK, UNKNOWN)
+            if (
+                task_tag == ModelTask.TIME_SERIES_FORECASTING
+                or task_tag == ModelTask.TIME_SERIES_FORECASTING.replace("-", "_")
+            ):
+                create_deployment_details.env_var.update(
+                    {Tags.TASK.upper(): ModelTask.TIME_SERIES_FORECASTING}
+                )
             return self._create(
                 aqua_model=aqua_model,
                 create_deployment_details=create_deployment_details,
@@ -854,14 +866,17 @@ def list(self, **kwargs) -> List["AquaDeployment"]:
                 aqua_model_id = model_deployment.freeform_tags.get(
                     Tags.AQUA_MODEL_ID_TAG, UNKNOWN
                 )
-                if "datasciencemodelgroup" in aqua_model_id:
+                if (
+                    "datasciencemodelgroup" in aqua_model_id
+                    or model_deployment.model_deployment_configuration_details.deployment_type
+                    == "UNKNOWN_ENUM_VALUE"
+                ):
                     continue
                 results.append(
                     AquaDeployment.from_oci_model_deployment(
                         model_deployment, self.region
                     )
                 )
-
                 # log telemetry if MD is in active or failed state
                 deployment_id = model_deployment.id
                 state = model_deployment.lifecycle_state.upper()

ads/aqua/verify_policies/__init__.py

@@ -0,0 +1,8 @@
+#!/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 ads.aqua.verify_policies.verify import AquaVerifyPoliciesApp
+
+__all__ = ["AquaVerifyPoliciesApp"]

ads/aqua/verify_policies/constants.py

@@ -0,0 +1,13 @@
+OBS_MANAGE_TEST_FILE = "AQUA Policy Verification - OBJECT STORAGE"
+TEST_MODEL_NAME="AQUA Policy Verification -  Model"
+TEST_MD_NAME="AQUA Policy Verification - Model Deployment"
+TEST_JOB_NAME="AQUA Policy Verification - Job"
+TEST_JOB_RUN_NAME="AQUA Policy Verification - Job Run"
+TEST_MVS_NAME="AQUA Policy Verification - Model Version Set"
+TEST_VM_SHAPE="VM.Standard.E4.Flex"
+TEST_DEFAULT_JOB_SHAPE = "VM.Standard.E3.Flex"
+TEST_LIMIT_NAME = "ds-gpu-a10-count"
+DUMMY_TEST_BYTE = b"7IV6cktUGcHIhur4bXTv"
+POLICY_HELP_LINK = "https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/ai-quick-actions/policies/README.md"
+
+

ads/aqua/verify_policies/entities.py

@@ -0,0 +1,29 @@
+from dataclasses import dataclass
+from ads.common.extended_enum import ExtendedEnum
+from ads.common.serializer import DataClassSerializable
+
+
+class PolicyStatus(ExtendedEnum):
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    UNVERIFIED = "UNVERIFIED"
+
+
+@dataclass(repr=False)
+class OperationResultSuccess(DataClassSerializable):
+    operation: str
+    status: PolicyStatus = PolicyStatus.SUCCESS
+
+
+@dataclass(repr=False)
+class OperationResultFailure(DataClassSerializable):
+    operation: str
+    error: str
+    policy_hint: str
+    status: PolicyStatus = PolicyStatus.FAILURE
+
+
+@dataclass(repr=False)
+class CommonSettings(DataClassSerializable):
+    compartment_id: str
+    project_id: str

ads/aqua/verify_policies/messages.py

@@ -0,0 +1,101 @@
+from ads.aqua.verify_policies.utils import VerifyPoliciesUtils
+
+utils = VerifyPoliciesUtils()
+operation_messages = {
+    utils.list_compartments.__name__: {
+        "name": "List Compartments",
+        "error": "Unable to retrieve the list of compartments. Please verify that you have the required permissions to list compartments in your tenancy. ",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to inspect compartments in tenancy"
+    },
+    utils.list_models.__name__: {
+        "name": "List Models",
+        "error": "Failed to fetch available models. Ensure that the policies allow you to list models from the Model Catalog in the selected compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-models in compartment <your-compartment-name>"
+    },
+    utils.list_project.__name__: {
+        "name": "List Projects",
+        "error": "Failed to list Data Science projects. Verify that you have the appropriate permission to access projects in the selected compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-projects in compartment <your-compartment-name>"
+    },
+    utils.list_model_version_sets.__name__: {
+        "name": "List Model Version Sets",
+        "error": "Unable to load model version sets. Check your access rights to list model version sets in the selected compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-modelversionsets in compartment <your-compartment-name>"
+    },
+    utils.list_jobs.__name__: {
+        "name": "List Jobs",
+        "error": "Job list could not be retrieved. Please confirm that you have the necessary permissions to view jobs in the compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-jobs in compartment <your-compartment-name>"
+    },
+    utils.list_job_runs.__name__: {
+        "name": "List Job Runs",
+        "error": "Job Runs list could not be retrieved. Please confirm that you have the necessary permissions to view job runs in the compartme",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-job-runs in compartment <your-compartment-name>"
+    },
+    utils.list_buckets.__name__: {
+        "name": "List Object Storage Buckets",
+        "error": "Cannot fetch Object Storage buckets. Verify that you have access to list buckets within the specified compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to read objectstorage-namespaces in compartment <your-compartment-name>\nAllow dynamic-group aqua-dynamic-group to read buckets in compartment <your-compartment-name>"
+    },
+    utils.manage_bucket.__name__: {
+        "name": "Object Storage Access",
+        "error": "Failed to access the Object Storage bucket. Verify that the bucket exists and you have write permissions.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage object-family in compartment <your-compartment-name> where any {target.bucket.name='<your-bucket-name>'}"
+    },
+    utils.list_log_groups.__name__: {
+        "name": "List Log Groups",
+        "error": "Log groups or logs could not be retrieved. Please confirm you have logging read access for the selected compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to use logging-family in compartment <your-compartment-name>"
+    },
+    utils.get_resource_availability.__name__: {
+        "name": "Verify Shape Limits",
+        "error": "Failed to retrieve shape limits for your compartment. Make sure the required policies are in place to read shape and quota data.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to read resource-availability in compartment <your-compartment-name>"
+    },
+    utils.register_model.__name__: {
+        "name": "Register Model",
+        "error": "Model registration failed. Ensure you have the correct permissions to write to the Model Catalog and access Object Storage.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-models in compartment <your-compartment-name>"
+    },
+    utils.aqua_model.delete_model.__name__: {
+        "name": "Delete Model",
+        "error": "Could not delete model. Please confirm you have delete permissions for Model Catalog resources in the compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-models in compartment <your-compartment-name>"
+    },
+    utils.create_job.__name__: {
+        "name": "Create Job",
+        "error": "Job could not be created. Please check if you have permissions to create Data Science jobs.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-jobs in compartment <your-compartment-name>"
+    },
+    utils.create_job_run.__name__: {
+        "name": "Create Job Run",
+        "error": "Job Run could not be created. Confirm that you are allowed to run jobs in the selected compartment.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-job-runs in compartment <your-compartment-name>"
+    },
+    "delete_job": {
+        "name": "Delete Job",
+        "error": "Job could not be deleted. Please check if you have permissions to delete Data Science jobs.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-jobs in compartment <your-compartment-name>"
+    },
+    utils.aqua_model.create_model_version_set.__name__: {
+        "name": "Create Model Version Set",
+        "error": "Unable to create a model version set for storing evaluation results. Ensure that required Model Catalog permissions are set.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-modelversionsets in compartment <your-compartment-name>"
+    },
+    utils.aqua_model.ds_client.delete_model_version_set.__name__: {
+        "name": "Delete Model Version Set",
+        "error": "Unable to delete a model version. Ensure that required Model Catalog permissions are set.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-modelversionsets in compartment <your-compartment-name>"
+    },
+    utils.create_model_deployment.__name__: {
+        "name": "Create Model Deployment",
+        "error": "Model deployment could not be created. Confirm you have correct permissions to deploy models to the Model Deployment service.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-model-deployments in compartment <your-compartment-name>"
+    },
+    utils.aqua_model.ds_client.delete_model_deployment.__name__: {
+        "name": "Delete Model Deployment",
+        "error": "Unable to delete the model deployment. Please check if you have appropriate permissions to manage deployments.",
+        "policy_hint": "Allow dynamic-group aqua-dynamic-group to manage data-science-model-deployments in compartment <your-compartment-name>"
+    }
+
+}