oracle-ads 2.12.11__py3-none-any.whl → 2.13.1rc0__py3-none-any.whl

ads/aqua/app.py

@@ -6,14 +6,14 @@ import json
 import os
 import traceback
 from dataclasses import fields
-from typing import Dict, Union
+from typing import Dict, Optional, Union
 
 import oci
 from oci.data_science.models import UpdateModelDetails, UpdateModelProvenanceDetails
 
 from ads import set_auth
 from ads.aqua import logger
-from ads.aqua.common.enums import Tags
+from ads.aqua.common.enums import ConfigFolder, Tags
 from ads.aqua.common.errors import AquaRuntimeError, AquaValueError
 from ads.aqua.common.utils import (
     _is_valid_mvs,
@@ -268,7 +268,12 @@ class AquaApp:
                 logger.info(f"Artifact not found in model {model_id}.")
                 return False
 
-    def get_config(self, model_id: str, config_file_name: str) -> Dict:
+    def get_config(
+        self,
+        model_id: str,
+        config_file_name: str,
+        config_folder: Optional[str] = ConfigFolder.CONFIG,
+    ) -> Dict:
         """Gets the config for the given Aqua model.
 
         Parameters
@@ -277,12 +282,17 @@ class AquaApp:
             The OCID of the Aqua model.
         config_file_name: str
             name of the config file
+        config_folder: (str, optional):
+            subfolder path where config_file_name needs to be searched
+             Defaults to `ConfigFolder.CONFIG`.
+             When searching inside model artifact directory , the value is ConfigFolder.ARTIFACT`
 
         Returns
         -------
         Dict:
             A dict of allowed configs.
         """
+        config_folder = config_folder or ConfigFolder.CONFIG
         oci_model = self.ds_client.get_model(model_id).data
         oci_aqua = (
             (
@@ -304,23 +314,26 @@ class AquaApp:
                 f"Base model found for the model: {oci_model.id}. "
                 f"Loading {config_file_name} for base model {base_model_ocid}."
             )
-            base_model = self.ds_client.get_model(base_model_ocid).data
-            artifact_path = get_artifact_path(base_model.custom_metadata_list)
+            if config_folder == ConfigFolder.ARTIFACT:
+                artifact_path = get_artifact_path(oci_model.custom_metadata_list)
+            else:
+                base_model = self.ds_client.get_model(base_model_ocid).data
+                artifact_path = get_artifact_path(base_model.custom_metadata_list)
         else:
             logger.info(f"Loading {config_file_name} for model {oci_model.id}...")
             artifact_path = get_artifact_path(oci_model.custom_metadata_list)
-
         if not artifact_path:
             logger.debug(
                 f"Failed to get artifact path from custom metadata for the model: {model_id}"
             )
             return config
 
-        config_path = f"{os.path.dirname(artifact_path)}/config/"
+        config_path = os.path.join(os.path.dirname(artifact_path), config_folder)
         if not is_path_exists(config_path):
-            config_path = f"{artifact_path.rstrip('/')}/config/"
-
-        config_file_path = f"{config_path}{config_file_name}"
+            config_path = os.path.join(artifact_path.rstrip("/"), config_folder)
+            if not is_path_exists(config_path):
+                config_path = f"{artifact_path.rstrip('/')}/"
+        config_file_path = os.path.join(config_path, config_file_name)
         if is_path_exists(config_file_path):
             try:
                 config = load_config(

ads/aqua/common/enums.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/
 
 """
@@ -8,15 +8,15 @@ aqua.common.enums
 This module contains the set of enums used in AQUA.
 """
 
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 
 
-class DataScienceResource(str, metaclass=ExtendedEnumMeta):
+class DataScienceResource(ExtendedEnum):
     MODEL_DEPLOYMENT = "datasciencemodeldeployment"
     MODEL = "datasciencemodel"
 
 
-class Resource(str, metaclass=ExtendedEnumMeta):
+class Resource(ExtendedEnum):
     JOB = "jobs"
     JOBRUN = "jobruns"
     MODEL = "models"
@@ -24,7 +24,7 @@ class Resource(str, metaclass=ExtendedEnumMeta):
     MODEL_VERSION_SET = "model-version-sets"
 
 
-class Tags(str, metaclass=ExtendedEnumMeta):
+class Tags(ExtendedEnum):
     TASK = "task"
     LICENSE = "license"
     ORGANIZATION = "organization"
@@ -42,41 +42,41 @@ class Tags(str, metaclass=ExtendedEnumMeta):
     MODEL_ARTIFACT_FILE = "model_file"
 
 
-class InferenceContainerType(str, metaclass=ExtendedEnumMeta):
+class InferenceContainerType(ExtendedEnum):
     CONTAINER_TYPE_VLLM = "vllm"
     CONTAINER_TYPE_TGI = "tgi"
     CONTAINER_TYPE_LLAMA_CPP = "llama-cpp"
 
 
-class InferenceContainerTypeFamily(str, metaclass=ExtendedEnumMeta):
+class InferenceContainerTypeFamily(ExtendedEnum):
     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):
+class CustomInferenceContainerTypeFamily(ExtendedEnum):
     AQUA_TEI_CONTAINER_FAMILY = "odsc-tei-serving"
 
 
-class InferenceContainerParamType(str, metaclass=ExtendedEnumMeta):
+class InferenceContainerParamType(ExtendedEnum):
     PARAM_TYPE_VLLM = "VLLM_PARAMS"
     PARAM_TYPE_TGI = "TGI_PARAMS"
     PARAM_TYPE_LLAMA_CPP = "LLAMA_CPP_PARAMS"
 
 
-class EvaluationContainerTypeFamily(str, metaclass=ExtendedEnumMeta):
+class EvaluationContainerTypeFamily(ExtendedEnum):
     AQUA_EVALUATION_CONTAINER_FAMILY = "odsc-llm-evaluate"
 
 
-class FineTuningContainerTypeFamily(str, metaclass=ExtendedEnumMeta):
+class FineTuningContainerTypeFamily(ExtendedEnum):
     AQUA_FINETUNING_CONTAINER_FAMILY = "odsc-llm-fine-tuning"
 
 
-class HuggingFaceTags(str, metaclass=ExtendedEnumMeta):
+class HuggingFaceTags(ExtendedEnum):
     TEXT_GENERATION_INFERENCE = "text-generation-inference"
 
 
-class RqsAdditionalDetails(str, metaclass=ExtendedEnumMeta):
+class RqsAdditionalDetails(ExtendedEnum):
     METADATA = "metadata"
     CREATED_BY = "createdBy"
     DESCRIPTION = "description"
@@ -86,9 +86,14 @@ class RqsAdditionalDetails(str, metaclass=ExtendedEnumMeta):
     VERSION_LABEL = "versionLabel"
 
 
-class TextEmbeddingInferenceContainerParams(str, metaclass=ExtendedEnumMeta):
+class TextEmbeddingInferenceContainerParams(ExtendedEnum):
     """Contains a subset of params that are required for enabling model deployment in OCI Data Science. More options
     are available at https://huggingface.co/docs/text-embeddings-inference/en/cli_arguments"""
 
     MODEL_ID = "model-id"
     PORT = "port"
+
+
+class ConfigFolder(ExtendedEnum):
+    CONFIG = "config"
+    ARTIFACT = "artifact"

ads/aqua/common/errors.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/
 
 """
@@ -10,10 +9,10 @@ aqua.exception
 This module contains the set of Aqua exceptions.
 """
 
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 
 
-class ExitCode(str, metaclass=ExtendedEnumMeta):
+class ExitCode(ExtendedEnum):
     SUCCESS = 0
     COMMON_ERROR = 1
     INVALID_CONFIG = 10

ads/aqua/common/utils.py

@@ -65,7 +65,7 @@ from ads.aqua.constants import (
 from ads.aqua.data import AquaResourceIdentifier
 from ads.common.auth import AuthState, default_signer
 from ads.common.decorator.threaded import threaded
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 from ads.common.object_storage_details import ObjectStorageDetails
 from ads.common.oci_resource import SEARCH_TYPE, OCIResource
 from ads.common.utils import copy_file, get_console_link, upload_to_os
@@ -80,7 +80,7 @@ from ads.model import DataScienceModel, ModelVersionSet
 logger = logging.getLogger("ads.aqua")
 
 
-class LifecycleStatus(str, metaclass=ExtendedEnumMeta):
+class LifecycleStatus(ExtendedEnum):
     UNKNOWN = ""
 
     @property

ads/aqua/constants.py

@@ -10,6 +10,7 @@ UNKNOWN_DICT = {}
 README = "README.md"
 LICENSE_TXT = "config/LICENSE.txt"
 DEPLOYMENT_CONFIG = "deployment_config.json"
+AQUA_MODEL_TOKENIZER_CONFIG = "tokenizer_config.json"
 COMPARTMENT_MAPPING_KEY = "service-model-compartment"
 CONTAINER_INDEX = "container_index.json"
 EVALUATION_REPORT_JSON = "report.json"

ads/aqua/evaluation/constants.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/
 
 """
@@ -9,9 +8,10 @@ aqua.evaluation.const
 
 This module contains constants/enums used in Aqua Evaluation.
 """
+
 from oci.data_science.models import JobRun
 
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 
 EVAL_TERMINATION_STATE = [
     JobRun.LIFECYCLE_STATE_SUCCEEDED,
@@ -19,7 +19,7 @@ EVAL_TERMINATION_STATE = [
 ]
 
 
-class EvaluationCustomMetadata(str, metaclass=ExtendedEnumMeta):
+class EvaluationCustomMetadata(ExtendedEnum):
     EVALUATION_SOURCE = "evaluation_source"
     EVALUATION_JOB_ID = "evaluation_job_id"
     EVALUATION_JOB_RUN_ID = "evaluation_job_run_id"
@@ -28,11 +28,11 @@ class EvaluationCustomMetadata(str, metaclass=ExtendedEnumMeta):
     EVALUATION_ERROR = "aqua_evaluate_error"
 
 
-class EvaluationConfig(str, metaclass=ExtendedEnumMeta):
+class EvaluationConfig(ExtendedEnum):
     PARAMS = "model_params"
 
 
-class EvaluationReportJson(str, metaclass=ExtendedEnumMeta):
+class EvaluationReportJson(ExtendedEnum):
     """Contains evaluation report.json fields name."""
 
     METRIC_SUMMARY_RESULT = "metric_summary_result"
@@ -43,7 +43,7 @@ class EvaluationReportJson(str, metaclass=ExtendedEnumMeta):
     DATASET = "dataset"
 
 
-class EvaluationMetricResult(str, metaclass=ExtendedEnumMeta):
+class EvaluationMetricResult(ExtendedEnum):
     """Contains metric result's fields name in report.json."""
 
     SHORT_NAME = "key"

ads/aqua/evaluation/errors.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/
 """
 aqua.evaluation.errors
@@ -9,10 +8,10 @@ aqua.evaluation.errors
 This module contains errors in Aqua Evaluation.
 """
 
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 
 
-class EvaluationJobExitCode(str, metaclass=ExtendedEnumMeta):
+class EvaluationJobExitCode(ExtendedEnum):
     SUCCESS = 0
     COMMON_ERROR = 1
 

ads/aqua/extension/model_handler.py

@@ -14,6 +14,7 @@ from ads.aqua.common.enums import (
 from ads.aqua.common.errors import AquaRuntimeError, AquaValueError
 from ads.aqua.common.utils import (
     get_hf_model_info,
+    is_valid_ocid,
     list_hf_models,
 )
 from ads.aqua.extension.base_handler import AquaAPIhandler
@@ -316,8 +317,30 @@ class AquaHuggingFaceHandler(AquaAPIhandler):
         )
 
 
+class AquaModelTokenizerConfigHandler(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
+
+        """
+
+        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']
+        if (
+            len(path_list) == 4
+            and is_valid_ocid(path_list[2])
+            and path_list[3] == "tokenizer"
+        ):
+            return self.finish(AquaModelApp().get_hf_tokenizer_config(model_id))
+
+        raise HTTPError(400, f"The request {self.request.path} is invalid.")
+
+
 __handlers__ = [
     ("model/?([^/]*)", AquaModelHandler),
     ("model/?([^/]*)/license", AquaModelLicenseHandler),
+    ("model/?([^/]*)/tokenizer", AquaModelTokenizerConfigHandler),
     ("model/hf/search/?([^/]*)", AquaHuggingFaceHandler),
 ]

ads/aqua/extension/models/ws_models.py

@@ -1,20 +1,19 @@
 #!/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
 from typing import List, Optional
 
-from ads.aqua.evaluation.entities import AquaEvaluationSummary, AquaEvaluationDetail
-from ads.aqua.model.entities import AquaModelSummary, AquaModel
+from ads.aqua.evaluation.entities import AquaEvaluationDetail, AquaEvaluationSummary
+from ads.aqua.model.entities import AquaModel, AquaModelSummary
 from ads.aqua.modeldeployment.entities import AquaDeployment, AquaDeploymentDetail
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 from ads.common.serializer import DataClassSerializable
 
 
-class RequestResponseType(str, metaclass=ExtendedEnumMeta):
+class RequestResponseType(ExtendedEnum):
     ListEvaluations = "ListEvaluations"
     EvaluationDetails = "EvaluationDetails"
     ListDeployments = "ListDeployments"

ads/aqua/finetuning/constants.py

@@ -2,10 +2,10 @@
 # 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 ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 
 
-class FineTuneCustomMetadata(str, metaclass=ExtendedEnumMeta):
+class FineTuneCustomMetadata(ExtendedEnum):
     FINE_TUNE_SOURCE = "fine_tune_source"
     FINE_TUNE_SOURCE_NAME = "fine_tune_source_name"
     FINE_TUNE_OUTPUT_PATH = "fine_tune_output_path"
@@ -16,7 +16,7 @@ class FineTuneCustomMetadata(str, metaclass=ExtendedEnumMeta):
     SERVICE_MODEL_FINE_TUNE_CONTAINER = "finetune-container"
 
 
-class FineTuningRestrictedParams(str, metaclass=ExtendedEnumMeta):
+class FineTuningRestrictedParams(ExtendedEnum):
     OPTIMIZER = "optimizer"
 
 

ads/aqua/model/constants.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/
 
 """
@@ -9,10 +9,10 @@ aqua.model.constants
 This module contains constants/enums used in Aqua Model.
 """
 
-from ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 
 
-class ModelCustomMetadataFields(str, metaclass=ExtendedEnumMeta):
+class ModelCustomMetadataFields(ExtendedEnum):
     ARTIFACT_LOCATION = "artifact_location"
     DEPLOYMENT_CONTAINER = "deployment-container"
     EVALUATION_CONTAINER = "evaluation-container"
@@ -20,24 +20,24 @@ class ModelCustomMetadataFields(str, metaclass=ExtendedEnumMeta):
     DEPLOYMENT_CONTAINER_URI = "deployment-container-uri"
 
 
-class ModelTask(str, metaclass=ExtendedEnumMeta):
+class ModelTask(ExtendedEnum):
     TEXT_GENERATION = "text-generation"
     IMAGE_TEXT_TO_TEXT = "image-text-to-text"
     IMAGE_TO_TEXT = "image-to-text"
 
 
-class FineTuningMetricCategories(str, metaclass=ExtendedEnumMeta):
+class FineTuningMetricCategories(ExtendedEnum):
     VALIDATION = "validation"
     TRAINING = "training"
 
 
-class ModelType(str, metaclass=ExtendedEnumMeta):
+class ModelType(ExtendedEnum):
     FT = "FT"  # Fine Tuned Model
     BASE = "BASE"  # Base model
 
 
 # TODO: merge metadata key used in create FT
-class FineTuningCustomMetadata(str, metaclass=ExtendedEnumMeta):
+class FineTuningCustomMetadata(ExtendedEnum):
     FT_SOURCE = "fine_tune_source"
     FT_SOURCE_NAME = "fine_tune_source_name"
     FT_OUTPUT_PATH = "fine_tune_output_path"

ads/aqua/model/enums.py

@@ -1,18 +1,17 @@
 #!/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 ads.common.extended_enum import ExtendedEnumMeta
+from ads.common.extended_enum import ExtendedEnum
 
 
-class FineTuningDefinedMetadata(str, metaclass=ExtendedEnumMeta):
+class FineTuningDefinedMetadata(ExtendedEnum):
     """Represents the defined metadata keys used in Fine Tuning."""
 
     VAL_SET_SIZE = "val_set_size"
     TRAINING_DATA = "training_data"
 
 
-class FineTuningCustomMetadata(str, metaclass=ExtendedEnumMeta):
+class FineTuningCustomMetadata(ExtendedEnum):
     """Represents the custom metadata keys used in Fine Tuning."""
 
     FT_SOURCE = "fine_tune_source"

ads/aqua/model/model.py

@@ -15,6 +15,7 @@ from oci.data_science.models import JobRun, Metadata, Model, UpdateModelDetails
 from ads.aqua import ODSC_MODEL_COMPARTMENT_OCID, logger
 from ads.aqua.app import AquaApp
 from ads.aqua.common.enums import (
+    ConfigFolder,
     CustomInferenceContainerTypeFamily,
     FineTuningContainerTypeFamily,
     InferenceContainerTypeFamily,
@@ -44,6 +45,7 @@ from ads.aqua.constants import (
     AQUA_MODEL_ARTIFACT_CONFIG_MODEL_NAME,
     AQUA_MODEL_ARTIFACT_CONFIG_MODEL_TYPE,
     AQUA_MODEL_ARTIFACT_FILE,
+    AQUA_MODEL_TOKENIZER_CONFIG,
     AQUA_MODEL_TYPE_CUSTOM,
     HF_METADATA_FOLDER,
     LICENSE_TXT,
@@ -568,6 +570,26 @@ class AquaModelApp(AquaApp):
             training_final,
         ]
 
+    def get_hf_tokenizer_config(self, model_id):
+        """Gets the default chat template for the given Aqua model.
+
+        Parameters
+        ----------
+        model_id: str
+            The OCID of the Aqua model.
+
+        Returns
+        -------
+        str:
+            Chat template string.
+        """
+        config = self.get_config(
+            model_id, AQUA_MODEL_TOKENIZER_CONFIG, ConfigFolder.ARTIFACT
+        )
+        if not config:
+            logger.debug(f"Tokenizer config for model: {model_id} is not available.")
+        return config
+
     @staticmethod
     def to_aqua_model(
         model: Union[

ads/aqua/modeldeployment/entities.py

@@ -41,6 +41,7 @@ class AquaDeployment(DataClassSerializable):
     id: str = None
     display_name: str = None
     aqua_service_model: bool = None
+    model_id: str = None
     aqua_model_name: str = None
     state: str = None
     description: str = None
@@ -97,7 +98,7 @@ class AquaDeployment(DataClassSerializable):
                 else None
             ),
         )
-
+        model_id = oci_model_deployment._model_deployment_configuration_details.model_configuration_details.model_id
         tags = {}
         tags.update(oci_model_deployment.freeform_tags or UNKNOWN_DICT)
         tags.update(oci_model_deployment.defined_tags or UNKNOWN_DICT)
@@ -110,6 +111,7 @@ class AquaDeployment(DataClassSerializable):
 
         return AquaDeployment(
             id=oci_model_deployment.id,
+            model_id=model_id,
             display_name=oci_model_deployment.display_name,
             aqua_service_model=aqua_service_model_tag is not None,
             aqua_model_name=aqua_model_name,