oracle-ads 2.13.18__py3-none-any.whl → 2.13.19__py3-none-any.whl

ads/aqua/common/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 re
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Union
 
 from oci.data_science.models import Model
 from pydantic import BaseModel, ConfigDict, Field, model_validator
@@ -245,55 +245,71 @@ class AquaMultiModelRef(Serializable):
     """
     Lightweight model descriptor used for multi-model deployment.
 
-    This class only contains essential details
-    required to fetch complete model metadata and deploy models.
+    This class holds essential details required to fetch model metadata and deploy
+    individual models as part of a multi-model deployment group.
 
     Attributes
     ----------
     model_id : str
-        The unique identifier of the model.
+        The unique identifier (OCID) of the base model.
     model_name : Optional[str]
-        The name of the model.
+        Optional name for the model.
     gpu_count : Optional[int]
-        Number of GPUs required for deployment.
+        Number of GPUs required to allocate for this model during deployment.
     model_task : Optional[str]
-        The task that model operates on. Supported tasks are in MultiModelSupportedTaskType
+        The machine learning task this model performs (e.g., text-generation, summarization).
+        Supported values are listed in `MultiModelSupportedTaskType`.
     env_var : Optional[Dict[str, Any]]
-        Optional environment variables to override during deployment.
+        Optional dictionary of environment variables to inject into the runtime environment
+        of the model container.
+    params : Optional[Dict[str, Any]]
+        Optional dictionary of container-specific inference parameters to override.
+        These are typically framework-level flags required by the runtime backend.
+        For example, in vLLM containers, valid params may include:
+        `--tensor-parallel-size`, `--enforce-eager`, `--max-model-len`, etc.
     artifact_location : Optional[str]
-        Artifact path of model in the multimodel group.
+        Relative path or URI of the model artifact inside the multi-model group folder.
     fine_tune_weights : Optional[List[LoraModuleSpec]]
-        For fine tuned models, the artifact path of the modified model weights
+        List of fine-tuned weight artifacts (e.g., LoRA modules) associated with this model.
     """
 
     model_id: str = Field(..., description="The model OCID to deploy.")
-    model_name: Optional[str] = Field(None, description="The name of model.")
+    model_name: Optional[str] = Field(None, description="The name of the model.")
     gpu_count: Optional[int] = Field(
-        None, description="The gpu count allocation for the model."
+        None, description="The number of GPUs allocated for the model."
     )
     model_task: Optional[str] = Field(
         None,
-        description="The task that model operates on. Supported tasks are in MultiModelSupportedTaskType",
+        description="The task this model performs. See `MultiModelSupportedTaskType` for supported values.",
     )
     env_var: Optional[dict] = Field(
-        default_factory=dict, description="The environment variables of the model."
+        default_factory=dict,
+        description="Environment variables to override during container startup.",
+    )
+    params: Optional[dict] = Field(
+        default_factory=dict,
+        description=(
+            "Framework-specific startup parameters required by the container runtime. "
+            "For example, vLLM models may use flags like `--tensor-parallel-size`, `--enforce-eager`, etc."
+        ),
     )
     artifact_location: Optional[str] = Field(
-        None, description="Artifact path of model in the multimodel group."
+        None,
+        description="Path to the model artifact relative to the multi-model base folder.",
     )
     fine_tune_weights: Optional[List[LoraModuleSpec]] = Field(
         None,
-        description="For fine tuned models, the artifact path of the modified model weights",
+        description="List of fine-tuned weight modules (e.g., LoRA) associated with this base model.",
     )
 
     def all_model_ids(self) -> List[str]:
         """
-        Returns all associated model OCIDs, including the base model and any fine-tuned models.
+        Returns all model OCIDs associated with this reference, including fine-tuned weights.
 
         Returns
         -------
         List[str]
-            A list of all model OCIDs associated with this multi-model reference.
+            A list containing the base model OCID and any fine-tuned module OCIDs.
         """
         ids = {self.model_id}
         if self.fine_tune_weights:
