added container runtime param instead of changing MC display name

Author: agrimk

ads/aqua/model/model.py

@@ -151,7 +151,6 @@ def create(
         compartment_id: Optional[str] = None,
         freeform_tags: Optional[Dict] = None,
         defined_tags: Optional[Dict] = None,
-        display_name: Optional[str] = None,
         **kwargs,
     ) -> DataScienceModel:
         """
@@ -170,8 +169,6 @@ def create(
             Freeform tags for the model.
         defined_tags : Optional[Dict]
             Defined tags for the model.
-        display_name: ptional[str]
-            The display name of the custom model.
 
         Returns
         -------
@@ -207,15 +204,11 @@ def create(
             **(defined_tags or {}),
         }
 
-        if display_name:
-            service_model.display_name = display_name
-
         custom_model = (
             DataScienceModel()
             .with_compartment_id(target_compartment)
             .with_project_id(target_project)
             .with_model_file_description(json_dict=service_model.model_file_description)
-            .with_display_name(service_model.display_name)
             .with_description(service_model.description)
             .with_freeform_tags(**combined_freeform_tags)
             .with_defined_tags(**combined_defined_tags)

ads/aqua/modeldeployment/deployment.py

@@ -227,7 +227,6 @@ def create(
             )
             aqua_model = model_app.create(
                 model_id=create_deployment_details.model_id,
-                display_name=create_deployment_details.model_name,
                 compartment_id=compartment_id,
                 project_id=project_id,
                 freeform_tags=freeform_tags,
@@ -758,6 +757,7 @@ def _create_deployment(
             .with_image(container_image_uri)
             .with_server_port(server_port)
             .with_health_check_port(health_check_port)
+            .with_custom_model_name(create_deployment_details.model_name)
             .with_env(env_var)
             .with_deployment_mode(ModelDeploymentMode.HTTPS)
             .with_model_uri(aqua_model_id)

ads/model/deployment/model_deployment_runtime.py

@@ -1,11 +1,11 @@
 #!/usr/bin/env python
-# -*- coding: utf-8; -*-
 
 # Copyright (c) 2023 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/from typing import Dict
 
 
 from typing import Dict, List
+
 from ads.jobs.builders.base import Builder
 
 MODEL_DEPLOYMENT_RUNTIME_KIND = "runtime"
@@ -519,6 +519,8 @@ class ModelDeploymentContainerRuntime(ModelDeploymentRuntime):
         The server port of model deployment container runtime.
     health_check_port: int
         The health check port of model deployment container runtime.
+    custom_model_name : str
+        The custom model name for single model deployment, to be used in predict calls
 
     Methods
     -------
@@ -534,6 +536,8 @@ class ModelDeploymentContainerRuntime(ModelDeploymentRuntime):
         Sets the server port of model deployment container runtime
     with_health_check_port(health_check_port)
         Sets the health check port of model deployment container runtime
+    with_custom_model_name(custom_model_name)
+        Sets a custom model name for single model deployment, to be used in predict calls
 
     Examples
     --------
@@ -560,6 +564,7 @@ class ModelDeploymentContainerRuntime(ModelDeploymentRuntime):
     CONST_SERVER_PORT = "serverPort"
     CONST_HEALTH_CHECK_PORT = "healthCheckPort"
     CONST_INFERENCE_SERVER = "inferenceServer"
+    CONST_CUSTOM_MODEL_NAME = "customModelName"
 
     attribute_map = {
         **ModelDeploymentRuntime.attribute_map,
@@ -570,6 +575,7 @@ class ModelDeploymentContainerRuntime(ModelDeploymentRuntime):
         CONST_SERVER_PORT: "server_port",
         CONST_HEALTH_CHECK_PORT: "health_check_port",
         CONST_INFERENCE_SERVER: "inference_server",
+        CONST_CUSTOM_MODEL_NAME: "custom_model_name",
     }
 
     payload_attribute_map = {
@@ -580,6 +586,7 @@ class ModelDeploymentContainerRuntime(ModelDeploymentRuntime):
         CONST_ENTRYPOINT: f"{ModelDeploymentRuntime.ENVIRONMENT_CONFIG_DETAILS_PATH}.entrypoint",
         CONST_SERVER_PORT: f"{ModelDeploymentRuntime.ENVIRONMENT_CONFIG_DETAILS_PATH}.server_port",
         CONST_HEALTH_CHECK_PORT: f"{ModelDeploymentRuntime.ENVIRONMENT_CONFIG_DETAILS_PATH}.health_check_port",
+        CONST_CUSTOM_MODEL_NAME: f"{ModelDeploymentRuntime.ENVIRONMENT_CONFIG_DETAILS_PATH}.custom_model_name",
     }
 
     @property
@@ -820,6 +827,62 @@ def with_inference_server(
         """
         return self.set_spec(self.CONST_INFERENCE_SERVER, inference_server.lower())
 
+    @property
+    def custom_model_name(self) -> str:
+        """Returns the custom model name.
+
+        Returns
+        -------
+        str
+            The custom model name.
+        """
+        return self.get_spec(self.CONST_CUSTOM_MODEL_NAME, None)
+
+    def with_custom_model_name(
+        self, custom_model_name: str = "odsc-llm"
+    ) -> "ModelDeploymentContainerRuntime":
+        """Sets the custom model name. Defaults to odsc-llm if you  do not set the custom model name.
+
+        Parameters
+        ----------
+        custom_model_name: str
+            Set the custom model name to be used for inferencing.
+
+        Returns
+        -------
+        ModelDeploymentContainerRuntime
+            The ModelDeploymentContainerRuntime instance (self).
+
+        Example
+        -------
+        >>> from ads.model.deployment import ModelDeployment, ModelDeploymentContainerRuntime, ModelDeploymentInfrastructure
+        >>> import ads
+        >>> ads.set_auth("resource_principal")
+        >>> infrastructure = ModelDeploymentInfrastructure()\
+        ...                 .with_project_id(<project_id>)\
+        ...                 .with_compartment_id(<comparment_id>)\
+        ...                 .with_shape_name("VM.Standard.E4.Flex")\
+        ...                 .with_replica(2)\
+        ...                 .with_bandwidth_mbps(10)\
+        ...                 .with_access_log(log_group_id=<deployment_log_group_id>, log_id=<deployment_access_log_id>)\
+        ...                 .with_predict_log(log_group_id=<deployment_log_group_id>, log_id=<deployment_predict_log_id>)
+
+        >>> runtime = ModelDeploymentContainerRuntime()\
+        ...                 .with_image(<container_image>)\
+        ...                 .with_server_port(<server_port>)\
+        ...                 .with_health_check_port(<health_check_port>)\
+        ...                 .with_model_uri(<model_id>)\
+        ...                 .with_env({"key":"value", "key2":"value2"})\
+        ...                 .with_inference_server("triton")
+        >>> deployment = ModelDeployment()\
+        ...                 .with_display_name("Triton Example")\
+        ...                 .with_infrastructure(infrastructure)\
+        ...                 .with_runtime(runtime)
+                            .with_custom_model_name("myModel")
+        >>> deployment.deploy()
+        """
+        return self.set_spec(self.CONST_CUSTOM_MODEL_NAME, custom_model_name)
+
     def init(self, **kwargs) -> "ModelDeploymentContainerRuntime":
         """Initializes a starter specification for the runtime.