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

model_analyzer/config/input/config_field.py

@@ -0,0 +1,216 @@
+#!/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 typing import Any
+
+from model_analyzer.constants import CONFIG_PARSER_FAILURE
+from model_analyzer.model_analyzer_exceptions import TritonModelAnalyzerException
+
+
+class ConfigField:
+    def __init__(
+        self,
+        name=None,
+        flags=None,
+        choices=None,
+        description=None,
+        default_value=None,
+        field_type=None,
+        parser_args=None,
+    ):
+        """
+        Create a configuration field.
+
+        Parameters
+        ----------
+        name : str
+            Configuration name.
+        flags : list
+            List of the flags to be used for the CLI.
+        choices : list or None
+            List of the choices to be used.
+        description : str
+            Description of the config.
+        default_value : object
+            Default value used for the config field.
+        field_type : ConfigValue
+            type of the field
+        parser_args : dict
+            Additionally arguments to be passed to ArgumentParser.
+        """
+
+        self._description = description
+        self._default_value = default_value
+        self._name = name
+        self._field_type = field_type
+        self._used_field_idx = 0
+        self._flags = flags
+        self._choices = choices
+        self._parser_args = {} if parser_args is None else parser_args
+        self._is_set_by_config = False
+
+    def choices(self):
+        """
+        List of choices that are allowed
+        """
+
+        return self._choices
+
+    def parser_args(self):
+        """
+        Get the additional arguments to be passed to ArgumentParser.
+
+        Returns
+        -------
+        dict or None
+            A dictionary where the keys are arguments and the values are
+            the argument values
+        """
+
+        return self._parser_args
+
+    def description(self):
+        """
+        Get the field description.
+
+        Returns
+        -------
+        str or None
+            Description of the config field
+        """
+
+        return self._description
+
+    def field_type(self):
+        """
+        Get the field type.
+
+        Returns
+        -------
+        ConfigValue
+            Type of the config field
+        """
+
+        return self._field_type
+
+    def cli_type(self):
+        """
+        Get the equivalent CLI type of the field.
+
+        Returns
+        -------
+        type
+            CLI type of the field.
+        """
+
+        return self._field_type.cli_type()
+
+    def name(self):
+        """
+        Get the name of the config field.
+
+        Returns
+        -------
+        str
+            Name of the config field
+        """
+
+        return self._name
+
+    def default_value(self):
+        """
+        Get the value for this config field.
+
+        Returns
+        -------
+        object
+            The default value of the config field
+        """
+
+        return self._default_value
+
+    def flags(self):
+        """
+        Get the CLI flags.
+
+        Returns
+        -------
+        list
+            A list of the CLI flags used
+        """
+
+        return self._flags
+
+    def set_value(self, value: Any, is_set_by_config: bool = False) -> None:
+        """
+        Set the value for the config field.
+        """
+
+        config_status = self._field_type.set_value(value)
+
+        if config_status.status() == CONFIG_PARSER_FAILURE:
+            raise TritonModelAnalyzerException(
+                f'Failed to set the value for field "{self._name}". Error: {config_status.message()}'
+            )
+
+        self._is_set_by_config = is_set_by_config
+
+    def set_default_value(self, default_value):
+        """
+        Set the default value for a config field.
+
+        Parameters
+        ----------
+        default_value : object
+            New default value
+        """
+
+        self._default_value = default_value
+
+        self._is_set_by_config = False
+
+    def value(self):
+        """
+        Get the value for the config field.
+
+        Returns
+        -------
+        object
+            The value of the config field.
+        """
+
+        return self._field_type.value()
+
+    def required(self):
+        """
+        Get the required field value
+
+        Returns
+        -------
+        bool
+            Whether the config field is required or not.
+        """
+
+        return self._field_type.required()
+
+    def set_name(self, name):
+        self._field_type.set_name(name)
+
+    def is_set_by_user(self) -> bool:
+        """
+        Returns true if the user set the field
+        """
+        return self._is_set_by_config

model_analyzer/config/input/config_list_generic.py

