Validate FT and MD parameter overrides (#845)

Author: VipulMascarenhas

ads/aqua/common/utils.py

@@ -755,3 +755,72 @@ def upload_folder(os_path: str, local_dir: str, model_name: str) -> str:
 
 def is_service_managed_container(container):
     return container and container.startswith(SERVICE_MANAGED_CONTAINER_URI_SCHEME)
+
+
+def get_params_list(params: str) -> List[str]:
+    """Parses the string parameter and returns a list of params.
+
+    Parameters
+    ----------
+    params
+        string parameters by separated by -- delimiter
+
+    Returns
+    -------
+        list of params
+
+    """
+    if not params:
+        return []
+    return ["--" + param.strip() for param in params.split("--")[1:]]
+
+
+def get_params_dict(params: Union[str, List[str]]) -> dict:
+    """Accepts a string or list of string of double-dash parameters and returns a dict with the parameter keys and values.
+
+    Parameters
+    ----------
+    params:
+        List of parameters or parameter string separated by space.
+
+    Returns
+    -------
+        dict containing parameter keys and values
+
+    """
+    params_list = get_params_list(params) if isinstance(params, str) else params
+    return {
+        split_result[0]: split_result[1] if len(split_result) > 1 else UNKNOWN
+        for split_result in (x.split() for x in params_list)
+    }
+
+
+def get_combined_params(params1: str = None, params2: str = None) -> str:
+    """
+    Combines string of double-dash parameters, and overrides the values from the second string in the first.
+    Parameters
+    ----------
+    params1:
+        Parameter string with values
+    params2:
+        Parameter string with values that need to be overridden.
+
+    Returns
+    -------
+        A combined list with overridden values from params2.
+    """
+    if not params1:
+        return params2
+    if not params2:
+        return params1
+
+    # overwrite values from params2 into params1
+    combined_params = [
+        f"{key} {value}" if value else key
+        for key, value in {
+            **get_params_dict(params1),
+            **get_params_dict(params2),
+        }.items()
+    ]
+
+    return " ".join(combined_params)

ads/aqua/extension/deployment_handler.py

@@ -94,6 +94,10 @@ def post(self, *args, **kwargs):
         description = input_data.get("description")
         instance_count = input_data.get("instance_count")
         bandwidth_mbps = input_data.get("bandwidth_mbps")
+        web_concurrency = input_data.get("web_concurrency")
+        server_port = input_data.get("server_port")
+        health_check_port = input_data.get("health_check_port")
+        env_var = input_data.get("env_var")
 
         self.finish(
             AquaDeploymentApp().create(
@@ -108,6 +112,10 @@ def post(self, *args, **kwargs):
                 access_log_id=access_log_id,
                 predict_log_id=predict_log_id,
                 bandwidth_mbps=bandwidth_mbps,
+                web_concurrency=web_concurrency,
+                server_port=server_port,
+                health_check_port=health_check_port,
+                env_var=env_var,
             )
         )
 
@@ -194,29 +202,59 @@ def post(self, *args, **kwargs):
 
 
 class AquaDeploymentParamsHandler(AquaAPIhandler):
-    """Handler for Aqua finetuning params REST APIs.
+    """Handler for Aqua deployment params REST APIs.
 
     Methods
     -------
     get(self, model_id)
         Retrieves a list of model deployment parameters.
+    post(self, *args, **kwargs)
+        Validates parameters for the given model id.
     """
 
     @handle_exceptions
     def get(self, model_id):
         """Handle GET request."""
-        model_id = model_id.split("/")[0]
         instance_shape = self.get_argument("instance_shape")
         return self.finish(
             AquaDeploymentApp().get_deployment_default_params(
                 model_id=model_id, instance_shape=instance_shape
             )
         )
 
+    @handle_exceptions
+    def post(self, *args, **kwargs):
+        """Handles post request for the deployment param handler API.
+
+        Raises
+        ------
+        HTTPError
+            Raises HTTPError if inputs are missing or are invalid.
+        """
+        try:
+            input_data = self.get_json_body()
+        except Exception:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+
+        if not input_data:
+            raise HTTPError(400, Errors.NO_INPUT_DATA)
+
+        model_id = input_data.get("model_id")
+        if not model_id:
+            raise HTTPError(400, Errors.MISSING_REQUIRED_PARAMETER.format("model_id"))
+
+        params = input_data.get("params")
+        return self.finish(
+            AquaDeploymentApp().validate_deployment_params(
+                model_id=model_id,
+                params=params,
+            )
+        )
+
 
 __handlers__ = [
-    ("deployments/?([^/]*)", AquaDeploymentHandler),
+    ("deployments/?([^/]*)/params", AquaDeploymentParamsHandler),
     ("deployments/config/?([^/]*)", AquaDeploymentHandler),
-    ("deployments/?([^/]*/params)", AquaDeploymentParamsHandler),
+    ("deployments/?([^/]*)", AquaDeploymentHandler),
     ("inference", AquaDeploymentInferenceHandler),
 ]

ads/aqua/extension/finetune_handler.py

@@ -70,9 +70,33 @@ def get(self, model_id):
             AquaFineTuningApp().get_finetuning_default_params(model_id=model_id)
         )
 
+    @handle_exceptions
+    def post(self, *args, **kwargs):
+        """Handles post request for the finetuning param handler API.
+
+        Raises
+        ------
+        HTTPError
+            Raises HTTPError if inputs are missing or are invalid.
+        """
+        try:
+            input_data = self.get_json_body()
+        except Exception:
+            raise HTTPError(400, Errors.INVALID_INPUT_DATA_FORMAT)
+
+        if not input_data:
+            raise HTTPError(400, Errors.NO_INPUT_DATA)
+
+        params = input_data.get("params", None)
+        return self.finish(
+            AquaFineTuningApp().validate_finetuning_params(
+                params=params,
+            )
+        )
+
 
 __handlers__ = [
+    ("finetuning/?([^/]*)/params", AquaFineTuneParamsHandler),
     ("finetuning/?([^/]*)", AquaFineTuneHandler),
     ("finetuning/config/?([^/]*)", AquaFineTuneHandler),
-    ("finetuning/([^/]*)/params", AquaFineTuneParamsHandler),
 ]

ads/aqua/finetuning/finetuning.py

@@ -18,7 +18,11 @@
 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 get_container_image, upload_local_to_os
+from ads.aqua.common.utils import (
+    get_container_image,
+    upload_local_to_os,
+    get_params_dict,
+)
 from ads.aqua.constants import (
     DEFAULT_FT_BATCH_SIZE,
     DEFAULT_FT_BLOCK_STORAGE_SIZE,
@@ -583,3 +587,32 @@ def get_finetuning_default_params(self, model_id: str) -> List[str]:
                 default_params.append(f"--{name} {str(value).lower()}")
 
         return default_params
+
+    def validate_finetuning_params(self, params: List[str] = None) -> Dict:
+        """Validate if the fine-tuning parameters passed by the user can be overridden. Parameter values are not
+        validated, only param keys are validated.
+
+        Parameters
+        ----------
+        params : List[str], optional
+            Params passed by the user.
+
+        Returns
+        -------
+            Return a list of restricted params.
+        """
+        restricted_params = []
+        if params:
+            dataclass_fields = {field.name for field in fields(AquaFineTuningParams)}
+            params_dict = get_params_dict(params)
+            for key, items in params_dict.items():
+                key = key.lstrip("--")
+                if key not in dataclass_fields:
+                    restricted_params.append(key)
+
+        if restricted_params:
+            raise AquaValueError(
+                f"Parameters {restricted_params} are set by Aqua "
+                f"and cannot be overridden or are invalid."
+            )
+        return dict(valid=True)

ads/aqua/modeldeployment/constants.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2024 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+"""
+aqua.modeldeployment.constants
+~~~~~~~~~~~~~~
+
+This module contains constants used in Aqua Model Deployment.
+"""
+
+VLLMInferenceRestrictedParams = {"tensor-parallel-size"}