@@ -302,8 +318,80 @@ class AquaMultiModelRef(Serializable):
             )
         return list(ids)
 
+    @model_validator(mode="before")
+    @classmethod
+    def extract_params_from_env_var(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        A model-level validator that extracts `PARAMS` from the `env_var` dictionary
+        and injects them into the `params` field as a dictionary.
+
+        This is useful for backward compatibility where users pass CLI-style
+        parameters via environment variables, e.g.:
+        env_var = { "PARAMS": "--max-model-len 65536 --enable-streaming" }
+
+        If `params` is already set, values from `PARAMS` in `env_var` are added
+        only if they do not override existing keys.
+        """
+        env = values.get("env_var", {})
+        param_string = env.pop("PARAMS", None)
+
+        if param_string:
+            parsed_params = cls._parse_params(params=param_string)
+            existing_params = values.get("params", {}) or {}
+            # Avoid overriding existing keys
+            for k, v in parsed_params.items():
+                if k not in existing_params:
+                    existing_params[k] = v
+            values["params"] = existing_params
+            values["env_var"] = env  # cleaned up version without PARAMS
+
+        return values
+
+    @staticmethod
+    def _parse_params(params: Union[str, List[str]]) -> Dict[str, str]:
+        """
+        Parses CLI-style parameters into a dictionary format.
+
+        This method accepts either:
+        - A single string of parameters (e.g., "--key1 val1 --key2 val2")
+        - A list of strings (e.g., ["--key1", "val1", "--key2", "val2"])
+
+        Returns a dictionary of the form { "key1": "val1", "key2": "val2" }.
+
+        Parameters
+        ----------
+        params : Union[str, List[str]]
+            The parameters to parse. Can be a single string or a list of strings.
+
+        Returns
+        -------
+        Dict[str, str]
+            Dictionary with parameter names as keys and their corresponding values as strings.
+        """
+        if not params or not isinstance(params, (str, list)):
+            return {}
+
+        # Normalize string to list of "--key value" strings
+        if isinstance(params, str):
+            params_list = [
+                f"--{param.strip()}" for param in params.split("--") if param.strip()
+            ]
+        else:
+            params_list = params
+
+        parsed = {}
+        for item in params_list:
+            parts = item.strip().split()
+            if not parts:
+                continue
+            key = parts[0]
+            value = " ".join(parts[1:]) if len(parts) > 1 else ""
+            parsed[key] = value
+
+        return parsed
+
     class Config:
-        extra = "ignore"
+        extra = "allow"
         protected_namespaces = ()
 
 

ads/aqua/common/utils.py

@@ -800,35 +800,49 @@ def is_service_managed_container(container):
 
 
 def get_params_list(params: str) -> List[str]:
-    """Parses the string parameter and returns a list of params.
+    """
+    Parses a string of CLI-style double-dash parameters and returns them as a list.
 
     Parameters
     ----------
-    params
-        string parameters by separated by -- delimiter
+    params : str
+        A single string containing parameters separated by the `--` delimiter.
 
     Returns
     -------
-        list of params
+    List[str]
+        A list of parameter strings, each starting with `--`.
 
+    Example
+    -------
+    >>> get_params_list("--max-model-len 65536 --enforce-eager")
+    ['--max-model-len 65536', '--enforce-eager']
     """
     if not params:
         return []
-    return ["--" + param.strip() for param in params.split("--")[1:]]
+    return [f"--{param.strip()}" for param in params.split("--") if param.strip()]
 
 
 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.
+    """
+    Converts CLI-style double-dash parameters (as string or list) into a dictionary.
 
     Parameters
     ----------
-    params:
-        List of parameters or parameter string separated by space.
+    params : Union[str, List[str]]
+        Parameters provided either as:
+        - a single string: "--key1 val1 --key2 val2"
+        - a list of strings: ["--key1 val1", "--key2 val2"]
 
     Returns
     -------
-        dict containing parameter keys and values
+    dict
+        A dictionary mapping parameter names to their values. If no value is found, uses `UNKNOWN`.
 
+    Example
+    -------
+    >>> get_params_dict("--max-model-len 65536 --enforce-eager")
+    {'--max-model-len': '65536', '--enforce-eager': ''}
     """
     params_list = get_params_list(params) if isinstance(params, str) else params
     return {
@@ -839,35 +853,43 @@ def get_params_dict(params: Union[str, List[str]]) -> dict:
     }
 
 
-def get_combined_params(params1: str = None, params2: str = None) -> str:
+def get_combined_params(
+    params1: Optional[str] = None, params2: Optional[str] = None
+) -> str:
     """
-    Combines string of double-dash parameters, and overrides the values from the second string in the first.
+    Merges two double-dash parameter strings (`--param value`) into one, with values from `params2`
+    overriding any duplicates from `params1`.
+
     Parameters
     ----------
-    params1:
-        Parameter string with values
-    params2:
-        Parameter string with values that need to be overridden.
+    params1 : Optional[str]
+        The base parameter string. Can be None.
+    params2 : Optional[str]
+        The override parameter string. Parameters in this string will override those in `params1`.
 
     Returns
     -------
-        A combined list with overridden values from params2.
+    str
+        A combined parameter string with deduplicated keys and overridden values from `params2`.
     """
+    if not params1 and not params2:
+        return ""
+
+    # If only one string is provided, return it directly
     if not params1:
-        return params2
+        return params2.strip()
     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 params1.strip()
+
+    # Combine both dictionaries, with params2 overriding params1
+    merged_dict = {**get_params_dict(params1), **get_params_dict(params2)}
+
+    # Reconstruct the string
+    combined = " ".join(
+        f"{key} {value}" if value else key for key, value in merged_dict.items()
+    )
 
-    return " ".join(combined_params)
+    return combined.strip()
 
 
 def find_restricted_params(
@@ -905,28 +927,46 @@ def find_restricted_params(
     return restricted_params
 
 
-def build_params_string(params: dict) -> str:
-    """Builds params string from params dict
+def build_params_string(params: Optional[Dict[str, Any]]) -> str:
+    """
+    Converts a dictionary of CLI parameters into a command-line friendly string.
+
+    This is typically used to transform framework-specific model parameters (e.g., vLLM or TGI flags)
+    into a space-separated string that can be passed to container startup commands.
 
     Parameters
     ----------
-    params:
-        Parameter dict with key-value pairs
+    params : Optional[Dict[str, Any]]
+        Dictionary containing parameter name as keys (e.g., "--max-model-len") and their corresponding values.
+        If a parameter does not require a value (e.g., a boolean flag), its value can be None or an empty string.
 
     Returns
     -------
-        A params string.
+    str
+        A space-separated string of CLI arguments.
+        Returns "<unknown>" if the input dictionary is None or empty.
+
+    Example
+    -------
+    >>> build_params_string({"--max-model-len": 4096, "--enforce-eager": None})
+    '--max-model-len 4096 --enforce-eager'
     """
-    return (
-        " ".join(
-            f"{name} {value}" if value else f"{name}" for name, value in params.items()
-        ).strip()
-        if params
-        else UNKNOWN
-    )
+    if not params:
+        return UNKNOWN
+
+    parts = []
+    for key, value in params.items():
+        if value is None or value == "":
+            parts.append(str(key))
+        else:
+            parts.append(f"{key} {value}")
+
+    return " ".join(parts).strip()
 
 
-def copy_model_config(artifact_path: str, os_path: str, auth: dict = None):
+def copy_model_config(
+    artifact_path: str, os_path: str, auth: Optional[Dict[str, Any]] = None
+):
     """Copies the aqua model config folder from the artifact path to the user provided object storage path.
     The config folder is overwritten if the files already exist at the destination path.
 
@@ -1202,36 +1242,45 @@ def parse_cmd_var(cmd_list: List[str]) -> dict:
     return parsed_cmd
 
 
-def validate_cmd_var(cmd_var: List[str], overrides: List[str]) -> List[str]:
-    """This function accepts two lists of parameters and combines them. If the second list shares the common parameter
-    names/keys, then it raises an error.
+def validate_cmd_var(
+    cmd_var: Optional[List[str]], overrides: Optional[List[str]]
+) -> List[str]:
+    """
+    Validates and combines two lists of command-line parameters. Raises an error if any parameter
+    key in the `overrides` list already exists in the `cmd_var` list, preventing unintended overrides.
+
     Parameters
     ----------
-    cmd_var: List[str]
-        Default list of parameters
-    overrides: List[str]
-        List of parameters to override
+    cmd_var : Optional[List[str]]
+        The default list of command-line parameters (e.g., ["--param1", "value1", "--flag"]).
+    overrides : Optional[List[str]]
+        The list of overriding command-line parameters.
+
     Returns
     -------
-        List[str] of combined parameters
+    List[str]
+        A validated and combined list of parameters, with overrides appended.
+
+    Raises
+    ------
+    AquaValueError
+        If `overrides` contain any parameter keys that already exist in `cmd_var`.
     """
-    cmd_var = [str(x) for x in cmd_var]
-    if not overrides:
-        return cmd_var
-    overrides = [str(x) for x in overrides]
+    cmd_var = [str(x).strip() for x in cmd_var or []]
+    overrides = [str(x).strip() for x in overrides or []]
 
     cmd_dict = parse_cmd_var(cmd_var)
     overrides_dict = parse_cmd_var(overrides)
 
-    # check for conflicts
-    common_keys = set(cmd_dict.keys()) & set(overrides_dict.keys())
-    if common_keys:
+    # Check for conflicting keys
+    conflicting_keys = set(cmd_dict.keys()) & set(overrides_dict.keys())
+    if conflicting_keys:
         raise AquaValueError(
-            f"The following CMD input cannot be overridden for model deployment: {', '.join(common_keys)}"
+            f"Cannot override the following model deployment parameters: {', '.join(sorted(conflicting_keys))}"
         )
 
-    combined_cmd_var = cmd_var + overrides
-    return combined_cmd_var
+    combined_params = cmd_var + overrides
+    return combined_params
 
 
 def build_pydantic_error_message(ex: ValidationError):

ads/aqua/modeldeployment/deployment.py

@@ -520,10 +520,20 @@ class AquaDeploymentApp(AquaApp):
 
         deployment_config = self.get_deployment_config(model_id=config_source_id)
 
+        # Loads frameworks specific default params from the configuration
         config_params = deployment_config.configuration.get(
             create_deployment_details.instance_shape, ConfigurationItem()
         ).parameters.get(get_container_params_type(container_type_key), UNKNOWN)
 
+        # Loads default environment variables from the configuration
+        config_env = deployment_config.configuration.get(
+            create_deployment_details.instance_shape, ConfigurationItem()
+        ).env.get(get_container_params_type(container_type_key), {})
+
+        # Merges user provided environment variables with the ones provided in the deployment config
+        # The values provided by user will override the ones provided by default config
+        env_var = {**config_env, **env_var}
+
         # validate user provided params
         user_params = env_var.get("PARAMS", UNKNOWN)
 
@@ -643,8 +653,8 @@ class AquaDeploymentApp(AquaApp):
 
         env_var.update({AQUA_MULTI_MODEL_CONFIG: multi_model_config.model_dump_json()})
 
-        env_vars = container_spec.env_vars if container_spec else []
-        for env in env_vars:
+        container_spec_env_vars = container_spec.env_vars if container_spec else []
+        for env in container_spec_env_vars:
             if isinstance(env, dict):
                 env = {k: v for k, v in env.items() if v}
                 for key, _ in env.items():

ads/aqua/modeldeployment/model_group_config.py

@@ -130,7 +130,7 @@ class ModelGroupConfig(Serializable):
         Validates if user-provided parameters override pre-set parameters by AQUA.
         Updates model name and TP size parameters to user-provided parameters.
         """
-        user_params = build_params_string(model.env_var)
+        user_params = build_params_string(model.params)
         if user_params:
             restricted_params = find_restricted_params(
                 container_params, user_params, container_type_key
@@ -138,8 +138,8 @@ class ModelGroupConfig(Serializable):
             if restricted_params:
                 selected_model = model.model_name or model.model_id
                 raise AquaValueError(
-                    f"Parameters {restricted_params} are set by Aqua "
-                    f"and cannot be overridden or are invalid."
+                    f"Parameters {restricted_params} are set by AI Quick Actions "
+                    f"and cannot be overridden or are invalid. "
                     f"Select other parameters for model {selected_model}."
                 )
 

{oracle_ads-2.13.18.dist-info → oracle_ads-2.13.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oracle_ads
-Version: 2.13.18
+Version: 2.13.19
 Summary: Oracle Accelerated Data Science SDK
 Keywords: Oracle Cloud Infrastructure,OCI,Machine Learning,ML,Artificial Intelligence,AI,Data Science,Cloud,Oracle,GenAI,Generative AI,Forecast,Anomaly,Document Understanding,Anomaly Detection
 Author: Oracle Data Science

{oracle_ads-2.13.18.dist-info → oracle_ads-2.13.19.dist-info}/RECORD

@@ -13,10 +13,10 @@ ads/aqua/client/client.py,sha256=PzbIscVclkVwvfQWyKyRZjRCcT3cXE6bdSkMaMQMomI,327
 ads/aqua/client/openai_client.py,sha256=JxSmjaeBb7jG8ARH6LdmsWGip467V0y6_mo2YwiiZz4,12921
 ads/aqua/common/__init__.py,sha256=rZrmh1nho40OCeabXCNWtze-mXi-PGKetcZdxZSn3_0,204
 ads/aqua/common/decorator.py,sha256=JEN6Cy4DYgQbmIR3ShCjTuBMCnilDxq7jkYMJse1rcM,4112
-ads/aqua/common/entities.py,sha256=veUvnQh4eaTTKX1k1ppp3hsfdad5ntBLMbuZKaDjogs,13334
+ads/aqua/common/entities.py,sha256=qF74hz2uac3T-4Y92_swTBmW1uimRGbx_RhTCN6M4K0,16937
 ads/aqua/common/enums.py,sha256=hl52JrT8SRQLKZ3sdw12wA2u0PdpnQQW4bejmIvtIsY,4695
 ads/aqua/common/errors.py,sha256=T2jf8RiXSiU6deRoynvmyVsmZj3xJfOBlNudQcdx980,3294
-ads/aqua/common/utils.py,sha256=cNtOfz-my8xzzczHIobsmH8e4Mk3sORvL82v7RDmxJk,45912
+ads/aqua/common/utils.py,sha256=HTl-A0NCwpMOhIegNihlanxr9v0uQwad3aYqTU87x1I,47964
 ads/aqua/config/__init__.py,sha256=2a_1LI4jWtJpbic5_v4EoOUTXCAH7cmsy9BW5prDHjU,179
 ads/aqua/config/container_config.py,sha256=2N65TZNpqlpKJ9I4U9_v9bB_MoP4xsmEo8V4W1iZj9M,9882
 ads/aqua/config/evaluation/__init__.py,sha256=2a_1LI4jWtJpbic5_v4EoOUTXCAH7cmsy9BW5prDHjU,179
@@ -63,9 +63,9 @@ ads/aqua/model/utils.py,sha256=gFJVWdQvF4GfyamL4m5u62gOidJC7UXXkQwqXCUIoUo,2016
 ads/aqua/modeldeployment/__init__.py,sha256=k5fGG2b6mae-uiQyuTAHqPjlzcUyJ4NFaF-uoMnK5Uc,277
 ads/aqua/modeldeployment/config_loader.py,sha256=B-jIQ_rys1aRwprIDV8LEY3OOnBoacvUcOAvsZzNM5g,32201
 ads/aqua/modeldeployment/constants.py,sha256=WaD1hfbuWGg2flhRJxQkftpy6pFsEg8bCEXtm0WWP2E,357
-ads/aqua/modeldeployment/deployment.py,sha256=i2K_KGJqKj8e1QavOhaPfrv-nfcolNnMNQz6uetmSzU,58869
+ads/aqua/modeldeployment/deployment.py,sha256=RF0S4dQ-xaTGfLxduHYJGFh8E3qO8z_2WOAppmyu5vI,59478
 ads/aqua/modeldeployment/entities.py,sha256=eisS3RCg8xauPddr2MPtq8WkGiu_yL01sOmuz7R2dGk,27566
-ads/aqua/modeldeployment/model_group_config.py,sha256=ZNCzHVG7_kKmP7pC7wUY0cDptnsAKqTaDYJcuVARflc,9259
+ads/aqua/modeldeployment/model_group_config.py,sha256=tiQNsxqpHADKPTtVbTAMj8v3wN-Y6lFjPkx66yDBuBA,9271
 ads/aqua/modeldeployment/utils.py,sha256=yPUNGDlyHB7JYalqsczimlkPjf4l8f_NprRORp7nBVE,212
 ads/aqua/resources/gpu_shapes_index.json,sha256=uyLKK8FBNDv45axzILVlbWbxsfNl2A1l5LJ2pRe1aa0,7491
 ads/aqua/server/__init__.py,sha256=fswoO0kX0hrp2b1owF4f-bv_OodntvvUY3FvhL6FCMk,179
@@ -867,8 +867,8 @@ ads/type_discovery/unknown_detector.py,sha256=yZuYQReO7PUyoWZE7onhhtYaOg6088wf1y
 ads/type_discovery/zipcode_detector.py,sha256=3AlETg_ZF4FT0u914WXvTT3F3Z6Vf51WiIt34yQMRbw,1421
 ads/vault/__init__.py,sha256=x9tMdDAOdF5iDHk9u2di_K-ze5Nq068x25EWOBoWwqY,245
 ads/vault/vault.py,sha256=hFBkpYE-Hfmzu1L0sQwUfYcGxpWmgG18JPndRl0NOXI,8624
-oracle_ads-2.13.18.dist-info/entry_points.txt,sha256=9VFnjpQCsMORA4rVkvN8eH6D3uHjtegb9T911t8cqV0,35
-oracle_ads-2.13.18.dist-info/licenses/LICENSE.txt,sha256=zoGmbfD1IdRKx834U0IzfFFFo5KoFK71TND3K9xqYqo,1845
-oracle_ads-2.13.18.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-oracle_ads-2.13.18.dist-info/METADATA,sha256=hoxFF4E8tqt43hiPGw-8-p4o4Q94B2UQxzA0xbh_9tA,16994
-oracle_ads-2.13.18.dist-info/RECORD,,
+oracle_ads-2.13.19.dist-info/entry_points.txt,sha256=9VFnjpQCsMORA4rVkvN8eH6D3uHjtegb9T911t8cqV0,35
+oracle_ads-2.13.19.dist-info/licenses/LICENSE.txt,sha256=zoGmbfD1IdRKx834U0IzfFFFo5KoFK71TND3K9xqYqo,1845
+oracle_ads-2.13.19.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+oracle_ads-2.13.19.dist-info/METADATA,sha256=azUVd7xrB_nXSNAk_SsmBBxjIcQ9IH8wZsKCk-RKDhc,16994
+oracle_ads-2.13.19.dist-info/RECORD,,