@@ -0,0 +1,112 @@
+#!/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 copy import deepcopy
+
+from model_analyzer.constants import CONFIG_PARSER_FAILURE, CONFIG_PARSER_SUCCESS
+
+from .config_status import ConfigStatus
+from .config_value import ConfigValue
+
+
+class ConfigListGeneric(ConfigValue):
+    """
+    A generic list.
+    """
+
+    def __init__(
+        self,
+        type_,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        Create a new list of numeric values.
+
+        Parameters
+        ----------
+        type_ : ConfigValue
+            The type of elements in the list
+        preprocess : callable
+            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 final value of the field.
+        output_mapper: callable
+            This callable unifies the output value of this field.
+        name : str
+            Fully qualified name for this field.
+        """
+
+        # default validator
+        if validator is None:
+
+            def validator(x):
+                if type(x) is list:
+                    return ConfigStatus(CONFIG_PARSER_SUCCESS)
+
+                return ConfigStatus(
+                    CONFIG_PARSER_FAILURE,
+                    f'The value for field "{self.name()}" should be a list'
+                    " and the length must be larger than zero.",
+                )
+
+        super().__init__(preprocess, required, validator, output_mapper, name)
+
+        # type_ should be instance of ConfigValue
+        assert isinstance(type_, ConfigValue)
+
+        self._type = type_
+        self._cli_type = str
+        self._value = []
+
+    def set_value(self, value):
+        """
+        Set the value for this field.
+
+        Parameters
+        ----------
+        value : object
+            The value for this field.
+        """
+
+        type_ = self._type
+
+        new_value = []
+        if type(value) is list:
+            for item in value:
+                list_item = deepcopy(type_)
+                config_status = list_item.set_value(item)
+                if config_status.status() == CONFIG_PARSER_SUCCESS:
+                    new_value.append(list_item)
+                else:
+                    return config_status
+        else:
+            return ConfigStatus(
+                status=CONFIG_PARSER_FAILURE,
+                message=f'Value for field "{self.name()}" must be a list, value is "{value}".',
+                config_object=self,
+            )
+
+        return super().set_value(new_value)
+
+    def set_name(self, name):
+        super().set_name(name)
+        self._type.set_name(name)

model_analyzer/config/input/config_list_numeric.py

@@ -0,0 +1,151 @@
+#!/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.constants import CONFIG_PARSER_FAILURE, CONFIG_PARSER_SUCCESS
+
+from .config_status import ConfigStatus
+from .config_value import ConfigValue
+
+
+class ConfigListNumeric(ConfigValue):
+    """
+    A list of numeric values.
+    """
+
+    def __init__(
+        self,
+        type_,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        Create a new list of numeric values.
+
+        Parameters
+        ----------
+        type_ : type
+            The type of elements in the list
+        preprocess : callable
+            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 final 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.
+        """
+
+        # default validator
+        if validator is None:
+
+            def validator(x):
+                if type(x) is list:
+                    return ConfigStatus(CONFIG_PARSER_SUCCESS)
+
+                return ConfigStatus(
+                    CONFIG_PARSER_FAILURE,
+                    f'The value for field "{self.name()}" should be a list'
+                    " and the length must be larger than zero.",
+                )
+
+        super().__init__(preprocess, required, validator, output_mapper, name)
+        self._type = type_
+        self._cli_type = str
+        self._value = []
+
+    def _process_list(self, value):
+        """
+        A function to process the case where value is
+        a list.
+        """
+
+        type_ = self._type
+        new_value = []
+
+        for item in value:
+            item = type_(item)
+            new_value.append(item)
+
+        return new_value
+
+    def set_value(self, value):
+        """
+        Set the value for this field.
+
+        Parameters
+        ----------
+        value : object
+            The value for this field. It can be comma delimited list, or an
+            array, or a range
+        """
+
+        type_ = self._type
+        new_value = []
+
+        try:
+            if self._is_string(value):
+                self._value = []
+                value = value.split(",")
+
+            if self._is_list(value):
+                new_value = self._process_list(value)
+
+            elif self._is_dict(value):
+                two_key_condition = (
+                    len(value) == 2 and "start" in value and "stop" in value
+                )
+                three_key_condition = (
+                    len(value) == 3
+                    and "start" in value
+                    and "stop" in value
+                    and "step" in value
+                )
+                if two_key_condition or three_key_condition:
+                    step = 1
+                    start = int(value["start"])
+                    stop = int(value["stop"])
+                    if start > stop:
+                        return ConfigStatus(
+                            CONFIG_PARSER_FAILURE,
+                            f'When a dictionary is used for field "{self.name()}",'
+                            ' "start" should be less than "stop".'
+                            f" Current value is {value}.",
+                            config_object=self,
+                        )
+
+                    if "step" in value:
+                        step = int(value["step"])
+                    new_value = list(range(start, stop + 1, step))
+                else:
+                    return ConfigStatus(
+                        CONFIG_PARSER_FAILURE,
+                        f'If a dictionary is used for field "{self.name()}", it'
+                        ' should only contain "start" and "stop" key with an'
+                        f' optional "step" key. Currently, contains {list(value)}.',
+                        config_object=self,
+                    )
+            else:
+                new_value = [type_(value)]
+        except ValueError as e:
+            message = f'Failed to set the value for field "{self.name()}". Error: {e}.'
+            return ConfigStatus(CONFIG_PARSER_FAILURE, message, self)
+
+        return super().set_value(new_value)

model_analyzer/config/input/config_list_string.py

@@ -0,0 +1,111 @@
+#!/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.constants import CONFIG_PARSER_FAILURE, CONFIG_PARSER_SUCCESS
+
+from .config_status import ConfigStatus
+from .config_value import ConfigValue
+
+
+class ConfigListString(ConfigValue):
+    """
+    A list of string values.
+    """
+
+    def __init__(
+        self,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        Instantiate a new ConfigListString
+
+        preprocess : callable
+            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.
+        """
+
+        # default validator
+        if validator is None:
+
+            def validator(x):
+                if type(x) is list:
+                    return ConfigStatus(CONFIG_PARSER_SUCCESS)
+
+                return ConfigStatus(
+                    CONFIG_PARSER_FAILURE,
+                    f'The value for field "{self.name()}" should be a list'
+                    " and the length must be larger than zero.",
+                )
+
+        super().__init__(preprocess, required, validator, output_mapper, name)
+        self._type = self._cli_type = str
+        self._value = []
+
+    def set_value(self, value):
+        """
+        Set the value for this field.
+
+        Parameters
+        ----------
+        value : object
+            The value for this field. It can be a string of comma-delimited
+            items or a list.
+
+        Returns
+        -------
+        int
+            1 on success, and 0 on failure
+        """
+
+        new_value = []
+        if self._is_string(value):
+            value = value.split(",")
+            for item in value:
+                new_value.append(self._type(item))
+        elif self._is_list(value):
+            for item in value:
+                if not self._is_primitive(item):
+                    return ConfigStatus(
+                        CONFIG_PARSER_FAILURE,
+                        "The value for each item in the list should"
+                        f' be a primitive value not "{item}" for field '
+                        f'"{self.name()}".',
+                        self,
+                    )
+                new_value.append(self._type(item))
+        else:
+            if self._is_dict(value):
+                return ConfigStatus(
+                    CONFIG_PARSER_FAILURE,
+                    f'The value for field "{self.name()}" should not be'
+                    " a dictionary, current "
+                    f'value is "{value}".',
+                    self,
+                )
+            new_value = [self._type(value)]
+
+        return super().set_value(new_value)

model_analyzer/config/input/config_none.py

@@ -0,0 +1,71 @@
+#!/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.constants import CONFIG_PARSER_FAILURE
+
+from .config_status import ConfigStatus
+from .config_value import ConfigValue
+
+
+class ConfigNone(ConfigValue):
+    """
+    A wrapper class for the primitive datatypes.
+    """
+
+    def __init__(
+        self,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        Parameters
+        ----------
+        preprocess : callable
+            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.
+        """
+
+        super().__init__(preprocess, required, validator, output_mapper, name)
+
+        self._type = self._cli_type = type(None)
+        self._value = None
+
+    def set_value(self, value):
+        """
+        Set the value for this field.
+
+        value : object
+            The value for this field.
+        """
+
+        if value is None:
+            return super().set_value(value)
+        else:
+            return ConfigStatus(
+                CONFIG_PARSER_FAILURE,
+                f'Value "{value}" for field "{self.name()}" should be None',
+                self,
+            )