oracle-ads 2.13.5__py3-none-any.whl → 2.13.7__py3-none-any.whl

ads/aqua/finetuning/entities.py

@@ -3,7 +3,7 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import json
-from typing import List, Literal, Optional, Union
+from typing import Any, Dict, List, Literal, Optional, Union
 
 from pydantic import Field, model_validator
 
@@ -55,6 +55,28 @@ class AquaFineTuningParams(Serializable):
         return data
 
 
+class AquaFineTuningConfig(Serializable):
+    """Represents model's shape list and detailed configuration for fine-tuning.
+
+    Attributes:
+        shape (List[str], optional): A list of shape names (e.g., BM.GPU.A10.4).
+        configuration (Dict[str, Any], optional): Configuration details of fine-tuning.
+    """
+
+    shape: Optional[Dict[str, Any]] = Field(
+        default_factory=dict, description="List of supported shapes for the model."
+    )
+    finetuning_params: Optional[str] = Field(
+        default_factory=str, description="Fine tuning parameters."
+    )
+    configuration: Optional[Dict[str, Any]] = Field(
+        default_factory=dict, description="Configuration details keyed by shape."
+    )
+
+    class Config:
+        extra = "allow"
+
+
 class AquaFineTuningSummary(Serializable):
     """Represents a summary of Aqua Finetuning job."""
 

ads/aqua/finetuning/finetuning.py

