oracle-ads 2.12.8__py3-none-any.whl → 2.12.10__py3-none-any.whl

ads/aqua/common/enums.py

@@ -52,6 +52,9 @@ class InferenceContainerTypeFamily(str, metaclass=ExtendedEnumMeta):
     AQUA_VLLM_CONTAINER_FAMILY = "odsc-vllm-serving"
     AQUA_TGI_CONTAINER_FAMILY = "odsc-tgi-serving"
     AQUA_LLAMA_CPP_CONTAINER_FAMILY = "odsc-llama-cpp-serving"
+
+
+class CustomInferenceContainerTypeFamily(str, metaclass=ExtendedEnumMeta):
     AQUA_TEI_CONTAINER_FAMILY = "odsc-tei-serving"
 
 

ads/aqua/common/utils.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 """AQUA utils and constants."""
 
@@ -11,6 +11,7 @@ import os
 import random
 import re
 import shlex
+import shutil
 import subprocess
 from datetime import datetime, timedelta
 from functools import wraps
@@ -21,6 +22,8 @@ from typing import List, Union
 import fsspec
 import oci
 from cachetools import TTLCache, cached
+from huggingface_hub.constants import HF_HUB_CACHE
+from huggingface_hub.file_download import repo_folder_name
 from huggingface_hub.hf_api import HfApi, ModelInfo
 from huggingface_hub.utils import (
     GatedRepoError,
@@ -30,6 +33,7 @@ from huggingface_hub.utils import (
 )
 from oci.data_science.models import JobRun, Model
 from oci.object_storage.models import ObjectSummary
+from pydantic import ValidationError
 
 from ads.aqua.common.enums import (
     InferenceContainerParamType,
@@ -788,7 +792,9 @@ def get_ocid_substring(ocid: str, key_len: int) -> str:
     return ocid[-key_len:] if ocid and len(ocid) > key_len else ""
 
 
-def upload_folder(os_path: str, local_dir: str, model_name: str, exclude_pattern: str = None) -> str:
+def upload_folder(
+    os_path: str, local_dir: str, model_name: str, exclude_pattern: str = None
+) -> str:
     """Upload the local folder to the object storage
 
     Args:
@@ -818,6 +824,48 @@ def upload_folder(os_path: str, local_dir: str, model_name: str, exclude_pattern
     return f"oci://{os_details.bucket}@{os_details.namespace}" + "/" + object_path
 
 
+def cleanup_local_hf_model_artifact(
+    model_name: str,
+    local_dir: str = None,
+):
+    """
+    Helper function that deletes local artifacts downloaded from Hugging Face to free up disk space.
+    Parameters
+    ----------
+    model_name (str): Name of the huggingface model
+    local_dir (str): Local directory where the object is downloaded
+
+    """
+    if local_dir and os.path.exists(local_dir):
+        model_dir = os.path.join(local_dir, model_name)
+        model_dir = (
+            os.path.dirname(model_dir)
+            if "/" in model_name or os.sep in model_name
+            else model_dir
+        )
+        shutil.rmtree(model_dir, ignore_errors=True)
+        if os.path.exists(model_dir):
+            logger.debug(
+                f"Could not delete local model artifact directory: {model_dir}"
+            )
+        else:
+            logger.debug(f"Deleted local model artifact directory: {model_dir}.")
+
+    hf_local_path = os.path.join(
+        HF_HUB_CACHE, repo_folder_name(repo_id=model_name, repo_type="model")
+    )
+    shutil.rmtree(hf_local_path, ignore_errors=True)
+
+    if os.path.exists(hf_local_path):
+        logger.debug(
+            f"Could not clear the local Hugging Face cache directory {hf_local_path} for the model {model_name}."
+        )
+    else:
+        logger.debug(
+            f"Cleared contents of local Hugging Face cache directory {hf_local_path} for the model {model_name}."
+        )
+
+
 def is_service_managed_container(container):
     return container and container.startswith(SERVICE_MANAGED_CONTAINER_URI_SCHEME)
 
@@ -1159,3 +1207,15 @@ def validate_cmd_var(cmd_var: List[str], overrides: List[str]) -> List[str]:
 
     combined_cmd_var = cmd_var + overrides
     return combined_cmd_var
+
+
+def build_pydantic_error_message(ex: ValidationError):
+    """Added to handle error messages from pydantic model validator.
+    Combine both loc and msg for errors where loc (field) is present in error details, else only build error
+    message using msg field."""
+
+    return {
+        ".".join(map(str, e["loc"])): e["msg"]
+        for e in ex.errors()
+        if "loc" in e and e["loc"]
+    } or "; ".join(e["msg"] for e in ex.errors())

ads/aqua/data.py

@@ -1,9 +1,8 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 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, field
+from dataclasses import dataclass
 
 from ads.common.serializer import DataClassSerializable
 
@@ -13,19 +12,3 @@ class AquaResourceIdentifier(DataClassSerializable):
     id: str = ""
     name: str = ""
     url: str = ""
-
-
-@dataclass(repr=False)
-class AquaJobSummary(DataClassSerializable):
-    """Represents an Aqua job summary."""
-
-    id: str
-    name: str
-    console_url: str
-    lifecycle_state: str
-    lifecycle_details: str
-    time_created: str
-    tags: dict
-    experiment: AquaResourceIdentifier = field(default_factory=AquaResourceIdentifier)
-    source: AquaResourceIdentifier = field(default_factory=AquaResourceIdentifier)
-    job: AquaResourceIdentifier = field(default_factory=AquaResourceIdentifier)

ads/aqua/evaluation/entities.py

@@ -64,6 +64,10 @@ class CreateAquaEvaluationDetails(Serializable):
         The metrics for the evaluation.
     force_overwrite: (bool, optional). Defaults to `False`.
         Whether to force overwrite the existing file in object storage.
+    freeform_tags: (dict, optional)
+        Freeform tags for the evaluation model
+    defined_tags: (dict, optional)
+        Defined tags for the evaluation model
     """
 
     evaluation_source_id: str
@@ -85,6 +89,8 @@ class CreateAquaEvaluationDetails(Serializable):
     log_id: Optional[str] = None
     metrics: Optional[List[Dict[str, Any]]] = None
     force_overwrite: Optional[bool] = False
+    freeform_tags: Optional[dict] = None
+    defined_tags: Optional[dict] = None
 
     class Config:
         extra = "ignore"

ads/aqua/evaluation/evaluation.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 import base64
 import json
@@ -199,11 +199,11 @@ class AquaEvaluationApp(AquaApp):
                             eval_inference_configuration = (
                                 container.spec.evaluation_configuration
                             )
-            except Exception:
+            except Exception as ex:
                 logger.debug(
                     f"Could not load inference config details for the evaluation source id: "
                     f"{create_aqua_evaluation_details.evaluation_source_id}. Please check if the container"
-                    f" runtime has the correct SMC image information."
+                    f" runtime has the correct SMC image information.\nError: {str(ex)}"
                 )
         elif (
             DataScienceResource.MODEL
@@ -289,7 +289,7 @@ class AquaEvaluationApp(AquaApp):
                         f"Invalid experiment name. Please provide an experiment with `{Tags.AQUA_EVALUATION}` in tags."
                     )
             except Exception:
-                logger.debug(
+                logger.info(
                     f"Model version set {experiment_model_version_set_name} doesn't exist. "
                     "Creating new model version set."
                 )
@@ -297,6 +297,10 @@ class AquaEvaluationApp(AquaApp):
                 evaluation_mvs_freeform_tags = {
                     Tags.AQUA_EVALUATION: Tags.AQUA_EVALUATION,
                 }
+                evaluation_mvs_freeform_tags = {
+                    **evaluation_mvs_freeform_tags,
+                    **(create_aqua_evaluation_details.freeform_tags or {}),
+                }
 
                 model_version_set = (
                     ModelVersionSet()
@@ -307,6 +311,9 @@ class AquaEvaluationApp(AquaApp):
                         create_aqua_evaluation_details.experiment_description
                     )
                     .with_freeform_tags(**evaluation_mvs_freeform_tags)
+                    .with_defined_tags(
+                        **(create_aqua_evaluation_details.defined_tags or {})
+                    )
                     # TODO: decide what parameters will be needed
                     .create(**kwargs)
                 )
@@ -369,6 +376,10 @@ class AquaEvaluationApp(AquaApp):
             Tags.AQUA_EVALUATION: Tags.AQUA_EVALUATION,
             Tags.AQUA_EVALUATION_MODEL_ID: evaluation_model.id,
         }
+        evaluation_job_freeform_tags = {
+            **evaluation_job_freeform_tags,
+            **(create_aqua_evaluation_details.freeform_tags or {}),
+        }
 
         evaluation_job = Job(name=evaluation_model.display_name).with_infrastructure(
             DataScienceJob()
@@ -379,6 +390,7 @@ class AquaEvaluationApp(AquaApp):
             .with_shape_name(create_aqua_evaluation_details.shape_name)
             .with_block_storage_size(create_aqua_evaluation_details.block_storage_size)
             .with_freeform_tag(**evaluation_job_freeform_tags)
+            .with_defined_tag(**(create_aqua_evaluation_details.defined_tags or {}))
         )
         if (
             create_aqua_evaluation_details.memory_in_gbs
@@ -425,6 +437,7 @@ class AquaEvaluationApp(AquaApp):
         evaluation_job_run = evaluation_job.run(
             name=evaluation_model.display_name,
             freeform_tags=evaluation_job_freeform_tags,
+            defined_tags=(create_aqua_evaluation_details.defined_tags or {}),
             wait=False,
         )
         logger.debug(
@@ -444,13 +457,20 @@ class AquaEvaluationApp(AquaApp):
             for metadata in evaluation_model_custom_metadata.to_dict()["data"]
         ]
 
+        evaluation_model_freeform_tags = {
+            Tags.AQUA_EVALUATION: Tags.AQUA_EVALUATION,
+            **(create_aqua_evaluation_details.freeform_tags or {}),
+        }
+        evaluation_model_defined_tags = (
+            create_aqua_evaluation_details.defined_tags or {}
+        )
+
         self.ds_client.update_model(
             model_id=evaluation_model.id,
             update_model_details=UpdateModelDetails(
                 custom_metadata_list=updated_custom_metadata_list,
-                freeform_tags={
-                    Tags.AQUA_EVALUATION: Tags.AQUA_EVALUATION,
-                },
+                freeform_tags=evaluation_model_freeform_tags,
+                defined_tags=evaluation_model_defined_tags,
             ),
         )
 
@@ -524,6 +544,8 @@ class AquaEvaluationApp(AquaApp):
                 "evaluation_job_id": evaluation_job.id,
                 "evaluation_source": create_aqua_evaluation_details.evaluation_source_id,
                 "evaluation_experiment_id": experiment_model_version_set_id,
+                **evaluation_model_freeform_tags,
+                **evaluation_model_defined_tags,
             },
             parameters=AquaEvalParams(),
         )
