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

model_analyzer/config/input/config_object.py

@@ -0,0 +1,129 @@
+#!/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
+
+from .config_status import ConfigStatus
+from .config_value import ConfigValue
+
+
+class ConfigObject(ConfigValue):
+    """
+    Representation of dictionaries in Config
+    """
+
+    def __init__(
+        self,
+        schema,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        schema : dict
+            A dictionary where the keys are the object keys and the values
+            are of type ConfigValue
+        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
+        self._cli_type = str
+        self._value = {}
+        self._schema = schema
+
+    def set_value(self, value):
+        """
+        Set the value for this field.
+
+        Note: Because ConfigObjects can have nested
+        ConfigValues and the schema contains these,
+        this function performs deep copies of the
+        types of objects, and then sets their values.
+
+        Parameters
+        ----------
+        value : dict
+            The value for this field.
+
+        Returns
+        -------
+        int
+            1 on success, and 0 on failure
+        """
+
+        new_value = {}
+        schema = self._schema
+
+        if type(value) is dict:
+            for key, value_ in value.items():
+                if key in schema:
+                    new_item = deepcopy(schema[key])
+
+                # If the key is not available in the schema, but wildcard is
+                # present, we use the schema for the wildcard.
+                elif "*" in schema:
+                    new_item = deepcopy(schema["*"])
+                else:
+                    return ConfigStatus(
+                        CONFIG_PARSER_FAILURE,
+                        f'Key "{key}" should not be '
+                        f'specified in field "{self.name()}".',
+                        self,
+                    )
+
+                new_item.set_name(f"{self.name()}.{key}")
+                new_value[key] = new_item
+
+                # If it was not able to set the value, for this
+                # field, we fail.
+                config_status = new_item.set_value(value_)
+                if config_status.status() == CONFIG_PARSER_FAILURE:
+                    return config_status
+        else:
+            return ConfigStatus(
+                CONFIG_PARSER_FAILURE,
+                f'Value for field "{self.name()}" should be an object.'
+                f" Type {type(value)} is provided instead.",
+                self,
+            )
+
+        return super().set_value(new_value)
+
+    def __getattr__(self, name):
+        # We need to add this check, to prevent infinite
+        # recursion when using deep copy. See the link below:
+        # https://stackoverflow.com/questions/47299243/recursionerror-when-python-copy-deepcopy
+
+        if name == "__setstate__":
+            raise AttributeError(name)
+        elif name in self._value:
+            return self._value[name].value()
+        else:
+            raise AttributeError(name)

model_analyzer/config/input/config_primitive.py

@@ -0,0 +1,81 @@
+#!/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 ConfigPrimitive(ConfigValue):
+    """
+    A wrapper class for the primitive datatypes.
+    """
+
+    def __init__(
+        self,
+        type_,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        Parameters
+        ----------
+        type_ : type
+            Type of the field.
+        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_
+        self._value = None
+
+    def set_value(self, value):
+        """
+        Set the value for this field.
+
+        value : object
+            The value for this field.
+        """
+
+        if self._is_primitive(value):
+            try:
+                value = self._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(value)
+        else:
+            return ConfigStatus(
+                CONFIG_PARSER_FAILURE,
+                f'Value "{value}" for field "{self.name()}" should be a primitive type.',
+                self,
+            )

model_analyzer/config/input/config_status.py

@@ -0,0 +1,75 @@
+#!/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.
+
+
+class ConfigStatus:
+    def __init__(self, status, message=None, config_object=None):
+        """
+        Create a new ConfigStatus
+
+        Parameters
+        ----------
+        status : int
+            Status of the config parsing. Accepted
+            values are CONFIG_PARSER_SUCCESS and
+            CONFIG_PARSER_FAILURE.
+
+        message : str
+            A string message containing the description.
+
+        config_object : ConfigValue
+            ConfigObject that is creating this status.
+        """
+
+        self._status = status
+        self._message = message
+        self._config_object = config_object
+
+    def status(self):
+        """
+        Get the config status.
+
+        Returns
+        -------
+        int
+            Config status
+        """
+
+        return self._status
+
+    def message(self):
+        """
+        Get the message.
+
+        Returns
+        -------
+        str
+            The message for the status.
+        """
+
+        return self._message
+
+    def config_object(self):
+        """
+        Get the config object for this status.
+
+        Returns
+        -------
+        ConfigValue or None
+            Config object that created this status.
+        """
+
+        return self._config_object

model_analyzer/config/input/config_sweep.py

@@ -0,0 +1,83 @@
+#!/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_list_generic import ConfigListGeneric
+from .config_status import ConfigStatus
+from .config_value import ConfigValue
+
+
+class ConfigSweep(ConfigValue):
+    """
+    Representation of dictionaries in Config
+    """
+
+    def __init__(
+        self,
+        sweep_type,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+    ):
+        """
+        sweep_type : ConfigValue
+            The type of parameter that we are going to sweep on.
+        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.
+        """
+
+        self._sweep_type = sweep_type
+        super().__init__(preprocess, required, validator, output_mapper)
+
+    def set_value(self, value):
+        config_statuses = []
+
+        sweep_type = self._sweep_type
+        sweep_type.set_name(self._name)
+        config_status = sweep_type.set_value(value)
+        config_statuses.append(config_status)
+
+        if config_status.status() == CONFIG_PARSER_SUCCESS:
+            self._is_sweepable = False
+            return super().set_value([sweep_type])
+        else:
+            config_list = ConfigListGeneric(sweep_type)
+            config_list.set_name(self._name)
+            config_status_list = config_list.set_value(value)
+            if config_status_list.status() == CONFIG_PARSER_SUCCESS:
+                self._is_sweepable = True
+                return super().set_value(config_list)
+            config_statuses.append(config_status_list)
+
+        message = (
+            f'Field "{self._name}" is a sweep parameter. If you intend to provide a sweep parameter, '
+            "fix the number one error, otherwise fix error number two: "
+            f"1. {config_statuses[0].message()}"
+            f" 2. {config_statuses[1].message()}"
+        )
+
+        return ConfigStatus(CONFIG_PARSER_FAILURE, message)
+
+    def is_sweepable(self):
+        return self._is_sweepable

model_analyzer/config/input/config_union.py

@@ -0,0 +1,113 @@
+#!/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 ConfigUnion(ConfigValue):
+    """
+    ConfigUnion allows the value to be any of multiple ConfigValue types.
+    """
+
+    def __init__(
+        self,
+        types,
+        preprocess=None,
+        required=False,
+        validator=None,
+        output_mapper=None,
+        name=None,
+    ):
+        """
+        Create a new ConfigUnion.
+
+        Parameters
+        ----------
+        types : list
+            A list of ConfigValue that are allowed for this field.
+        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.
+        """
+
+        self._types = types
+        self._used_type_index = 0
+        super().__init__(preprocess, required, validator, output_mapper, name)
+
+    def set_value(self, value):
+        """
+        Set the value for this field.
+
+        value : object
+            The value for this field.
+        """
+
+        config_statuses = []
+        for i, type_ in enumerate(self._types):
+            config_status = type_.set_value(value)
+            config_statuses.append(config_status)
+            if config_status.status() == CONFIG_PARSER_SUCCESS:
+                self._used_type_index = i
+                return super().set_value(type_)
+
+        message = (
+            f'Value "{value}" cannot be set for field "{self.name()}".'
+            " This field allows multiple types of values."
+            " You only need to fix one of the errors below:\n"
+        )
+        for config_status in config_statuses:
+            message_lines = config_status.message().split("\n")
+
+            # ConfigUnion needs to repeat the same structure. The lines
+            # below make a couple of adjustments to ensure that
+            # lines are printed correctly.
+            if type(config_status.config_object()) is ConfigUnion:
+                # Make sure that the line is not empty
+                if not message_lines[0].strip() == "":
+                    message += f"\t* {message_lines[0]}\n"
+                    for message_line in message_lines[1:]:
+                        message += f"\t {message_line}\n"
+            else:
+                for message_line in message_lines:
+                    message += f"\t* {message_line} \n"
+
+        return ConfigStatus(CONFIG_PARSER_FAILURE, message, self)
+
+    def set_name(self, name):
+        """
+        This function must be called before the set_value.
+        """
+
+        super().set_name(name)
+        for type_ in self._types:
+            type_.set_name(self.name())
+
+    def cli_type(self):
+        used_type_index = self._used_type_index
+        return self._types[used_type_index].cli_type()
+
+    def container_type(self):
+        return self.cli_type()

model_analyzer/config/input/config_utils.py

@@ -0,0 +1,128 @@
+#!/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.
+
+import os
+import shutil
+
+from model_analyzer.constants import CONFIG_PARSER_FAILURE, CONFIG_PARSER_SUCCESS
+
+from .config_primitive import ConfigPrimitive
+from .config_status import ConfigStatus
+
+##############
+# Validators #
+##############
+
+
+def parent_path_validator(path):
+    """
+    Perform a check on parent directory. Used when the file at
+    'path' can be created by Model Analyzer in order to validate
+    the parent directory of the file.
+
+    Parameters
+    ----------
+    path: str
+        Absolute path to a file or directory
+
+    Returns
+    -------
+    ConfigStatus
+    """
+
+    abspath = os.path.abspath(path)
+
+    if os.path.exists(os.path.dirname(abspath)):
+        return ConfigStatus(status=CONFIG_PARSER_SUCCESS)
+    else:
+        return ConfigStatus(
+            status=CONFIG_PARSER_FAILURE,
+            message=f"Either the parent directory for '{path}' does not exist, or Model Analyzer "
+            "does not have permissions to execute os.stat on this path.",
+        )
+
+
+def binary_path_validator(path):
+    """
+    Used when path must refer to a valid binary
+    such as for tritonserver or perf_analyzer.
+
+    Parameters
+    ----------
+    path: str
+        name of a binary if on PATH, or
+        absolute path to a binary.
+
+    Returns
+    -------
+    ConfigStatus
+    """
+
+    if shutil.which(path):
+        return ConfigStatus(status=CONFIG_PARSER_SUCCESS)
+    else:
+        return ConfigStatus(
+            status=CONFIG_PARSER_FAILURE,
+            message=f"Either the binary '{path}' is not on the PATH, or Model Analyzer does "
+            "not have permissions to execute os.stat on this path.",
+        )
+
+
+def file_path_validator(path):
+    """
+    Perform some basic checks on strings passed in as paths.
+    Used when the path is expected to exist, and Model Analyzer
+    does not create the file at that path.
+
+    Parameters
+    ----------
+    path: str
+        Absolute path to a file or directory
+
+    Returns
+    -------
+    ConfigStatus
+    """
+
+    abspath = os.path.abspath(path)
+
+    if os.path.exists(abspath):
+        return ConfigStatus(status=CONFIG_PARSER_SUCCESS)
+    else:
+        return ConfigStatus(
+            status=CONFIG_PARSER_FAILURE,
+            message=f"Either '{path}' is a nonexistent path, or Model Analyzer does "
+            "not have permissions to execute os.stat on this path",
+        )
+
+
+##################
+# Output mappers #
+##################
+
+
+def objective_list_output_mapper(objectives):
+    """
+    Takes a list of objectives and maps them
+    into a dict
+    """
+
+    output_dict = {}
+    for objective in objectives:
+        value = ConfigPrimitive(type_=int)
+        value.set_value(10)
+        output_dict[objective] = value
+    return output_dict