Updated pr.

Author: lu-ohai

ads/aqua/modeldeployment/deployment.py

@@ -60,9 +60,9 @@
     AquaDeploymentDetail,
     ConfigurationItem,
     ConfigValidationError,
-    CreateModelDeploymentDetails,
     ModelDeploymentConfigSummary,
-    UpdateModelDeploymentDetails,
+    ModelDeploymentCreateSpec,
+    ModelDeploymentUpdateSpec,
 )
 from ads.aqua.modeldeployment.utils import MultiModelDeploymentConfigLoader
 from ads.common.object_storage_details import ObjectStorageDetails
@@ -120,16 +120,16 @@ class AquaDeploymentApp(AquaApp):
     @telemetry(entry_point="plugin=deployment&action=create", name="aqua")
     def create(
         self,
-        create_deployment_details: Optional[CreateModelDeploymentDetails] = None,
+        create_deployment_details: Optional[ModelDeploymentCreateSpec] = None,
         **kwargs,
     ) -> "AquaDeployment":
         """
         Creates a new Aqua model deployment.\n
         For detailed information about CLI flags see: https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/ai-quick-actions/cli-tips.md#create-model-deployment
 
         Args:
-            create_deployment_details : CreateModelDeploymentDetails, optional
-                An instance of CreateModelDeploymentDetails containing all required and optional
+            create_deployment_details : ModelDeploymentCreateSpec, optional
+                An instance of ModelDeploymentCreateSpec containing all required and optional
                 fields for creating a model deployment via Aqua.
             kwargs:
                 instance_shape (str): The instance shape used for deployment.
@@ -166,7 +166,7 @@ def create(
         # Build deployment details from kwargs if not explicitly provided.
         if create_deployment_details is None:
             try:
-                create_deployment_details = CreateModelDeploymentDetails(**kwargs)
+                create_deployment_details = ModelDeploymentCreateSpec(**kwargs)
             except ValidationError as ex:
                 custom_errors = build_pydantic_error_message(ex)
                 raise AquaValueError(
@@ -316,7 +316,7 @@ def create(
     def _create(
         self,
         aqua_model: DataScienceModel,
-        create_deployment_details: CreateModelDeploymentDetails,
+        create_deployment_details: ModelDeploymentCreateSpec,
         container_config: Dict,
     ) -> AquaDeployment:
         """Builds the configurations required by single model deployment and creates the deployment.