@@ -689,21 +711,27 @@ class AquaEvaluationApp(AquaApp):
             try:
                 log = utils.query_resource(log_id, return_all=False)
                 log_name = log.display_name if log else ""
-            except Exception:
+            except Exception as ex:
+                logger.debug(f"Failed to get associated log name. Error: {ex}")
                 pass
 
         if loggroup_id:
             try:
                 loggroup = utils.query_resource(loggroup_id, return_all=False)
                 loggroup_name = loggroup.display_name if loggroup else ""
-            except Exception:
+            except Exception as ex:
+                logger.debug(f"Failed to get associated loggroup name. Error: {ex}")
                 pass
 
         try:
             introspection = json.loads(
                 self._get_attribute_from_model_metadata(resource, "ArtifactTestResults")
             )
-        except Exception:
+        except Exception as ex:
+            logger.debug(
+                f"There was an issue loading the model attribute as json object for evaluation {eval_id}. "
+                f"Setting introspection to empty.\n Error:{ex}"
+            )
             introspection = {}
 
         summary = AquaEvaluationDetail(
@@ -856,13 +884,13 @@ class AquaEvaluationApp(AquaApp):
         try:
             log_id = job_run_details.log_details.log_id
         except Exception as e:
-            logger.debug(f"Failed to get associated log. {str(e)}")
+            logger.debug(f"Failed to get associated log.\nError: {str(e)}")
             log_id = ""
 
         try:
             loggroup_id = job_run_details.log_details.log_group_id
         except Exception as e:
-            logger.debug(f"Failed to get associated log. {str(e)}")
+            logger.debug(f"Failed to get associated log.\nError: {str(e)}")
             loggroup_id = ""
 
         loggroup_url = get_log_links(region=self.region, log_group_id=loggroup_id)
@@ -936,7 +964,7 @@ class AquaEvaluationApp(AquaApp):
                 )
             except Exception as e:
                 logger.debug(
-                    "Failed to load `report.json` from evaluation artifact" f"{str(e)}"
+                    f"Failed to load `report.json` from evaluation artifact.\nError: {str(e)}"
                 )
                 json_report = {}
 
