triton-model-analyzer 1.48.0__py3-none-any.whl

model_analyzer/config/input/config_value.py

@@ -0,0 +1,243 @@
+#!/usr/bin/env python3
+
+# Copyright 2021-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from abc import ABC, abstractmethod
+
+from model_analyzer.constants import CONFIG_PARSER_FAILURE, CONFIG_PARSER_SUCCESS
+from model_analyzer.model_analyzer_exceptions import TritonModelAnalyzerException
+
+from .config_status import ConfigStatus
+
+
+class ConfigValue(ABC):
+    """
+    Parent class for all the types used in the ConfigField.
+    """
+
+    def __init__(
+        self,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        Parameters
+        ----------
+        preprocess : callable or None
+            Function be called before setting new values.
+        required : bool
+            Whether a given config is required or not.
+        validator : callable or None
+            A validator for the value of the field.
+        output_mapper: callable or None
+            This callable unifies the output value of this field.
+        name : str
+            Fully qualified name for this field.
+        """
+
+        self._preprocess = preprocess
+        self._is_sweepable = False
+        self._required = required
+        self._validator = validator
+        self._output_mapper = output_mapper
+        self._name = name
+
+    @abstractmethod
+    def set_value(self, value):
+        """
+        Set the value for this field. This method must be implemented in each
+        subclass.
+        """
+
+        if self._validator:
+            config_status = self._validator(value)
+            if config_status.status() == CONFIG_PARSER_FAILURE:
+                return config_status
+
+        self._value = value
+
+        return ConfigStatus(status=CONFIG_PARSER_SUCCESS)
+
+    def value(self):
+        """
+        Get the value of the config field.
+
+        Returns
+        -------
+        object
+            The value of the config field.
+        """
+
+        return_result = self._value
+        if self._output_mapper:
+            return_result = self._output_mapper(return_result)
+
+        if type(return_result) is dict:
+            final_return_result = {}
+            for key, value_ in return_result.items():
+                if hasattr(value_, "value"):
+                    final_return_result[key] = value_.value()
+                else:
+                    raise TritonModelAnalyzerException(
+                        "ConfigObject should always have a "
+                        '"value" attribute for each value.'
+                    )
+            return_result = final_return_result
+        elif type(return_result) is list:
+            return_results = []
+            for item in return_result:
+                if hasattr(item, "value"):
+                    return_results.append(item.value())
+                else:
+                    return_results.append(item)
+            return_result = return_results
+        elif hasattr(return_result, "value"):
+            return_result = return_result.value()
+
+        return return_result
+
+    def raw_value(self):
+        return self._value
+
+    def _is_primitive(self, value):
+        """
+        Is the value a primitive type.
+
+        Parameters
+        ----------
+        value : object
+            Value to be checked
+
+        Returns
+        -------
+        bool
+            True if yes, False if no
+        """
+
+        return not (self._is_dict(value) or self._is_list(value))
+
+    def _is_string(self, value):
+        """
+        Is the value a string.
+
+        Parameters
+        ----------
+        value : object
+            Value to be checked
+
+        Returns
+        -------
+        bool
+            True if yes, False if no
+        """
+
+        return type(value) is str
+
+    def _is_dict(self, value):
+        """
+        Is the value a dictionary.
+
+        Parameters
+        ----------
+        value : object
+            Value to be checked
+
+        Returns
+        -------
+        bool
+            True if yes, False if no
+        """
+
+        return type(value) is dict
+
+    def _is_list(self, value):
+        """
+        Is the value a list.
+
+        Parameters
+        ----------
+        value : object
+            Value to be checked
+
+        Returns
+        -------
+        bool
+            True if yes, False if no
+        """
+
+        return type(value) is list
+
+    def cli_type(self):
+        """
+        Get the corresponding CLI type for this field.
+
+        Returns
+        -------
+        type
+            Type to be used for the CLI.
+        """
+
+        return self._cli_type
+
+    def container_type(self):
+        """
+        Get the container type for this field.
+
+        Returns
+        -------
+        ConfigValue
+            Container type for the field.
+        """
+
+        return self._type
+
+    def required(self):
+        """
+        Get the 'required' field value
+
+        Returns
+        -------
+        bool
+            Whether the config field is required or not.
+        """
+
+        return self._required
+
+    def name(self):
+        """
+        Get the fully qualified name for this field.
+
+        Returns
+        -------
+        str or None
+            Fully qualified name for this field.
+        """
+
+        return self._name
+
+    def set_name(self, name):
+        """
+        Set the name for this field.
+
+        Parameters
+        ----------
+        name : str
+            New name to be set for this field.
+        """
+
+        self._name = name

model_analyzer/config/input/objects/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+
+# Copyright 2021-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

model_analyzer/config/input/objects/config_model_profile_spec.py

@@ -0,0 +1,325 @@
+#!/usr/bin/env python3
+
+# Copyright 2021-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from model_analyzer.result.model_constraints import ModelConstraints
+
+
+class ConfigModelProfileSpec:
+    """
+    A class representing the configuration used for
+    a single model.
+    """
+
+    def __init__(
+        self,
+        model_name,
+        cpu_only=False,
+        objectives=None,
+        constraints=None,
+        weighting=None,
+        parameters=None,
+        model_config_parameters=None,
+        perf_analyzer_flags=None,
+        genai_perf_flags=None,
+        triton_server_flags=None,
+        triton_server_environment=None,
+        triton_docker_args=None,
+    ):
+        """
+        Parameters
+        ----------
+        model_name : str
+           Name used for the model
+        cpu_only: bool
+            Whether this model should be run on CPU only
+        objectives : None or list
+           List of the objectives required by the model
+        constraints : None or dict
+            Constraints required by the model
+        weighting: int
+            Model weighting
+        parameters : None or dict
+            Constraints on batch_size and concurrency values need to be
+            specified here.
+        model_config_parameters : None or dict
+            Model config parameters that is used for this model
+        perf_analyzer_flags : dict
+            The custom perf analyzer configuration
+            for this model
+        genai_perf_flags : dict
+            The custom GenAI perf configuration
+            for this model
+        triton_server_flags : dict
+            The configuration for the triton server instance launched
+            for this model
+        triton_server_environment: dict
+            The environment variables to be set for the tritonserver instances
+            launched by model analyzer
+        triton_docker_args: dict
+            The docker args to be set for the tritonserver instances
+            launched by model analyzer
+        """
+
+        self._model_name = model_name
+        self._cpu_only = cpu_only
+        self._objectives = objectives
+        self._constraints = ModelConstraints(constraints)
+        self._weighting = weighting
+
+        self._parameters = parameters
+        self._model_config_parameters = model_config_parameters
+        self._perf_analyzer_flags = perf_analyzer_flags
+        self._genai_perf_flags = genai_perf_flags
+        self._triton_server_flags = triton_server_flags
+        self._triton_server_environment = triton_server_environment
+        self._triton_docker_args = triton_docker_args
+
+    def cpu_only(self):
+        """
+        Returns
+        -------
+        bool
+            Whether this model is run on cpu only
+        """
+
+        return self._cpu_only
+
+    def objectives(self):
+        """
+        Returns
+        -------
+        list or None
+            A list containing the objectives.
+        """
+
+        return self._objectives
+
+    def constraints(self):
+        """
+        Returns
+        -------
+        ModelConstraints
+            A ModelConstraints object containing the constraints
+        """
+
+        return self._constraints
+
+    def weighting(self) -> int:
+        """
+        Returns
+        -------
+        int
+           The model weighting
+        """
+
+        return self._weighting
+
+    def parameters(self):
+        """
+        Returns
+        -------
+        dict or None
+            A dictionary containing the parameters
+        """
+
+        return self._parameters
+
+    def model_config_parameters(self):
+        """
+        Returns
+        -------
+        dict or None
+            A dictionary containing the model config parameters.
+        """
+
+        return self._model_config_parameters
+
+    def model_name(self):
+        """
+        Returns
+        -------
+        str
+            The model name used for this config.
+        """
+
+        return self._model_name
+
+    def perf_analyzer_flags(self):
+        """
+        Returns
+        -------
+        dict:
+             the perf_analyzer_flags
+        """
+
+        return self._perf_analyzer_flags
+
+    def genai_perf_flags(self):
+        """
+        Returns
+        -------
+        dict:
+             the genai_perf_flags
+        """
+
+        return self._genai_perf_flags
+
+    def triton_server_flags(self):
+        """
+        Returns
+        -------
+        dict:
+             the triton_server_flags
+        """
+
+        return self._triton_server_flags
+
+    def triton_server_environment(self):
+        """
+        Returns
+        -------
+        dict
+            The triton server environment
+        """
+
+        return self._triton_server_environment
+
+    def triton_docker_args(self):
+        """
+        Returns
+        -------
+        dict
+            The triton docker args
+        """
+
+        return self._triton_docker_args
+
+    @staticmethod
+    def model_object_to_config_model_profile_spec(value):
+        """
+        Converts a ConfigObject to ConfigModelProfileSpec.
+
+        Parameters
+        ----------
+        value : dict
+            A dictionary where the keys are model names
+            and the values are ConfigObjects.
+
+        Returns
+        -------
+        list
+            A list of ConfigModelProfileSpec objects.
+        """
+
+        models = []
+        for model_name, model_properties in value.items():
+            models.append(
+                ConfigModelProfileSpec(model_name, **model_properties.value())
+            )
+
+        return models
+
+    @staticmethod
+    def model_str_to_config_model_profile_spec(model_name):
+        """
+        Constructs a ConfigModelProfileSpec from a given
+        model_name.
+
+        Parameters
+        ----------
+        model_name : str
+            Name of the model
+
+        Returns
+        -------
+        ConfigModelProfileSpec
+            ConfigModelProfileSpec object with the given model name.
+        """
+
+        return ConfigModelProfileSpec(model_name)
+
+    @staticmethod
+    def model_list_to_config_model_profile_spec(profile_models):
+        """
+        Construct ConfigModelProfileSpec objects from a list of strings.
+
+        Parameters
+        ----------
+        profile_models : list
+            A list of strings containing model names.
+
+        Returns
+        -------
+        list
+            A list of ConfigModelProfileSpec objects.
+        """
+
+        models = []
+        for model_name in profile_models:
+            models.append(ConfigModelProfileSpec(model_name))
+        return models
+
+    @staticmethod
+    def model_mixed_to_config_model_profile_spec(models):
+        """
+        Unifies a mixed list of ConfigModelProfileSpec objects
+        and list of ConfigModelProfileSpec objects.
+
+        Parameters
+        ----------
+        models : list
+            A mixed list containing lists or ConfigModelProfileSpec objects.
+
+        Returns
+        -------
+        list
+            A list only containing ConfigModelProfileSpec objects.
+        """
+
+        new_models = []
+        for model in models:
+            if type(model.value()) is list:
+                for model_i in model.value():
+                    new_models.append(model_i)
+            else:
+                new_models.append(model.value())
+        return new_models
+
+    def __repr__(self):
+        model_object = {"model_name": self._model_name}
+        model_object["cpu_only"] = self._cpu_only
+        if self._objectives:
+            model_object["objectives"] = self._objectives
+
+        if self._parameters:
+            model_object["parameters"] = self._parameters
+
+        if self._constraints:
+            model_object["constraints"] = self._constraints
+
+        if self._weighting:
+            model_object["weighting"] = self._weighting
+
+        if self._model_config_parameters:
+            model_object["model_config_parameters"] = self._model_config_parameters
+
+        if self._perf_analyzer_flags:
+            model_object["perf_analyzer_flags"] = self._perf_analyzer_flags
+
+        if self._genai_perf_flags:
+            model_object["genai_perf_flags"] = self._genai_perf_flags
+
+        return str(model_object)