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

model_analyzer/reports/report.py

@@ -0,0 +1,86 @@
+#!/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
+
+
+class Report(ABC):
+    """
+    Defines functions that need to
+    be implemented by all report
+    types
+
+    This will be a html
+    """
+
+    @abstractmethod
+    def add_title(self, title):
+        """
+        Parameters
+        ----------
+        title: str
+            The title of the report
+        """
+
+    @abstractmethod
+    def add_subheading(self, subheading):
+        """
+        Parameters
+        ----------
+        subheading: str
+            The subheading of the given section
+        """
+
+    @abstractmethod
+    def add_images(self, images, image_captions):
+        """
+        Parameters
+        ----------
+        images: list of str
+            The fullpaths to the image to
+            be added to this image row
+        image_captions : list of str
+            List of image captions
+        """
+
+    @abstractmethod
+    def add_paragraph(self, paragraph):
+        """
+        Parameters
+        ----------
+        title: paragraph
+            The text to add to
+            the report as a paragraph
+        """
+
+    @abstractmethod
+    def write_report(self, filename):
+        """
+        Write the report to disk with
+        filename
+
+        Parameters
+        ----------
+        filename : str
+            The name of the report
+        """
+
+    @abstractmethod
+    def get_file_extension(self):
+        """
+        Return the file extension for
+        the type of report
+        """

model_analyzer/reports/report_factory.py

@@ -0,0 +1,62 @@
+#!/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
+import shutil
+
+from model_analyzer.constants import LOGGER_NAME
+
+from .html_report import HTMLReport
+from .pdf_report import PDFReport
+
+logger = logging.getLogger(LOGGER_NAME)
+
+
+class ReportFactory:
+    """
+    Factory that returns the correct report object
+    """
+
+    PDF_PACKAGE = "wkhtmltopdf"
+    WARNING_PRINTED = False
+
+    @staticmethod
+    def create_report():
+        if ReportFactory._is_package_installed(f"{ReportFactory.PDF_PACKAGE}"):
+            return ReportFactory._create_pdf_report()
+        else:
+            if not ReportFactory.WARNING_PRINTED:
+                ReportFactory.WARNING_PRINTED = True
+                logging.warning(
+                    f"Warning: html reports are being generated instead of pdf because "
+                    f"{ReportFactory.PDF_PACKAGE} is not installed. If you want pdf "
+                    f"reports, run the following command and then rerun Model Analyzer: "
+                    f'"sudo apt-get update && sudo apt-get install wkhtmltopdf"'
+                )
+            return ReportFactory._create_html_report()
+
+    @staticmethod
+    def _create_pdf_report():
+        return PDFReport()
+
+    @staticmethod
+    def _create_html_report():
+        return HTMLReport()
+
+    @staticmethod
+    def _is_package_installed(package_name):
+        package_found = shutil.which(f"{package_name}")
+        return package_found is not None