@@ -1025,6 +1053,7 @@ class AquaEvaluationApp(AquaApp):
                 return report
 
         with tempfile.TemporaryDirectory() as temp_dir:
+            logger.info(f"Downloading evaluation artifact for {eval_id}.")
             DataScienceModel.from_id(eval_id).download_artifact(
                 temp_dir,
                 auth=self._auth,
@@ -1178,6 +1207,7 @@ class AquaEvaluationApp(AquaApp):
     def load_evaluation_config(self, container: Optional[str] = None) -> Dict:
         """Loads evaluation config."""
 
+        logger.info("Loading evaluation container config.")
         # retrieve the evaluation config by container family name
         evaluation_config = get_evaluation_service_config(container)
 
@@ -1257,9 +1287,9 @@ class AquaEvaluationApp(AquaApp):
                     raise AquaRuntimeError(
                         f"Not supported source type: {resource_type}"
                     )
-        except Exception:
+        except Exception as ex:
             logger.debug(
-                f"Failed to retrieve source information for evaluation {evaluation.identifier}."
+                f"Failed to retrieve source information for evaluation {evaluation.identifier}.\nError: {str(ex)}"
             )
             source_name = ""
 

ads/aqua/extension/aqua_ws_msg_handler.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 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
+import uuid
 from abc import abstractmethod
 from http.client import responses
 from typing import List
@@ -34,7 +34,7 @@ class AquaWSMsgHandler:
             self.telemetry = TelemetryClient(
                 bucket=AQUA_TELEMETRY_BUCKET, namespace=AQUA_TELEMETRY_BUCKET_NS
             )
-        except:
+        except Exception:
             pass
 
     @staticmethod
@@ -66,16 +66,23 @@ class AquaWSMsgHandler:
             "message": message,
             "service_payload": service_payload,
             "reason": reason,
+            "request_id": str(uuid.uuid4()),
         }
         exc_info = kwargs.get("exc_info")
         if exc_info:
