qairt-visualizer 0.4.0__py3-none-win_amd64.whl → 0.5.0__py3-none-win_amd64.whl

qairt_visualizer/core/errors.py

@@ -29,3 +29,10 @@ class HttpError(Exception):
         self.message = message
         full_message = f"HTTP {status} - {message}" if status else message
         super().__init__(full_message)
+
+
+class ArgumentError(Exception):
+    """Custom error class used for general argument exceptions"""
+
+    def __init__(self, message: str):
+        super().__init__(message)

qairt_visualizer/core/modules/report_generator/models/report_header.py

@@ -0,0 +1,53 @@
+# ==============================================================================
+#
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# All Rights Reserved.
+# Confidential and Proprietary - Qualcomm Technologies, Inc.
+#
+# ==============================================================================
+
+"""Model for JSON report headers"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class Version(BaseModel):
+    """
+    Class defining a Version schema
+    """
+
+    major: int
+    minor: int
+    patch: int
+
+
+DEFAULT_HEADER_VERSION = Version(major=1, minor=0, patch=0)
+DEFAULT_VERSION = Version(major=2, minor=0, patch=0)
+
+
+class ReportHeader(BaseModel):
+    """
+    Class defining a ReportHeader schema
+    """
+
+    header_version: Version = Field(default_factory=lambda: DEFAULT_HEADER_VERSION)
+    version: Version = Field(default_factory=lambda: DEFAULT_VERSION)
+    artifact_type: str
+
+
+class Report(BaseModel):
+    """
+    Class defining an Report schema
+    """
+
+    header: ReportHeader
+    data: Any
+
+    class Config:
+        """
+        Class defining the schema's configuration
+        """
+
+        extra = "forbid"

qairt_visualizer/core/modules/report_generator/report_generator.py

@@ -0,0 +1,43 @@
+# ==============================================================================
+#
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# All Rights Reserved.
+# Confidential and Proprietary - Qualcomm Technologies, Inc.
+#
+# ==============================================================================
+"""Report Generator class"""
+
+from typing import Any, Optional
+
+from qairt_visualizer.core.modules.report_generator.models.report_header import Report, ReportHeader, Version
+
+
+class ReportGenerator:
+    """Utility class to generate QAIRT Visualizer consumable JSON reports"""
+
+    def __init__(self):
+        pass
+
+    def generate_report(
+        self, artifact_type: str, content: Any, header_version: Optional[Version], version: Optional[Version]
+    ) -> Report:
+        """
+        Validates that an input file is a DLC file
+        :param artifact_type: Path to the desired DLC file to open
+        :param content: JSON serializable report content
+        :param header_version: Optional header_version for the report
+        :param version: Optional version for the report
+        """
+        report_header = ReportHeader(
+            artifact_type=artifact_type, header_version=header_version, version=version
+        )
+        report = Report(header=report_header, data=content)
+        return report
+
+    def write_report_to_file(self, output_path: str, report: ReportHeader) -> None:
+        """
+        Writes the input report out as a serialized JSON
+        :param output_path: Path to output the JSON report
+        :param report: The JSON report to serialize into a file
+        """
+        raise NotImplementedError()

qairt_visualizer/core/parsers/dlc_parser/dlc_parser.py

@@ -0,0 +1,165 @@
+# ==============================================================================
+#
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# All Rights Reserved.
+# Confidential and Proprietary - Qualcomm Technologies, Inc.
+#
+# ==============================================================================
+"""DLC Parser class"""
+
+import os
+from typing import Any, Dict, Optional, Set
+
+from qairt_visualizer.core.errors import ArgumentError
+from qairt_visualizer.core.parsers.dlc_parser.models.op_tensor_mappings import (  # type: ignore
+    DlcOpTensorMappings,
+    MappingGroup,
+    OpTensorMappings,
+)
+
+# pylint: disable=no-name-in-module
+from . import libDlModelToolsPy as modeltools  # type: ignore
+from . import libPyIrGraph as ir_graph  # type: ignore
+
+# pylint: enable=no-name-in-module
+
+# This import is not directly referenced but must
+# still be imported for modeltools to work
+_ = ir_graph
+
+OP = 1
+OPS_KEY = "ops"
+TENSOR = 0
+TENSOR_KEY = "tensors"
+
+
+class DlcParser:
+    """DLC Parser and Utility Functions"""
+
+    def __init__(self, dlc_path: str):
+        self.validate_dlc_file(dlc_path)
+        self.dlc_path = dlc_path
+        self.model_reader = modeltools.IrDlcReader()
+        self.model_reader.open(dlc_path)
+
+    def validate_dlc_file(self, dlc_file_path: str) -> None:
+        """
+        Validates that an input file is a DLC file
+        :param dlc_file_path: Path to the desired DLC file to open
+        """
+
+        if not dlc_file_path:
+            raise ArgumentError("A valid DLC file argument is required")
+        if not os.path.isfile(dlc_file_path):
+            raise FileNotFoundError(f"The input file path {dlc_file_path} does not exist")
+        if not os.path.splitext(dlc_file_path)[1] == ".dlc":
+            raise ValueError(f"The specified file {dlc_file_path} is not a DLC file")
+
+    def extract_onnx_mappings(self) -> DlcOpTensorMappings:
+        """
+        Creates a JSON serializable map of DLC ops and tensors to source,
+        and source model ops and tensors back to DLC
+        :param op_trace: The list of DLC trace objects containing the source ops
+        :param tensor_trace: The list of DLC tensor trace objects containing the source tensors
+        :return: Two dictionaries containing the map of DLC to source ops/tensors and source to
+        DLC ops/tensors
+        """
+
+        graph = self.get_ir_graph(self.model_reader)
+        op_source = graph.get_trace_info().get_op_trace_info()
+        tensor_source = graph.get_trace_info().get_tensor_trace_info()
+
+        return DlcOpTensorMappings(
+            dlc_model_path=self.dlc_path,
+            source_mappings=self._extract_onnx_mappings(op_source, tensor_source),
+            # Add backend parsing here for phase 2
+            backend_mappings=None,
+        )
+
+    # pylint: disable=too-many-locals
+    def _extract_onnx_mappings(self, dlc_op_map, dlc_tensor_map) -> Optional[OpTensorMappings]:
+        """
+        Takes op and tensor traces and returns four maps:
+        1. DLC op -> ONNX op/tensor
+        2. ONNX op -> DLC op/tensor
+        3. DLC tensor -> ONNX op/tensor
+        4. ONNX tensor -> DLC op/tensor
+        """
+        dlc_ops_to_target_ops: Dict[str, Dict[str, Set[str]]] = {}
+        target_ops_to_dlc_ops: Dict[str, Dict[str, Set[str]]] = {}
+        dlc_tensors_to_target_tensors: Dict[str, Dict[str, Set[str]]] = {}
+        target_tensors_to_dlc_tensors: Dict[str, Dict[str, Set[str]]] = {}
+
+        for category, dlc_items in zip([OPS_KEY, TENSOR_KEY], [dlc_op_map, dlc_tensor_map]):
+            for dlc_item in dlc_items:
+                dlc_item_name = dlc_item.get_name()
+                source_items = dlc_item.get_trace_pair()
+
+                for source_item in source_items:
+                    source_name = source_item.get_name()
+                    source_type = OPS_KEY if source_item.get_type() == OP else TENSOR_KEY
+
+                    # DLC -> ONNX
+                    self.update_mapping(dlc_ops_to_target_ops, dlc_item_name, source_type, source_name)
+
+                    # ONNX -> DLC
+                    self.update_mapping(target_ops_to_dlc_ops, source_name, category, dlc_item_name)
+
+                    # DLC tensor -> ONNX
+                    if category == TENSOR_KEY:
+                        self.update_mapping(
+                            dlc_tensors_to_target_tensors, dlc_item_name, source_type, source_name
+                        )
+
+                    # ONNX tensor -> DLC
+                    if source_type == TENSOR_KEY:
+                        self.update_mapping(
+                            target_tensors_to_dlc_tensors, source_name, category, dlc_item_name
+                        )
+
+        def convert_sets(d: Dict[str, Dict[str, Set[str]]]) -> Dict[str, MappingGroup]:
+            return {
+                k: MappingGroup(ops=sorted(v.get(OPS_KEY, [])), tensors=sorted(v.get(TENSOR_KEY, [])))
+                for k, v in d.items()
+            }
+
+        return (
+            OpTensorMappings(
+                dlc_ops_to_target_ops=convert_sets(dlc_ops_to_target_ops),
+                target_ops_to_dlc_ops=convert_sets(target_ops_to_dlc_ops),
+                dlc_tensors_to_target_tensors=convert_sets(dlc_tensors_to_target_tensors),
+                target_tensors_to_dlc_tensors=convert_sets(target_tensors_to_dlc_tensors),
+            )
+            if len(dlc_ops_to_target_ops)
+            or len(target_ops_to_dlc_ops)
+            or len(dlc_tensors_to_target_tensors)
+            or len(target_tensors_to_dlc_tensors)
+            else None
+        )
+
+    def update_mapping(
+        self, map_obj: Dict[str, Dict[str, Set[str]]], name: str, category: str, value: str
+    ) -> None:
+        """Simple helper function for setting dictionary objects"""
+        group: Dict[str, Set[str]] = {OPS_KEY: set(), TENSOR_KEY: set()}
+        map_obj.setdefault(name, group)
+        map_obj[name][category].add(value)
+
+    def get_ir_graph(self, model_reader: Any):
+        """
+        Gets an IR graph object from the model_reader object
+        :param model_reader: The model reader object
+        :return: An IR graph object
+        """
+        graph_names: set = model_reader.get_ir_graph_names()
+        # We only support single IR graph, so there's no need to iterate
+        # It also might make sense to make 'graph' a member variable in the future
+        if len(graph_names) > 1:
+            raise NotImplementedError("DLC's with multiple IR graphs not currently supported")
+        return self.model_reader.get_ir_graph(next(iter(graph_names)))
+
+    def close_file(self):
+        """
+        Closes the model_reader file
+        """
+        self.model_reader.close()

qairt_visualizer/core/parsers/dlc_parser/helpers/exception_helpers.py

@@ -0,0 +1,20 @@
+# ==============================================================================
+#
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# All Rights Reserved.
+# Confidential and Proprietary - Qualcomm Technologies, Inc.
+#
+# ==============================================================================
+"""CLI Exception Helpers"""
+
+import json
+import sys
+
+
+def handle_exception(e: Exception):
+    """
+    Handles CLI script exceptions
+    :param e: The exception to be serialized to JSON
+    """
+    error = {"errorType": type(e).__name__, "message": str(e)}
+    print(json.dumps(error), file=sys.stderr)

qairt_visualizer/core/parsers/dlc_parser/models/op_tensor_mappings.py

@@ -0,0 +1,46 @@
+# ==============================================================================
+#
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# All Rights Reserved.
+# Confidential and Proprietary - Qualcomm Technologies, Inc.
+#
+# ==============================================================================
+
+"""Model for op / tensor mappings data"""
+
+from typing import Dict, List, Optional
+
+from pydantic import BaseModel
+
+
+class MappingGroup(BaseModel):
+    """
+    Class defining a basic op / tensor mapping list
+    """
+
+    ops: List[str]
+    tensors: List[str]
+
+
+class OpTensorMappings(BaseModel):
+    """
+    Class defining the various op / tensor mapping relationships
+    """
+
+    dlc_ops_to_target_ops: Dict[str, MappingGroup]
+    target_ops_to_dlc_ops: Dict[str, MappingGroup]
+    dlc_tensors_to_target_tensors: Dict[str, MappingGroup]
+    target_tensors_to_dlc_tensors: Dict[str, MappingGroup]
+
+
+class DlcOpTensorMappings(BaseModel):
+    """
+    Class defining the top-level source and backend mappings
+    """
+
+    dlc_model_path: str
+    # source_model_path and backend_model_path cannot be set until phase 2
+    source_model_path: Optional[str] = None
+    source_mappings: Optional[OpTensorMappings]
+    backend_model_path: Optional[str] = None
+    backend_mappings: Optional[OpTensorMappings]

qairt_visualizer/core/parsers/dlc_parser/op_tensor_parser.py

@@ -0,0 +1,34 @@
+# ==============================================================================
+#
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# All Rights Reserved.
+# Confidential and Proprietary - Qualcomm Technologies, Inc.
+#
+# ==============================================================================
+"""DLC Op and Tensor Parsing"""
+
+import sys
+
+from qairt_visualizer.core.modules.report_generator.models.report_header import Report, ReportHeader
+from qairt_visualizer.core.parsers.dlc_parser.dlc_parser import DlcParser
+from qairt_visualizer.core.parsers.dlc_parser.helpers.exception_helpers import handle_exception
+
+
+def main():
+    """
+    CLI entry point: Gets the DLC's ops and tensors, if available.
+    """
+    try:
+        if len(sys.argv) == 1:
+            raise ValueError("An argument for a DLC file path was not provided")
+        dlc_path = sys.argv[1]
+        reader = DlcParser(dlc_path)
+        mapping_info = reader.extract_onnx_mappings()
+        report = Report(header=ReportHeader(artifact_type="OP_TENSOR_MAPPINGS"), data=mapping_info)
+        print(report.model_dump_json(indent=2))
+    except Exception as e:  # pylint: disable=broad-exception-caught
+        handle_exception(e)
+
+
+if __name__ == "__main__":
+    main()

qairt_visualizer/core/ui/dist/browser/assets/i18n/common/en.json

@@ -92,6 +92,7 @@
   "PREVIOUS": "Previous",
   "QAIRT_VISUALIZER": "QAIRT Visualizer",
   "QID": "QID",
+  "script.error.getOpTensorMappings": "Failed to get op / tensor mappings for DLC file",
   "SELECT": "Select",
   "SELECT_ALL": "Select/Unselect All",
   "SETTINGS": {

qairt_visualizer/core/ui/dist/browser/assets/i18n/graph/en.json

@@ -7,6 +7,8 @@
       "SORT_BY": "Sort by:"
     }
   },
+  "graph.controls.flattenLayers.tooltip": "Flatten namespace layers",
+  "graph.controls.restoreLayers.tooltip": "Restore namespace layers",
   "GRAPH_PANEL": {
     "ACCURACY_LIST_TOOLTIP": "View accuracy metrics for each output operation, comparing generated outputs with expected values",
     "ACCURACY_METRICS": "Accuracy Metrics",
@@ -46,6 +48,7 @@
     "ZOOM_IN": "Zoom in",
     "ZOOM_OUT": "Zoom out"
   },
+  "graph.panel.legend": "Legend",
   "GRAPHS": "Graphs",
   "OPTRACE_PANEL": {
     "FILE_NOT_FOUND": "Op-Trace file not found",

qairt_visualizer/core/ui/dist/browser/assets/i18n/panels/en.json

@@ -1,11 +1,17 @@
 {
   "panels.accuracy.info": "Accuracy",
+  "panels.graph.actions.view_op_tensor_mappings.tooltip": "View Op / Tensor Mapping",
+  "panels.graph.actions.view_op_tensor_mappings.tooltip.disabled": "No Op / Tensor Mapping Found",
+  "panels.graph.actions.view_op_tensor_mappings.tooltip.mac": "Op / Tensor Mapping not supported on Mac",
+  "panels.graph.actions.view_op_tensor_mappings.tooltip.windows": "Op / Tensor Mapping not supported on Windows",
   "panels.graph.info": "Graphically view model architecture, including connectivity, node, and tensor parameters",
   "panels.graph.label": "Graph",
+  "panels.opTensorMappings.info": "View DLC graph -> source model op and tensor mappings",
+  "panels.opTensorMappings.label": "Op Tensor Mappings",
   "panels.optrace.info": "Opstats data for a model, which helps get insight on the performance bottlenecks in the AI model execution",
   "panels.optrace.label": "Optrace",
   "panels.performance.info": "Profiling details for a model run on a given Qualcomm AI Stack runtime",
   "panels.performance.label": "Performance",
   "panels.qhas.info": "QNN HTP Analysis Summary (QHAS) reports with summarized data and charts from running models with HTP runtime",
   "panels.qhas.label": "QNN HTP Analysis"
-}
+}