@@ -20,8 +20,8 @@ from ads.aqua.app import AquaApp
 from ads.aqua.common.enums import Resource, Tags
 from ads.aqua.common.errors import AquaFileExistsError, AquaValueError
 from ads.aqua.common.utils import (
+    DEFINED_METADATA_TO_FILE_MAP,
     build_pydantic_error_message,
-    get_container_image,
     upload_local_to_os,
 )
 from ads.aqua.constants import (
@@ -38,17 +38,18 @@ from ads.aqua.finetuning.constants import (
     FineTuneCustomMetadata,
 )
 from ads.aqua.finetuning.entities import (
+    AquaFineTuningConfig,
     AquaFineTuningParams,
     AquaFineTuningSummary,
     CreateFineTuningDetails,
 )
+from ads.aqua.model.constants import AquaModelMetadataKeys
 from ads.common.auth import default_signer
 from ads.common.object_storage_details import ObjectStorageDetails
 from ads.common.utils import UNKNOWN, get_console_link
 from ads.config import (
     AQUA_FINETUNING_CONTAINER_OVERRIDE_FLAG_METADATA_NAME,
     AQUA_JOB_SUBNET_ID,
-    AQUA_MODEL_FINETUNING_CONFIG,
     COMPARTMENT_OCID,
     CONDA_BUCKET_NS,
     PROJECT_OCID,
@@ -312,7 +313,7 @@ class AquaFineTuningApp(AquaApp):
             compartment_id=target_compartment,
             project_id=target_project,
             model_by_reference=True,
-            defined_tags=create_fine_tuning_details.defined_tags
+            defined_tags=create_fine_tuning_details.defined_tags,
         )
 
         ft_job_freeform_tags = {
@@ -371,11 +372,11 @@ class AquaFineTuningApp(AquaApp):
             is_custom_container = True
 
         ft_parameters.batch_size = ft_parameters.batch_size or (
-            ft_config.get("shape", UNKNOWN_DICT)
+            (ft_config.shape if ft_config else UNKNOWN_DICT)
             .get(create_fine_tuning_details.shape_name, UNKNOWN_DICT)
             .get("batch_size", DEFAULT_FT_BATCH_SIZE)
         )
-        finetuning_params = ft_config.get("finetuning_params")
+        finetuning_params = ft_config.finetuning_params if ft_config else UNKNOWN
 
         ft_job.with_runtime(
             self._build_fine_tuning_runtime(
@@ -558,7 +559,7 @@ class AquaFineTuningApp(AquaApp):
     ) -> Runtime:
         """Builds fine tuning runtime for Job."""
         container = (
-            get_container_image(
+            self.get_container_image(
                 container_type=ft_container,
             )
             if not is_custom_container
@@ -626,7 +627,7 @@ class AquaFineTuningApp(AquaApp):
     @telemetry(
         entry_point="plugin=finetuning&action=get_finetuning_config", name="aqua"
     )
-    def get_finetuning_config(self, model_id: str) -> Dict:
+    def get_finetuning_config(self, model_id: str) -> AquaFineTuningConfig:
         """Gets the finetuning config for given Aqua model.
 
         Parameters
@@ -639,12 +640,25 @@ class AquaFineTuningApp(AquaApp):
         Dict:
             A dict of allowed finetuning configs.
         """
-        config = self.get_config(model_id, AQUA_MODEL_FINETUNING_CONFIG).config
+        config = self.get_config_from_metadata(
+            model_id, AquaModelMetadataKeys.FINE_TUNING_CONFIGURATION
+        ).config
+        if config:
+            logger.info(
+                f"Fetched {AquaModelMetadataKeys.FINE_TUNING_CONFIGURATION} from defined metadata for model: {model_id}."
+            )
+            return AquaFineTuningConfig(**(config or UNKNOWN_DICT))
+        config = self.get_config(
+            model_id,
+            DEFINED_METADATA_TO_FILE_MAP.get(
+                AquaModelMetadataKeys.FINE_TUNING_CONFIGURATION.lower()
+            ),
+        ).config
         if not config:
             logger.debug(
                 f"Fine-tuning config for custom model: {model_id} is not available. Use defaults."
             )
-        return config
+        return AquaFineTuningConfig(**(config or UNKNOWN_DICT))
 
     @telemetry(
         entry_point="plugin=finetuning&action=get_finetuning_default_params",
@@ -667,7 +681,9 @@ class AquaFineTuningApp(AquaApp):
         """
         default_params = {"params": {}}
         finetuning_config = self.get_finetuning_config(model_id)
-        config_parameters = finetuning_config.get("configuration", UNKNOWN_DICT)
+        config_parameters = (
+            finetuning_config.configuration if finetuning_config else UNKNOWN_DICT
+        )
         dataclass_fields = self._get_finetuning_params(
             config_parameters, validate=False
         ).to_dict()

ads/aqua/model/constants.py

@@ -50,3 +50,11 @@ class FineTuningCustomMetadata(ExtendedEnum):
     VALIDATION_METRICS_FINAL = "val_metrics_final"
     TRAINING_METRICS_EPOCH = "train_metrics_epoch"
     VALIDATION_METRICS_EPOCH = "val_metrics_epoch"
+
+
+class AquaModelMetadataKeys(ExtendedEnum):
+    FINE_TUNING_CONFIGURATION = "FineTuneConfiguration"
+    DEPLOYMENT_CONFIGURATION = "DeploymentConfiguration"
+    README = "Readme"
+    LICENSE = "License"
+    REPORTS = "Reports"

ads/aqua/model/entities.py

@@ -15,6 +15,7 @@ from typing import List, Optional
 
 import oci
 from huggingface_hub import hf_api
+from pydantic import BaseModel
 
 from ads.aqua import logger
 from ads.aqua.app import CLIBuilderMixin
@@ -29,6 +30,13 @@ from ads.model.datascience_model import DataScienceModel
 from ads.model.model_metadata import MetadataTaxonomyKeys
 
 
+class AquaModelReadme(BaseModel):
+    """Represents the response of Get Model Readme."""
+
+    id: str = field(default_factory=str)
+    model_card: str = field(default_factory=str)
+
+
 @dataclass(repr=False)
 class FineTuningShapeInfo(DataClassSerializable):
     instance_shape: str = field(default_factory=str)
@@ -95,7 +103,6 @@ class AquaModelSummary(DataClassSerializable):
 class AquaModel(AquaModelSummary, DataClassSerializable):
     """Represents an Aqua model."""
 
-    model_card: str = None
     inference_container: str = None
     inference_container_uri: str = None
     finetuning_container: str = None