-            logger.error("".join(traceback.format_exception(*exc_info)))
+            logger.error(
+                f"Error Request ID: {reply['request_id']}\n"
+                f"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"])
+
+        logger.error(
+            f"Error Request ID: {reply['request_id']}\n"
+            f"Error: {reply['message']} {reply['reason']}"
+        )
         # telemetry may not be present if there is an error while initializing
         if hasattr(self, "telemetry"):
             aqua_api_details = kwargs.get("aqua_api_details", {})
@@ -83,7 +90,7 @@ class AquaWSMsgHandler:
                 category="aqua/error",
                 action=str(status_code),
                 value=reason,
-                **aqua_api_details
+                **aqua_api_details,
             )
         response = AquaWsError(
             status=status_code,

ads/aqua/extension/base_handler.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 
@@ -35,7 +34,7 @@ class AquaAPIhandler(APIHandler):
             self.telemetry = TelemetryClient(
                 bucket=AQUA_TELEMETRY_BUCKET, namespace=AQUA_TELEMETRY_BUCKET_NS
             )
-        except:
+        except Exception:
             pass
 
     @staticmethod
@@ -82,19 +81,23 @@ class AquaAPIhandler(APIHandler):
             "message": message,
             "service_payload": service_payload,
             "reason": reason,
+            "request_id": str(uuid.uuid4()),
         }
         exc_info = kwargs.get("exc_info")
         if exc_info:
-            logger.error("".join(traceback.format_exception(*exc_info)))
+            logger.error(
+                f"Error Request ID: {reply['request_id']}\n"
+                f"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 if e.reason else reply["reason"]
-                reply["request_id"] = str(uuid.uuid4())
-            else:
-                reply["request_id"] = str(uuid.uuid4())
 
-        logger.warning(reply["message"])
+        logger.error(
+            f"Error Request ID: {reply['request_id']}\n"
+            f"Error: {reply['message']} {reply['reason']}"
+        )
 
         # telemetry may not be present if there is an error while initializing
         if hasattr(self, "telemetry"):
@@ -103,7 +106,7 @@ class AquaAPIhandler(APIHandler):
                 category="aqua/error",
                 action=str(status_code),
                 value=reason,
-                **aqua_api_details
+                **aqua_api_details,
             )
 
         self.finish(json.dumps(reply))

ads/aqua/extension/deployment_handler.py

