[AQUA] Edit single model deployment #1162

lu-ohai · 2025-04-22T17:54:52Z

Edit single model deployment

Added new method update in AquaDeploymentApp to support editing model deployment.
Added more details in AquaDeploymentDetail for getting model deployment
- bandwidth_mbps
- inference_mode
- inference_container
- defined_tags
- freeform_tags

Unit test

tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_create_deployment_for_fine_tuned_model PASSED [  2%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_create_deployment_for_foundation_model PASSED [  4%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_create_deployment_for_gguf_model PASSED [  7%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_create_deployment_for_multi_model PASSED [  9%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_create_deployment_for_tei_byoc_embedding_model PASSED [ 12%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_deployment PASSED [ 14%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_deployment_config PASSED [ 17%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_deployment_default_params_0_VLLM_PARAMS <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 19%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_deployment_default_params_1_VLLM_PARAMS <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 21%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_deployment_default_params_2_TGI_PARAMS <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 24%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_deployment_default_params_3_CUSTOM_PARAMS <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 26%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_deployment_missing_tags PASSED [ 29%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_multi_model_deployment PASSED [ 31%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_multimodel_deployment_config_hybrid PASSED [ 34%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_get_multimodel_deployment_config_single PASSED [ 36%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_list_deployments PASSED [ 39%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_update_single_model_deployment PASSED [ 41%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_0_odsc_vllm_serving <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 43%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_1_odsc_vllm_serving <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 46%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_2_odsc_tgi_serving <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 48%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_3_custom_container_key <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 51%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_4_odsc_vllm_serving <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 53%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_5_odsc_tgi_serving <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 56%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_for_unverified_models_0_odsc_vllm_serving <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 58%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_for_unverified_models_1_odsc_tgi_serving <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 60%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_deployment_params_for_unverified_models_2_ <- ../../../../../Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/unittest/mock.py PASSED [ 63%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_0 PASSED [ 65%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_1 PASSED [ 68%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_2 PASSED [ 70%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_3 PASSED [ 73%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_4 PASSED [ 75%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_5 PASSED [ 78%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_single_0 PASSED [ 80%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_negative_single_1 PASSED [ 82%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_positive_0 PASSED [ 85%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_positive_1 PASSED [ 87%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_positive_2 PASSED [ 90%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_positive_single_0 PASSED [ 92%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_validate_multimodel_deployment_feasibility_positive_single_1 PASSED [ 95%]
tests/unitary/with_extras/aqua/test_deployment.py::TestAquaDeployment::test_verify_compatibility PASSED [ 97%]
tests/unitary/with_extras/aqua/test_deployment.py::TestMDInferenceResponse::test_get_model_deployment_response PASSED [100%]

===================================== 41 passed in 13.03s =====================================

Notebook

Edit display name

Edit description

Get model deployment

…ence into ODSC-68322/edit_single_model_deployment

github-actions · 2025-04-22T18:23:56Z

📌 Cov diff with main:

📌 Overall coverage:

github-actions · 2025-04-24T18:07:15Z

📌 Cov diff with main:

📌 Overall coverage:

mrDzurb · 2025-04-22T23:47:08Z

ads/aqua/modeldeployment/entities.py

@@ -391,15 +406,9 @@ class Config:
        extra = "allow"


-class CreateModelDeploymentDetails(BaseModel):
-    """Class for creating Aqua model deployments."""
+class ModelDeploymentBasicDetails(BaseModel):


NIT: maybe ModelDeploymentSpec?

mrDzurb · 2025-04-22T23:47:53Z

ads/aqua/modeldeployment/entities.py

@@ -470,6 +479,20 @@ class CreateModelDeploymentDetails(BaseModel):
        None, description="Defined tags for model deployment."
    )

+    class Config:
+        extra = "ignore"


let's allow the extra fields, just in case

mrDzurb · 2025-04-22T23:50:02Z

ads/aqua/modeldeployment/entities.py

+        extra = "ignore"
+
+
+class CreateModelDeploymentDetails(ModelDeploymentBasicDetails):


I would also rename this to ModelDeploymentCreateSpec, however this might bring many changes.

mrDzurb · 2025-04-24T18:25:53Z

ads/aqua/modeldeployment/deployment.py

+            cmd_var=cmd_var,
+        )
+
+    def _get_container_details(


Maybe we can think about more suitable name for this method?

_extract_model_deployment_runtime_config _get_runtime_config_from_model_deployment

mrDzurb · 2025-04-24T18:28:33Z

ads/aqua/modeldeployment/deployment.py

@@ -329,6 +336,58 @@ def _create(
        AquaDeployment
            An Aqua deployment instance.
        """
+        (


I'm not a big fan of returning the result in this format. I would suggest using a Pydantic class to represent the model deployment runtime configuration. Eventually, we might have two classes: one for single model deployments and another for multi-model deployments.

I can modify this together with updating multi model deployment so that I can have a better picture of this implementation.

mrDzurb · 2025-04-24T18:32:01Z

ads/aqua/modeldeployment/deployment.py

+            update_deployment_details.deployment_id
+        )
+
+        if aqua_deployment.lifecycle_state != State.ACTIVE.name:


We should verify whether a Model Deployment can be updated while in a failed state. For instance, if a user provides an incorrect configuration, resulting in a failed deployment, can they subsequently correct the configuration and update the MD? From a service perspective, is this scenario supported? We should investigate this use case to ensure proper handling.

The service end takes care of this, that is, if a model deployment fails to be updated due to incorrect configurations passed in, the model deployment will remain the same as ACTIVE. We can keep track of this failure from the workrequest, but I'm not quite sure if we should block the process while waiting for the update workrequest to be done.

github-actions · 2025-04-25T02:58:20Z

📌 Cov diff with main:

📌 Overall coverage:

lu-ohai added 8 commits April 22, 2025 00:36

Added support to edit single model deployment.

094e91e

Merge branch 'main' of https://github.com/oracle/accelerated-data-sci…

42b9eba

…ence into ODSC-68322/edit_single_model_deployment

Updated pr.

5ca8b60

Updated pr.

5f824db

Updated pr.

bf7a281

Updated pr.

253a9b5

Updated pr.

400f619

Updated pr.

7b02d3f

lu-ohai requested review from darenr, mayoor, mrDzurb, VipulMascarenhas, qiuosier and ahosler as code owners April 22, 2025 17:54

oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Apr 22, 2025

mrDzurb changed the title ~~Edit single model deployment~~ [AQUA] Edit single model deployment Apr 22, 2025

Updated pr.

bc57a23

mrDzurb reviewed Apr 24, 2025

View reviewed changes

lu-ohai added 2 commits April 24, 2025 22:25

Updated pr.

8dcb254

Updated pr.

fe81574

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[AQUA] Edit single model deployment #1162

[AQUA] Edit single model deployment #1162

lu-ohai commented Apr 22, 2025

github-actions bot commented Apr 22, 2025

github-actions bot commented Apr 24, 2025

mrDzurb Apr 22, 2025

lu-ohai Apr 25, 2025

mrDzurb Apr 22, 2025

lu-ohai Apr 25, 2025

mrDzurb Apr 22, 2025

lu-ohai Apr 25, 2025

mrDzurb Apr 24, 2025

lu-ohai Apr 25, 2025

mrDzurb Apr 24, 2025

lu-ohai Apr 25, 2025

mrDzurb Apr 24, 2025

lu-ohai Apr 25, 2025

github-actions bot commented Apr 25, 2025

		extra = "ignore"


		class CreateModelDeploymentDetails(ModelDeploymentBasicDetails):

[AQUA] Edit single model deployment #1162

Are you sure you want to change the base?

[AQUA] Edit single model deployment #1162

Conversation

lu-ohai commented Apr 22, 2025

Edit single model deployment

Unit test

Notebook

github-actions bot commented Apr 22, 2025

github-actions bot commented Apr 24, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 25, 2025