Merge pull request #1593 from ollycassidy13/feature/applyconfig-error-reporting

Report Invalid Custom Op Configs

Author: auphelia

src/finn/transformation/general.py

@@ -17,7 +17,7 @@
 
 # Protobuf onnx graph node type
 from onnx import AttributeProto, NodeProto, mapping  # noqa
-from qonnx.custom_op.registry import getCustomOp
+from qonnx.custom_op.registry import getCustomOp, is_custom_op
 from qonnx.transformation.base import Transformation
 
 
@@ -42,6 +42,7 @@ def __init__(self, config, node_filter=lambda x: True):
         self.node_filter = node_filter
         self.used_configurations = ["Defaults"]
         self.missing_configurations = []
+        self.ignored_non_custom_configurations = []
 
     def configure_network(self, graph_proto, model_config, subgraph_hier):
         # Configure network - graph_proto can be a GraphProto or ModelWrapper
@@ -66,10 +67,7 @@ def configure_network(self, graph_proto, model_config, subgraph_hier):
                 self.missing_configurations += [node.name]
                 node_config = {}
 
-            if node_config:
-                self.used_configurations += [config_key]
-
-            try:
+            if is_custom_op(node.domain, node.op_type):
                 inst = getCustomOp(node)
 
                 if "Defaults" in model_config.keys():
@@ -92,9 +90,11 @@ def configure_network(self, graph_proto, model_config, subgraph_hier):
                 # set node attributes from specified configuration
                 for attr_name, value in node_config.items():
                     inst.set_nodeattr(attr_name, value)
-            except Exception:
-                # Node is not a custom op, but it might have subgraphs
-                pass
+
+                if node_config:
+                    self.used_configurations += [config_key]
+            elif node_config:
+                self.ignored_non_custom_configurations += [(config_key, node.op_type)]
 
             # Recursively handle nested subgraphs
             for attr in node.attribute:
@@ -125,9 +125,29 @@ def apply(self, model):
         if len(unique_missing) > 0:
             warnings.warn("\nNo HW configuration for nodes: " + ", ".join(unique_missing))
 
+        # Check for matched configs that couldn't be applied because they were
+        # specified for standard ONNX nodes instead of custom ops.
+        unique_non_custom = list(dict.fromkeys(self.ignored_non_custom_configurations))
+        if len(unique_non_custom) > 0:
+            formatted_non_custom = [
+                "{} ({})".format(config_key, op_type) for config_key, op_type in unique_non_custom
+            ]
+            warnings.warn(
+                "\nHW configurations for non-custom nodes were ignored: "
+                + ", ".join(formatted_non_custom)
+                + ". Configs can only be applied to custom ops."
+            )
+
         # Check for unused configs (top-level configs that weren't applied)
+        ignored_configurations = [
+            config_key for config_key, _ in self.ignored_non_custom_configurations
+        ]
         unused_configs = [
-            x for x in model_config if x not in self.used_configurations and x != "Defaults"
+            x
+            for x in model_config
+            if x not in self.used_configurations
+            and x not in ignored_configurations
+            and x != "Defaults"
         ]
         if len(unused_configs) > 0:
             warnings.warn("\nUnused HW configurations: " + ", ".join(unused_configs))

tests/util/test_config.py

@@ -193,3 +193,34 @@ def modify_all_im2col_nodes(graph_proto):
 
     if os.path.exists(config_json_file):
         os.remove(config_json_file)
+
+
+@pytest.mark.util
+def test_apply_config_reports_invalid_custom_op_attr():
+    """Test invalid custom-op configs fail instead of being silently ignored."""
+
+    model, _ = make_im2col_test_model()
+    im2col_node = model.graph.node[0]
+
+    with pytest.raises(Exception):
+        model.transform(ApplyConfig({im2col_node.name: {"not_an_im2col_attr": 1}}))
+
+
+@pytest.mark.util
+def test_apply_config_warns_for_non_custom_op_config():
+    """Test explicit configs for standard ONNX nodes are reported."""
+
+    model, _ = make_im2col_test_model()
+    if_node = model.graph.node[1]
+    config = {if_node.name: {"kernel_size": [1, 1]}}
+
+    def node_filter(node):
+        return node.name == if_node.name
+
+    with pytest.warns(UserWarning) as warn_records:
+        model.transform(ApplyConfig(config, node_filter=node_filter))
+
+    warning_messages = [str(record.message) for record in warn_records]
+    assert any("Configs can only be applied to custom ops" in msg for msg in warning_messages)
+    assert any("{} ({})".format(if_node.name, if_node.op_type) in msg for msg in warning_messages)
+    assert not any("Unused HW configurations" in msg for msg in warning_messages)