@@ -59,7 +59,7 @@ class AquaDeploymentHandler(AquaAPIhandler):
         return self.finish(AquaDeploymentApp().delete(model_deployment_id))
 
     @handle_exceptions
-    def put(self, *args, **kwargs):
+    def put(self, *args, **kwargs):  # noqa: ARG002
         """
         Handles put request for the activating and deactivating OCI datascience model deployments
         Raises
@@ -82,7 +82,7 @@ class AquaDeploymentHandler(AquaAPIhandler):
             raise HTTPError(400, f"The request {self.request.path} is invalid.")
 
     @handle_exceptions
-    def post(self, *args, **kwargs):
+    def post(self, *args, **kwargs):  # noqa: ARG002
         """
         Handles post request for the deployment APIs
         Raises
@@ -132,6 +132,8 @@ class AquaDeploymentHandler(AquaAPIhandler):
         private_endpoint_id = input_data.get("private_endpoint_id")
         container_image_uri = input_data.get("container_image_uri")
         cmd_var = input_data.get("cmd_var")
+        freeform_tags = input_data.get("freeform_tags")
+        defined_tags = input_data.get("defined_tags")
 
         self.finish(
             AquaDeploymentApp().create(
@@ -157,6 +159,8 @@ class AquaDeploymentHandler(AquaAPIhandler):
                 private_endpoint_id=private_endpoint_id,
                 container_image_uri=container_image_uri,
                 cmd_var=cmd_var,
+                freeform_tags=freeform_tags,
+                defined_tags=defined_tags,
             )
         )
 
@@ -196,7 +200,7 @@ class AquaDeploymentInferenceHandler(AquaAPIhandler):
             return False
 
     @handle_exceptions
-    def post(self, *args, **kwargs):
+    def post(self, *args, **kwargs):  # noqa: ARG002
         """
         Handles inference request for the Active Model Deployments
         Raises
@@ -262,7 +266,7 @@ class AquaDeploymentParamsHandler(AquaAPIhandler):
         )
 
     @handle_exceptions
-    def post(self, *args, **kwargs):
+    def post(self, *args, **kwargs):  # noqa: ARG002
         """Handles post request for the deployment param handler API.
 
         Raises

ads/aqua/extension/finetune_handler.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 
@@ -10,9 +10,7 @@ from tornado.web import HTTPError
 from ads.aqua.common.decorator import handle_exceptions
 from ads.aqua.extension.base_handler import AquaAPIhandler
 from ads.aqua.extension.errors import Errors
-from ads.aqua.extension.utils import validate_function_parameters
 from ads.aqua.finetuning import AquaFineTuningApp
-from ads.aqua.finetuning.entities import CreateFineTuningDetails
 
 
 class AquaFineTuneHandler(AquaAPIhandler):
@@ -33,7 +31,7 @@ class AquaFineTuneHandler(AquaAPIhandler):
             raise HTTPError(400, f"The request {self.request.path} is invalid.")
 
     @handle_exceptions
-    def post(self, *args, **kwargs):
+    def post(self, *args, **kwargs):  # noqa: ARG002
         """Handles post request for the fine-tuning API
 
         Raises
@@ -43,17 +41,13 @@ class AquaFineTuneHandler(AquaAPIhandler):
         """
         try:
             input_data = self.get_json_body()
-        except Exception:
-            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+        except Exception as ex:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT) from ex
 
         if not input_data:
             raise HTTPError(400, Errors.NO_INPUT_DATA)
 
-        validate_function_parameters(
-            data_class=CreateFineTuningDetails, input_data=input_data
-        )
-
-        self.finish(AquaFineTuningApp().create(CreateFineTuningDetails(**input_data)))
+        self.finish(AquaFineTuningApp().create(**input_data))
 
     def get_finetuning_config(self, model_id):
         """Gets the finetuning config for Aqua model."""
@@ -71,7 +65,7 @@ class AquaFineTuneParamsHandler(AquaAPIhandler):
         )
 
     @handle_exceptions
-    def post(self, *args, **kwargs):
+    def post(self, *args, **kwargs):  # noqa: ARG002
         """Handles post request for the finetuning param handler API.
 
         Raises
@@ -81,8 +75,8 @@ class AquaFineTuneParamsHandler(AquaAPIhandler):
         """
         try:
             input_data = self.get_json_body()
-        except Exception:
-            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+        except Exception as ex:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT) from ex
 
         if not input_data:
             raise HTTPError(400, Errors.NO_INPUT_DATA)