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

model_analyzer/config/input/objects/config_model_report_spec.py

@@ -0,0 +1,173 @@
+#!/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 ConfigModelReportSpec:
+    """
+    A class representing the configuration used for
+    a single model.
+    """
+
+    def __init__(self, model_config_name, plots=None):
+        """
+        Parameters
+        ----------
+        model_config_name : str
+           Name used for the model
+        plots : list of ConfigPlot
+            containing plot names and ConfigObjects
+        """
+
+        self._model_config_name = model_config_name
+        self._plots = plots
+
+    def model_config_name(self):
+        """
+        Returns
+        -------
+        str
+            The model name used for this config.
+        """
+
+        return self._model_config_name
+
+    def plots(self):
+        """
+        Returns
+        -------
+        list of ConfigPlot
+            containing plot names and ConfigObjects
+        """
+
+        return self._plots
+
+    def set_model_config_name(self, model_config_name):
+        """
+        Parameters
+        -------
+        model_config_name : str
+            The model name used for this config.
+        """
+
+        self._model_config_name = model_config_name
+
+    def set_plots(self, plots):
+        """
+        Parameters
+        ----------
+        plots : list of ConfigPLot
+            containing plot names and ConfigObjects
+        """
+
+        self._plots = plots
+
+    @staticmethod
+    def model_object_to_config_model_report_spec(value):
+        """
+        Converts a ConfigObject to ConfigModelReportSpec.
+
+        Parameters
+        ----------
+        value : dict
+            A dictionary where the keys are model names
+            and the values are ConfigObjects.
+
+        Returns
+        -------
+        list
+            A list of ConfigModelReportSpec objects.
+        """
+
+        models = []
+        for model_config_name, model_properties in value.items():
+            models.append(
+                ConfigModelReportSpec(model_config_name, **model_properties.value())
+            )
+
+        return models
+
+    @staticmethod
+    def model_str_to_config_model_report_spec(model_config_name):
+        """
+        Constructs a ConfigModelReportSpec from a given
+        model_config_name.
+
+        Parameters
+        ----------
+        model_config_name : str
+            Name of the model
+
+        Returns
+        -------
+        ConfigModelReportSpec
+            ConfigModelReportSpec object with the given model name.
+        """
+
+        return ConfigModelReportSpec(model_config_name)
+
+    @staticmethod
+    def model_list_to_config_model_report_spec(report_models):
+        """
+        Construct ConfigModelReportSpec objects from a list of strings.
+
+        Parameters
+        ----------
+        report_models : list
+            A list of strings containing model names.
+
+        Returns
+        -------
+        list
+            A list of ConfigModelReportSpec objects.
+        """
+
+        models = []
+        for model_config_name in report_models:
+            models.append(ConfigModelReportSpec(model_config_name))
+        return models
+
+    @staticmethod
+    def model_mixed_to_config_model_report_spec(models):
+        """
+        Unifies a mixed list of ConfigModelReportSpec objects
+        and list of ConfigModelReportSpec objects.
+
+        Parameters
+        ----------
+        models : list
+            A mixed list containing lists or ConfigModelReportSpec objects.
+
+        Returns
+        -------
+        list
+            A list only containing ConfigModelReportSpec 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_config_name": self._model_config_name}
+        if self._plots:
+            model_object["plots"] = self._plots
+
+        return str(model_object)

model_analyzer/config/input/objects/config_plot.py

@@ -0,0 +1,198 @@
+#!/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 ConfigPlot:
+    """
+    A class representing the configuration used for
+    a single plot.
+    """
+
+    def __init__(self, name, title=None, x_axis=None, y_axis=None, monotonic=False):
+        """
+        Parameters
+        ----------
+        name : str
+            Name to use to identify the plot
+        title : str
+            title of the plot
+        x_axis : str
+            The metric tag for the x-axis of this plot
+        y_axis : str
+            The metric tag for the y-axis of this plot
+        monotonic: bool
+            Whether or not to prune decreasing points in this
+            plot
+        """
+
+        self._name = name
+        self._title = title
+        self._x_axis = x_axis
+        self._y_axis = y_axis
+        self._monotonic = monotonic
+
+    def name(self):
+        """
+        Returns
+        -------
+        str
+            Name of plot (to which it will be saved)
+        """
+
+        return self._name
+
+    def title(self):
+        """
+        Returns
+        -------
+        str
+            title of the plot
+        """
+
+        return self._title
+
+    def x_axis(self):
+        """
+        Returns
+        -------
+        str
+            tag for x_axis of the plot
+        """
+
+        return self._x_axis
+
+    def y_axis(self):
+        """
+        Returns
+        -------
+        str
+            tag for y axis of the plot
+        """
+
+        return self._y_axis
+
+    def monotonic(self):
+        """
+        Returns
+        -------
+        bool
+            Whether or not to prune
+            decreasing points
+        """
+
+        return self._monotonic
+
+    def set_name(self, name):
+        """
+        Parameters
+        -------
+        name: str
+            Name of plot (to which it will be saved)
+        """
+
+        self._name = name
+
+    def set_title(self, title):
+        """
+        Parameters
+        -------
+        str
+            title of the plot
+        """
+
+        self._title = title
+
+    def set_x_axis(self, x_axis):
+        """
+        Parameters
+        -------
+        x_axis: str
+            tag for x_axis of the plot
+        """
+
+        self._x_axis = x_axis
+
+    def set_y_axis(self, y_axis):
+        """
+        Parameters
+        -------
+        y_axis: str
+            tag for x_axis of the plot
+        """
+
+        self._y_axis = y_axis
+
+    def set_monotonic(self, monotonic):
+        """
+        Parameters
+        -------
+        monotonic: bool
+            Whether or not to prune
+            decreasing points
+        """
+
+        self._monotonic = monotonic
+
+    @staticmethod
+    def from_list(plots):
+        """
+        Converts a List of plot specs to ConfigPlot.
+
+        Parameters
+        ----------
+        plots : list
+            A list of ConfigPlots
+
+        Returns
+        -------
+        list
+            A list of ConfigPlot objects.
+        """
+
+        plot_list = []
+        for plot in plots:
+            plot_list.append(plot.value()[0])
+        return plot_list
+
+    @staticmethod
+    def from_object(plots):
+        """
+        Converts a plot spec object to ConfigPlot.
+
+        Parameters
+        ----------
+        plots : dict
+            containing plot names and ConfigObjects
+        Returns
+        -------
+        ConfigPlot
+        """
+
+        plot_list = []
+        for plot_name, plot_spec in plots.items():
+            plot_list.append(ConfigPlot(plot_name, **plot_spec.value()))
+        return plot_list
+
+    def __repr__(self):
+        plot_object = {
+            "name": self._name,
+            "title": self._title,
+            "x_axis": self._x_axis,
+            "y_axis": self._y_axis,
+            "monotonic": self._monotonic,
+        }
+
+        return str(plot_object)

model_analyzer/config/input/objects/config_protobuf_utils.py

@@ -0,0 +1,101 @@
+#!/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 google.protobuf.descriptor import FieldDescriptor
+
+from model_analyzer.model_analyzer_exceptions import TritonModelAnalyzerException
+
+
+def is_protobuf_type_primitive(protobuf_type):
+    """
+    Check whether the protobuf type is primitive (i.e. not Message).
+
+    Parameters
+    ----------
+    protobuf_type : int
+        Protobuf type
+
+    Returns
+    -------
+    bool
+        True if the protobuf type is a primitive.
+    """
+
+    if protobuf_type == FieldDescriptor.TYPE_BOOL:
+        return True
+    elif protobuf_type == FieldDescriptor.TYPE_DOUBLE:
+        return True
+    elif protobuf_type == FieldDescriptor.TYPE_FLOAT:
+        return True
+    elif protobuf_type == FieldDescriptor.TYPE_INT32:
+        return True
+    elif protobuf_type == FieldDescriptor.TYPE_INT64:
+        return True
+    elif protobuf_type == FieldDescriptor.TYPE_STRING:
+        return True
+    elif protobuf_type == FieldDescriptor.TYPE_UINT32:
+        return True
+    elif protobuf_type == FieldDescriptor.TYPE_UINT64:
+        return True
+    else:
+        return False
+
+
+def protobuf_to_config_type(protobuf_type):
+    """
+    Map the protobuf type to the Python types.
+
+    Parameters
+    ----------
+    protobuf_type : int
+        The protobuf type to be mapped.
+
+    Returns
+    -------
+    type or bool
+        The equivalent Python type for the protobuf type. If the type is not
+        supported, it will return False.
+
+    Raises
+    ------
+    TritonModelAnalyzerException
+        If the protobuf_type is not a primitive type, this exception will be
+        raised.
+    """
+
+    if not is_protobuf_type_primitive(protobuf_type):
+        raise TritonModelAnalyzerException()
+
+    # TODO: Is using int for INT32 and INT64 ok? Similarly for UINT32, UINT64,
+    # FLOAT, DOUBLE.
+    if protobuf_type == FieldDescriptor.TYPE_BOOL:
+        return bool
+    elif protobuf_type == FieldDescriptor.TYPE_DOUBLE:
+        return float
+    elif protobuf_type == FieldDescriptor.TYPE_FLOAT:
+        return float
+    elif protobuf_type == FieldDescriptor.TYPE_INT32:
+        return int
+    elif protobuf_type == FieldDescriptor.TYPE_INT64:
+        return int
+    elif protobuf_type == FieldDescriptor.TYPE_STRING:
+        return str
+    elif protobuf_type == FieldDescriptor.TYPE_UINT32:
+        return int
+    elif protobuf_type == FieldDescriptor.TYPE_UINT64:
+        return int
+    else:
+        return False

model_analyzer/config/input/yaml_config_validator.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+
+# Copyright 2022-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 logging
+from typing import Set
+
+from model_analyzer.constants import LOGGER_NAME
+from model_analyzer.model_analyzer_exceptions import TritonModelAnalyzerException
+
+logger = logging.getLogger(LOGGER_NAME)
+
+
+class YamlConfigValidator:
+    """
+    Validate all options from the yaml file.
+    """
+
+    _valid_yaml_options: Set[str] = set({})
+
+    @staticmethod
+    def validate(yaml_file):
+        """
+        Verifies the options present in the yaml config file.
+        If an error is found, the validator will throw an exception.
+        """
+        if not yaml_file:
+            return
+
+        YamlConfigValidator._create_valid_option_set()
+
+        valid = True
+        for option in yaml_file.keys():
+            valid &= YamlConfigValidator._is_valid_option(option)
+
+        if not valid:
+            raise TritonModelAnalyzerException(
+                "The Yaml configuration file is incorrect. Please check the logged errors for the specific options that are causing the issue."
+            )
+
+    @staticmethod
+    def _is_valid_option(option):
+        if option not in YamlConfigValidator._valid_yaml_options:
+            logger.error(
+                f"{option} is not a valid yaml argument. Please be sure to use underscores and check spelling."
+            )
+            return False
+        return True
+
+    @staticmethod
+    def _create_valid_option_set():
+        """
+        Create set of valid yaml options
+        """
+        # Importing here to remove a circular dependency.
+        # If these imports are moved to the top of the file, they are imported at file load.
+        # This will cause a circular dependency between ConfigCommand, ConfigCommand*, and YamlConfigValidator
+        # However, importing here, only requires these files to be imported on object initialization.
+        from model_analyzer.config.input.config_command_profile import (
+            ConfigCommandProfile,
+        )
+        from model_analyzer.config.input.config_command_report import (
+            ConfigCommandReport,
+        )
+
+        config_array = [ConfigCommandProfile(), ConfigCommandReport()]
+
+        for config in config_array:
+            for field in config.get_config():
+                YamlConfigValidator._valid_yaml_options.add(field)

model_analyzer/config/run/__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.