@@ -325,8 +325,8 @@ def _create(
         ----------
         aqua_model : DataScienceModel
             An instance of Aqua data science model.
-        create_deployment_details : CreateModelDeploymentDetails
-            An instance of CreateModelDeploymentDetails containing all required and optional
+        create_deployment_details : ModelDeploymentCreateSpec
+            An instance of ModelDeploymentCreateSpec containing all required and optional
             fields for creating a model deployment via Aqua.
         container_config: Dict
             Container config dictionary.
@@ -345,7 +345,7 @@ def _create(
             env_var,
             tags,
             cmd_var,
-        ) = self._get_container_details(
+        ) = self._get_runtime_config_from_model_deployment(
             aqua_model=aqua_model,
             deployment_details=create_deployment_details,
             container_config=container_config,
@@ -364,12 +364,10 @@ def _create(
             cmd_var=cmd_var,
         )
 
-    def _get_container_details(
+    def _get_runtime_config_from_model_deployment(
         self,
         aqua_model: DataScienceModel,
-        deployment_details: Union[
-            CreateModelDeploymentDetails, UpdateModelDeploymentDetails
-        ],
+        deployment_details: Union[ModelDeploymentCreateSpec, ModelDeploymentUpdateSpec],
         container_config: Dict,
     ):
         """Gets required or optional configurations for building container runtime of model deployment.
@@ -378,8 +376,8 @@ def _get_container_details(
         ----------
         aqua_model: DataScienceModel
             An instance of Aqua data science model.
-        deployment_details: Union[CreateModelDeploymentDetails, UpdateModelDeploymentDetails]
-            An instance of either CreateModelDeploymentDetails or UpdateModelDeploymentDetails containing all required and optional
+        deployment_details: Union[ModelDeploymentCreateSpec, ModelDeploymentUpdateSpec]
+            An instance of either ModelDeploymentCreateSpec or ModelDeploymentUpdateSpec containing all required and optional
             fields for creating or updating a model deployment via Aqua.
         container_config: Dict
             Container config dictionary.
@@ -608,7 +606,7 @@ def _create_multi(
         self,
         aqua_model: DataScienceModel,
         model_config_summary: ModelDeploymentConfigSummary,
-        create_deployment_details: CreateModelDeploymentDetails,
+        create_deployment_details: ModelDeploymentCreateSpec,
         container_config: AquaContainerConfig,
     ) -> AquaDeployment:
         """Builds the environment variables required by multi deployment container and creates the deployment.
@@ -619,8 +617,8 @@ def _create_multi(
             Summary Model Deployment configuration for the group of models.
         aqua_model : DataScienceModel
             An instance of Aqua data science model.
-        create_deployment_details : CreateModelDeploymentDetails
-            An instance of CreateModelDeploymentDetails containing all required and optional
+        create_deployment_details : ModelDeploymentCreateSpec
+            An instance of ModelDeploymentCreateSpec containing all required and optional
             fields for creating a model deployment via Aqua.
         container_config: Dict
             Container config dictionary.
@@ -752,7 +750,7 @@ def _create_multi(
 
     def _create_deployment(
         self,
-        create_deployment_details: CreateModelDeploymentDetails,
+        create_deployment_details: ModelDeploymentCreateSpec,
         aqua_model_id: str,
         model_name: str,
         model_type: str,
@@ -767,8 +765,8 @@ def _create_deployment(
 
         Parameters
         ----------
-        create_deployment_details : CreateModelDeploymentDetails
-            An instance of CreateModelDeploymentDetails containing all required and optional
+        create_deployment_details : ModelDeploymentCreateSpec
+            An instance of ModelDeploymentCreateSpec containing all required and optional
             fields for creating a model deployment via Aqua.
         aqua_model_id: str
             The id of the aqua model to be deployed.
@@ -963,16 +961,16 @@ def list(self, **kwargs) -> List["AquaDeployment"]:
     @telemetry(entry_point="plugin=deployment&action=update", name="aqua")
     def update(
         self,
-        update_deployment_details: Optional[UpdateModelDeploymentDetails] = None,
+        update_deployment_details: Optional[ModelDeploymentUpdateSpec] = None,
         **kwargs,
     ) -> "AquaDeployment":
         """
         Updates an Aqua model deployment.\n
         For detailed information about CLI flags see: https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/ai-quick-actions/cli-tips.md#update-model-deployment
 
         Args:
-            update_deployment_details : UpdateModelDeploymentDetails, optional
-                An instance of UpdateModelDeploymentDetails containing all required and optional
+            update_deployment_details : ModelDeploymentUpdateSpec, optional
+                An instance of ModelDeploymentUpdateSpec containing all required and optional
                 fields for updating a model deployment via Aqua.
             kwargs:
                 deployment_id (str): The OCID of model deployment to be update.
@@ -1008,7 +1006,7 @@ def update(
         # Build update deployment details from kwargs if not explicitly provided.
         if update_deployment_details is None:
             try:
-                update_deployment_details = UpdateModelDeploymentDetails(**kwargs)
+                update_deployment_details = ModelDeploymentUpdateSpec(**kwargs)
             except ValidationError as ex:
                 custom_errors = build_pydantic_error_message(ex)
                 raise AquaValueError(
@@ -1096,7 +1094,7 @@ def _update(
         self,
         model: DataScienceModel,
         model_deployment: ModelDeployment,
-        update_deployment_details: UpdateModelDeploymentDetails,
+        update_deployment_details: ModelDeploymentUpdateSpec,
     ):
         """Builds the configurations required by single model deployment and updates the deployment.
 
@@ -1106,8 +1104,8 @@ def _update(
             An instance of Aqua data science model.
         model_deployment : ModelDeployment
             An instance of Aqua model deployment.
-        update_deployment_details : UpdateModelDeploymentDetails
-            An instance of UpdateModelDeploymentDetails containing all required and optional
+        update_deployment_details : ModelDeploymentUpdateSpec
+            An instance of ModelDeploymentUpdateSpec containing all required and optional
             fields for updating a model deployment via Aqua.
         """
         infrastructure = model_deployment.infrastructure
@@ -1174,7 +1172,7 @@ def _update(
             env_var,
             tags,
             cmd_var,
-        ) = self._get_container_details(
+        ) = self._get_runtime_config_from_model_deployment(
             aqua_model=model,
             deployment_details=update_deployment_details,
             container_config=self.get_container_config(),

ads/aqua/modeldeployment/entities.py

@@ -406,7 +406,7 @@ class Config:
         extra = "allow"
 
 
-class ModelDeploymentBasicDetails(BaseModel):
+class ModelDeploymentSpec(BaseModel):
     """Class for Aqua model deployments basic details."""
 
     description: Optional[str] = Field(
@@ -483,7 +483,7 @@ class Config:
         extra = "ignore"
 
 
-class CreateModelDeploymentDetails(ModelDeploymentBasicDetails):
+class ModelDeploymentCreateSpec(ModelDeploymentSpec):
     """Class for creating Aqua model deployments."""
 
     instance_shape: str = Field(
@@ -676,7 +676,7 @@ class Config:
         protected_namespaces = ()
 
 
-class UpdateModelDeploymentDetails(ModelDeploymentBasicDetails):
+class ModelDeploymentUpdateSpec(ModelDeploymentSpec):
     """Class for updating Aqua model deployments."""
 
     deployment_id: str = Field(
@@ -688,4 +688,4 @@ class UpdateModelDeploymentDetails(ModelDeploymentBasicDetails):
     display_name: str = Field(None, description="The name of the model deployment.")
 
     class Config:
-        extra = "ignore"
+        extra = "allow"

tests/unitary/with_extras/aqua/test_deployment.py

@@ -41,7 +41,7 @@
     AquaDeploymentConfig,
     AquaDeploymentDetail,
     ConfigValidationError,
-    CreateModelDeploymentDetails,
+    ModelDeploymentCreateSpec,
     ModelDeploymentConfigSummary,
     ModelParams,
 )
@@ -1719,7 +1719,7 @@ def test_create_deployment_for_tei_byoc_embedding_model(
     @patch("ads.model.deployment.model_deployment.ModelDeployment.deploy")
     @patch("ads.aqua.modeldeployment.AquaDeploymentApp.get_deployment_config")
     @patch(
-        "ads.aqua.modeldeployment.entities.CreateModelDeploymentDetails.validate_multimodel_deployment_feasibility"
+        "ads.aqua.modeldeployment.entities.ModelDeploymentCreateSpec.validate_multimodel_deployment_feasibility"
     )
     def test_create_deployment_for_multi_model(
         self,
@@ -1840,7 +1840,9 @@ def test_create_deployment_for_multi_model(
         assert actual_attributes == expected_result
 
     @patch("ads.model.deployment.model_deployment.ModelDeployment.update")
-    @patch("ads.aqua.modeldeployment.AquaDeploymentApp._get_container_details")
+    @patch(
+        "ads.aqua.modeldeployment.AquaDeploymentApp._get_runtime_config_from_model_deployment"
+    )
     @patch.object(AquaApp, "get_container_config")
     @patch("ads.model.datascience_model.DataScienceModel.from_id")
     @patch("ads.model.deployment.model_deployment.ModelDeployment.from_id")
@@ -1849,7 +1851,7 @@ def test_update_single_model_deployment(
         mock_deployment,
         mock_model,
         mock_get_container_config,
-        mock_get_container_details,
+        mock_get_runtime_config_from_model_deployment,
         mock_update,
     ):
         mock_get_container_config.return_value = (
@@ -1880,7 +1882,7 @@ def test_update_single_model_deployment(
             )
         )
 
-        mock_get_container_details.return_value = (
+        mock_get_runtime_config_from_model_deployment.return_value = (
             None,
             None,
             "dsmc://image-name:1.0.0.0",
@@ -2117,15 +2119,15 @@ def validate_multimodel_deployment_feasibility_helper(
                 for x in models
             ]
 
-            mock_create_deployment_details = CreateModelDeploymentDetails(
+            mock_create_deployment_details = ModelDeploymentCreateSpec(
                 models=aqua_models,
                 instance_shape=instance_shape,
                 display_name=display_name,
                 freeform_tags={Tags.MULTIMODEL_TYPE_TAG: "true"},
             )
         else:
             model_id = "model_a"
-            mock_create_deployment_details = CreateModelDeploymentDetails(
+            mock_create_deployment_details = ModelDeploymentCreateSpec(
                 model_id=model_id,
                 instance_shape=instance_shape,
                 display_name=display_name,