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

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/finetuning/finetuning.py

@@ -30,7 +30,6 @@ from ads.aqua.constants import (
     DEFAULT_FT_REPLICA,
     DEFAULT_FT_VALIDATION_SET_SIZE,
     JOB_INFRASTRUCTURE_TYPE_DEFAULT_NETWORKING,
-    UNKNOWN,
     UNKNOWN_DICT,
 )
 from ads.aqua.data import AquaResourceIdentifier
@@ -45,7 +44,7 @@ from ads.aqua.finetuning.entities import (
 )
 from ads.common.auth import default_signer
 from ads.common.object_storage_details import ObjectStorageDetails
-from ads.common.utils import get_console_link
+from ads.common.utils import UNKNOWN, get_console_link
 from ads.config import (
     AQUA_FINETUNING_CONTAINER_OVERRIDE_FLAG_METADATA_NAME,
     AQUA_JOB_SUBNET_ID,
@@ -592,7 +591,7 @@ class AquaFineTuningApp(AquaApp):
         Dict:
             A dict of allowed finetuning configs.
         """
-        config = self.get_config(model_id, AQUA_MODEL_FINETUNING_CONFIG)
+        config = self.get_config(model_id, AQUA_MODEL_FINETUNING_CONFIG).config
         if not config:
             logger.debug(
                 f"Fine-tuning config for custom model: {model_id} is not available. Use defaults."

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/entities.py

@@ -23,7 +23,6 @@ from ads.aqua.constants import LIFECYCLE_DETAILS_MISSING_JOBRUN, UNKNOWN_VALUE
 from ads.aqua.data import AquaResourceIdentifier
 from ads.aqua.model.enums import FineTuningDefinedMetadata
 from ads.aqua.training.exceptions import exit_code_dict
-from ads.aqua.ui import ModelFormat
 from ads.common.serializer import DataClassSerializable
 from ads.common.utils import get_log_links
 from ads.model.datascience_model import DataScienceModel
@@ -46,7 +45,7 @@ class AquaFineTuneValidation(DataClassSerializable):
 @dataclass(repr=False)
 class ModelValidationResult:
     model_file: Optional[str] = None
-    model_formats: List[ModelFormat] = field(default_factory=list)
+    model_formats: List[str] = field(default_factory=list)
     telemetry_model_name: str = None
     tags: Optional[dict] = None
 
@@ -89,7 +88,7 @@ class AquaModelSummary(DataClassSerializable):
     nvidia_gpu_supported: bool = False
     arm_cpu_supported: bool = False
     model_file: Optional[str] = None
-    model_formats: List[ModelFormat] = field(default_factory=list)
+    model_formats: List[str] = field(default_factory=list)
 
 
 @dataclass(repr=False)

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,9 +15,12 @@ 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,
+    ModelFormat,
+    Platform,
     Tags,
 )
 from ads.aqua.common.errors import (
@@ -39,11 +42,13 @@ from ads.aqua.common.utils import (
     read_file,
     upload_folder,
 )
+from ads.aqua.config.container_config import AquaContainerConfig
 from ads.aqua.constants import (
     AQUA_MODEL_ARTIFACT_CONFIG,
     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,
@@ -54,7 +59,6 @@ from ads.aqua.constants import (
     READY_TO_IMPORT_STATUS,
     TRAINING_METRICS_FINAL,
     TRINING_METRICS,
-    UNKNOWN,
     VALIDATION_METRICS,
     VALIDATION_METRICS_FINAL,
 )
@@ -71,13 +75,11 @@ from ads.aqua.model.entities import (
     AquaModelLicense,
     AquaModelSummary,
     ImportModelDetails,
-    ModelFormat,
     ModelValidationResult,
 )
-from ads.aqua.ui import AquaContainerConfig, AquaContainerConfigItem
 from ads.common.auth import default_signer
 from ads.common.oci_resource import SEARCH_TYPE, OCIResource
-from ads.common.utils import get_console_link
+from ads.common.utils import UNKNOWN, get_console_link
 from ads.config import (
     AQUA_DEPLOYMENT_CONTAINER_CMD_VAR_METADATA_NAME,
     AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME,
@@ -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
+        ).config
+        if not config:
+            logger.debug(f"Tokenizer config for model: {model_id} is not available.")
+        return config
+
     @staticmethod
     def to_aqua_model(
         model: Union[
@@ -645,28 +667,24 @@ class AquaModelApp(AquaApp):
         except Exception:
             model_file = UNKNOWN
 
-        inference_containers = AquaContainerConfig.from_container_index_json().inference
+        inference_containers = AquaContainerConfig.from_container_index_json(
+            config=get_container_config()
+        ).inference
 
         model_formats_str = freeform_tags.get(
-            Tags.MODEL_FORMAT, ModelFormat.SAFETENSORS.value
+            Tags.MODEL_FORMAT, ModelFormat.SAFETENSORS
         ).upper()
-        model_formats = [
-            ModelFormat[model_format] for model_format in model_formats_str.split(",")
-        ]
+        model_formats = model_formats_str.split(",")
 
-        supported_platform: Set[AquaContainerConfigItem.Platform] = set()
+        supported_platform: Set[str] = set()
 
         for container in inference_containers.values():
             for model_format in model_formats:
                 if model_format in container.model_formats:
                     supported_platform.update(container.platforms)
 
-        nvidia_gpu_supported = (
-            AquaContainerConfigItem.Platform.NVIDIA_GPU in supported_platform
-        )
-        arm_cpu_supported = (
-            AquaContainerConfigItem.Platform.ARM_CPU in supported_platform
-        )
+        nvidia_gpu_supported = Platform.NVIDIA_GPU in supported_platform
+        arm_cpu_supported = Platform.ARM_CPU in supported_platform
 
         return {
             "compartment_id": model.compartment_id,
@@ -876,8 +894,7 @@ class AquaModelApp(AquaApp):
             tags.update(
                 {
                     Tags.MODEL_FORMAT: ",".join(
-                        model_format.value
-                        for model_format in validation_result.model_formats
+                        model_format for model_format in validation_result.model_formats
                     )
                 }
             )
@@ -914,9 +931,9 @@ class AquaModelApp(AquaApp):
                     category="Other",
                 )
 
-            inference_containers = (
-                AquaContainerConfig.from_container_index_json().inference
-            )
+            inference_containers = AquaContainerConfig.from_container_index_json(
+                config=get_container_config()
+            ).inference
             smc_container_set = {
                 container.family for container in inference_containers.values()
             }
@@ -991,13 +1008,13 @@ class AquaModelApp(AquaApp):
         return model
 
     @staticmethod
-    def get_model_files(os_path: str, model_format: ModelFormat) -> List[str]:
+    def get_model_files(os_path: str, model_format: str) -> List[str]:
         """
         Get a list of model files based on the given OS path and model format.
 
         Args:
             os_path (str): The OS path where the model files are located.
-            model_format (ModelFormat): The format of the model files.
+            model_format (str): The format of the model files.
 
         Returns:
             List[str]: A list of model file names.
@@ -1037,13 +1054,13 @@ class AquaModelApp(AquaApp):
         return model_files
 
     @staticmethod
-    def get_hf_model_files(model_name: str, model_format: ModelFormat) -> List[str]:
+    def get_hf_model_files(model_name: str, model_format: str) -> List[str]:
         """
         Get a list of model files based on the given OS path and model format.
 
         Args:
             model_name (str): The huggingface model name.
-            model_format (ModelFormat): The format of the model files.
+            model_format (str): The format of the model files.
 
         Returns:
             List[str]: A list of model file names.
@@ -1075,7 +1092,7 @@ class AquaModelApp(AquaApp):
                 and model_sibling.rfilename == AQUA_MODEL_ARTIFACT_CONFIG
             ):
                 model_files.append(model_sibling.rfilename)
-            if extension == model_format.value:
+            if extension == model_format:
                 model_files.append(model_sibling.rfilename)
 
         logger.debug(
@@ -1130,8 +1147,8 @@ class AquaModelApp(AquaApp):
 
         if not (safetensors_model_files or gguf_model_files):
             raise AquaRuntimeError(
-                f"The model {model_name} does not contain either {ModelFormat.SAFETENSORS.value} "
-                f"or {ModelFormat.GGUF.value} files in {import_model_details.os_path} or Hugging Face repository. "
+                f"The model {model_name} does not contain either {ModelFormat.SAFETENSORS} "
+                f"or {ModelFormat.GGUF} files in {import_model_details.os_path} or Hugging Face repository. "
                 f"Please check if the path is correct or the model artifacts are available at this location."
             )
 
@@ -1239,7 +1256,7 @@ class AquaModelApp(AquaApp):
             ):
                 raise AquaRuntimeError(
                     f"The model {model_name} does not contain {AQUA_MODEL_ARTIFACT_CONFIG} file as required "
-                    f"by {ModelFormat.SAFETENSORS.value} format model."
+                    f"by {ModelFormat.SAFETENSORS} format model."
                     f" Please check if the model name is correct in Hugging Face repository."
                 )
             validation_result.telemetry_model_name = model_name

ads/aqua/modeldeployment/deployment.py

@@ -7,10 +7,7 @@ from typing import Dict, List, Optional, Union
 
 from ads.aqua.app import AquaApp, logger
 from ads.aqua.common.entities import ContainerSpec
-from ads.aqua.common.enums import (
-    InferenceContainerTypeFamily,
-    Tags,
-)
+from ads.aqua.common.enums import InferenceContainerTypeFamily, ModelFormat, Tags
 from ads.aqua.common.errors import AquaRuntimeError, AquaValueError
 from ads.aqua.common.utils import (
     get_combined_params,
@@ -30,19 +27,14 @@ from ads.aqua.constants import (
     AQUA_MODEL_TYPE_CUSTOM,
     AQUA_MODEL_TYPE_SERVICE,
     MODEL_BY_REFERENCE_OSS_PATH_KEY,
-    UNKNOWN,
     UNKNOWN_DICT,
 )
 from ads.aqua.data import AquaResourceIdentifier
 from ads.aqua.finetuning.finetuning import FineTuneCustomMetadata
 from ads.aqua.model import AquaModelApp
-from ads.aqua.modeldeployment.entities import (
-    AquaDeployment,
-    AquaDeploymentDetail,
-)
-from ads.aqua.ui import ModelFormat
+from ads.aqua.modeldeployment.entities import AquaDeployment, AquaDeploymentDetail
 from ads.common.object_storage_details import ObjectStorageDetails
-from ads.common.utils import get_log_links
+from ads.common.utils import UNKNOWN, get_log_links
 from ads.config import (
     AQUA_DEPLOYMENT_CONTAINER_CMD_VAR_METADATA_NAME,
     AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME,
@@ -293,13 +285,13 @@ class AquaDeploymentApp(AquaApp):
             )
 
         model_formats_str = aqua_model.freeform_tags.get(
-            Tags.MODEL_FORMAT, ModelFormat.SAFETENSORS.value
+            Tags.MODEL_FORMAT, ModelFormat.SAFETENSORS
         ).upper()
         model_format = model_formats_str.split(",")
 
         # Figure out a better way to handle this in future release
         if (
-            ModelFormat.GGUF.value in model_format
+            ModelFormat.GGUF in model_format
             and container_type_key.lower()
             == InferenceContainerTypeFamily.AQUA_LLAMA_CPP_CONTAINER_FAMILY
         ):
@@ -661,7 +653,7 @@ class AquaDeploymentApp(AquaApp):
         Dict:
             A dict of allowed deployment configs.
         """
-        config = self.get_config(model_id, AQUA_MODEL_DEPLOYMENT_CONFIG)
+        config = self.get_config(model_id, AQUA_MODEL_DEPLOYMENT_CONFIG).config
         if not config:
             logger.debug(
                 f"Deployment config for custom model: {model_id} is not available. Use defaults."

ads/aqua/modeldeployment/entities.py

@@ -11,10 +11,10 @@ from oci.data_science.models import (
 )
 
 from ads.aqua.common.enums import Tags
-from ads.aqua.constants import UNKNOWN, UNKNOWN_DICT
+from ads.aqua.constants import UNKNOWN_DICT
 from ads.aqua.data import AquaResourceIdentifier
 from ads.common.serializer import DataClassSerializable
-from ads.common.utils import get_console_link
+from ads.common.utils import UNKNOWN, get_console_link
 
 
 @dataclass
@@ -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,

ads/aqua/server/__init__.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2025 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

ads/aqua/server/__main__.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+
+# Copyright (c) 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 os
+from logging import getLogger
+
+from dotenv import load_dotenv
+
+from ads.aqua.server.app import start_server
+
+logger = getLogger(__name__)
+config_location = os.path.join(os.getcwd(), ".env")
+if os.path.exists(config_location):
+    logger.info(f"Loading environment variables from {config_location}")
+    load_dotenv(dotenv_path=config_location)
+    logger.info("Environment variables loaded successfully")
+else:
+    logger.warning(
+        f"{config_location} not found. Consider using `.env` file to setup default environment variables"
+    )
+
+start_server()

ads/aqua/server/app.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+
+# Copyright (c) 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 os
+from logging import getLogger
+
+import tornado.ioloop
+import tornado.web
+
+from ads.aqua.extension import __handlers__
+
+logger = getLogger(__name__)
+AQUA_PORT = "AQUA_PORT"
+AQUA_HOST = "AQUA_HOST"
+AQUA_PROCESS_COUNT = "AQUA_PROCESS_COUNT"
+AQUA_CORS_ENABLE = "AQUA_CORS_ENABLE"
+
+URL_PATTERN = r"/aqua/"
+
+
+def prepare(self):
+    self.set_header("Access-Control-Allow-Origin", "*")
+
+
+def make_app():
+    # Patch the prepare method to allow CORS request
+    if os.environ.get(AQUA_CORS_ENABLE, "0") == "1":
+        for _, handler in __handlers__:
+            handler.prepare = prepare
+    handlers = [(URL_PATTERN + url, handler) for url, handler in __handlers__]
+    # logger.debug(handlers)
+    return tornado.web.Application(handlers)
+
+
+def start_server():
+    app = make_app()
+    server = tornado.httpserver.HTTPServer(app)
+    port = int(os.environ.get(AQUA_PORT, 8080))
+    host = os.environ.get(AQUA_HOST, "0.0.0.0")
+    processes = int(os.environ.get(AQUA_PROCESS_COUNT, 0))
+    server.bind(port=port, address=host)
+    server.start(processes)
+    logger.info(f"Starting the server from directory: {os.getcwd()}")
+    logger.info(f"Aqua API server running on http://{host}:{port}")
+    tornado.ioloop.IOLoop.current().start()