Merge branch 'fix/op_version-main-merge-yaman-changes' into feature/opversion_and_trunc_v2

Author: maltanar

setup.cfg

@@ -49,7 +49,7 @@ install_requires =
     importlib-metadata
     attrs>=22.2.0
     clize>=5.0.1
-    protobuf==3.20.3
+    protobuf>=3.20.3
     bitstring>=3.1.7
     numpy>=1.24.1
     onnx>=1.13.0

src/qonnx/core/modelwrapper.py

@@ -39,7 +39,7 @@
 import qonnx.util.basic as util
 import qonnx.util.onnx as onnxutil
 from qonnx.core.datatype import DataType
-from qonnx.custom_op.registry import getCustomOp
+from qonnx.custom_op.registry import getCustomOp, is_custom_op
 from qonnx.transformation.double_to_single_float import DoubleToSingleFloat
 from qonnx.transformation.general import (
     RemoveStaticGraphInputs,
@@ -183,7 +183,7 @@ def transform(
         if self.fix_float64:
             (transformed_model, model_was_changed) = DoubleToSingleFloat().apply(transformed_model)
 
-        if apply_to_subgraphs and not use_preorder_traversal:
+        if apply_to_subgraphs and (use_preorder_traversal is False):
             transformed_model.transform_subgraphs(
                 transformation, make_deepcopy, cleanup, apply_to_subgraphs, use_preorder_traversal
             )
@@ -632,11 +632,11 @@ def get_nodes_by_op_type(self, op_type):
 
     def get_finn_nodes(self):
         """Returns a list of nodes where domain == 'qonnx.*'."""
-        return list(filter(lambda x: util.is_finn_op(x.domain), self.graph.node))
+        return list(filter(lambda x: is_custom_op(x.domain), self.graph.node))
 
     def get_non_finn_nodes(self):
         """Returns a list of nodes where domain != 'qonnx.*'."""
-        return list(filter(lambda x: not util.is_finn_op(x.domain), self.graph.node))
+        return list(filter(lambda x: not is_custom_op(x.domain), self.graph.node))
 
     def get_node_index(self, node):
         """Returns current index of given node, or None if not found."""

src/qonnx/core/onnx_exec.py

@@ -35,21 +35,16 @@
 
 import qonnx.analysis.topology as ta
 import qonnx.core.execute_custom_node as ex_cu_node
-from qonnx.util.basic import (
-    get_preferred_qonnx_opset,
-    get_sanitize_quant_tensors,
-    is_finn_op,
-    qonnx_make_model,
-    sanitize_quant_values,
-)
+from qonnx.custom_op.registry import is_custom_op
+from qonnx.util.basic import get_preferred_qonnx_opset, get_sanitize_quant_tensors, qonnx_make_model, sanitize_quant_values
 
 
 def execute_node(node, context, graph, opset_version, return_full_exec_context=False):
     """Executes a single node by using onnxruntime or with a custom function.
 
     Input/output provided via context."""
 
-    if is_finn_op(node.domain):
+    if is_custom_op(node.domain, node.op_type):
         ex_cu_node.execute_custom_node(node, context, graph, onnx_opset_version=opset_version)
     else:
         # onnxruntime unfortunately does not implement run_node as defined by ONNX,

src/qonnx/custom_op/base.py

@@ -36,7 +36,27 @@
 class CustomOp(ABC):
     """CustomOp class all custom op nodes are based on. Contains different functions
     every custom node should have. Some as abstract methods, these have to be
-    filled when writing a new custom op node."""
+    filled when writing a new custom op node.
+
+    Opset Version Support:
+        CustomOp classes use "since version" semantics matching ONNX operators.
+        Version is determined by the class name using _vN suffix convention:
+
+        - No suffix (e.g., IntQuant): Version 1 (default)
+        - _vN suffix (e.g., IntQuant_v2): Version N
+
+        The registry automatically selects the highest version <= requested opset.
+
+        Example:
+            class IntQuant(CustomOp):
+                pass  # Version 1 (no suffix)
+
+            class IntQuant_v2(CustomOp):
+                pass  # Version 2, covers opset v2-v3 (if no v3 exists)
+
+            class IntQuant_v4(CustomOp):
+                pass  # Version 4, covers opset v4+
+    """
 
     def __init__(self, onnx_node, onnx_opset_version=get_preferred_qonnx_opset()):
         super().__init__()

src/qonnx/custom_op/channels_last/__init__.py

@@ -1,29 +1,17 @@
-from qonnx.custom_op.channels_last.batch_normalization import BatchNormalization
-from qonnx.custom_op.channels_last.conv import Conv
-from qonnx.custom_op.channels_last.max_pool import MaxPool
-
-# channels-last ops are defined by the underlying ONNX standard op
-# thus, we can define them for any version of the original op
-# so we emulate a custom op dictionary that mimics the support for any
-# {ChannelsLastOp}_vX instead of hardcoding what versions are supported
-
-
-class ChannelsLastCustomOpDict(dict):
-    def __init__(self):
-        self._custom_ops = {"Conv": Conv, "MaxPool": MaxPool, "BatchNormalization": BatchNormalization}
-
-    def __getitem__(self, key):
-        base_key = key.split("_v")[0]  # Extract base key (e.g., Conv from Conv_v13)
-        if base_key in self._custom_ops:
-            return self._custom_ops[base_key]
-        raise KeyError(f"Channels-last CustomOp '{key}' not found.")
-
-    def __contains__(self, key):
-        base_key = key.split("_v")[0]
-        return base_key in self._custom_ops
-
-    def keys(self):
-        return self._custom_ops.keys()
-
-
-custom_op = ChannelsLastCustomOpDict()
+# Importing registers CustomOps in qonnx.custom_op.channels_last domain
+from qonnx.custom_op.channels_last.batch_normalization import (
+    BatchNormalization_v1,
+    BatchNormalization_v9,
+    BatchNormalization_v14,
+)
+from qonnx.custom_op.channels_last.conv import Conv_v1
+from qonnx.custom_op.channels_last.max_pool import MaxPool_v1, MaxPool_v10
+
+__all__ = [
+    "Conv_v1",
+    "MaxPool_v1",
+    "MaxPool_v10",
+    "BatchNormalization_v1",
+    "BatchNormalization_v9",
+    "BatchNormalization_v14",
+]

src/qonnx/custom_op/channels_last/batch_normalization.py

@@ -32,7 +32,7 @@
 from qonnx.custom_op.channels_last.base_wrapped_op import ChannelsLastWrappedOp
 
 
-class BatchNormalization(ChannelsLastWrappedOp):
+class BatchNormalization_v1(ChannelsLastWrappedOp):
     def get_nodeattr_types(self):
         """Returns a dict of permitted attributes for node, where:
         ret_dict[attribute_name] = (dtype, require, default_value, <allowed_values>)
@@ -133,3 +133,13 @@ def verify_node(self):
             )
 
         return info_messages
+
+
+class BatchNormalization_v9(BatchNormalization_v1):
+    # no relevant changes for channels-last wrapper
+    pass
+
+
+class BatchNormalization_v14(BatchNormalization_v9):
+    # no relevant changes for channels-last wrapper
+    pass

src/qonnx/custom_op/channels_last/conv.py

@@ -33,7 +33,7 @@
 from qonnx.custom_op.general.im2col import compute_conv_output_dim
 
 
-class Conv(ChannelsLastWrappedOp):
+class Conv_v1(ChannelsLastWrappedOp):
     def get_nodeattr_types(self):
         """Returns a dict of permitted attributes for node, where:
         ret_dict[attribute_name] = (dtype, require, default_value, <allowed_values>)

src/qonnx/custom_op/channels_last/max_pool.py

@@ -33,7 +33,7 @@
 from qonnx.custom_op.general.maxpoolnhwc import compute_pool_output_dim
 
 
-class MaxPool(ChannelsLastWrappedOp):
+class MaxPool_v1(ChannelsLastWrappedOp):
     def get_nodeattr_types(self):
         """Returns a dict of permitted attributes for node, where:
         ret_dict[attribute_name] = (dtype, require, default_value, <allowed_values>)
@@ -171,3 +171,8 @@ def verify_node(self):
             )
 
         return info_messages
+
+
+class MaxPool_v10(MaxPool_v1):
+    # no relevant changes for channels-last wrapper
+    pass

src/qonnx/custom_op/general/__init__.py

@@ -26,6 +26,7 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+# Importing registers CustomOps in qonnx.custom_op.general domain
 from qonnx.custom_op.general.bipolar_quant import BipolarQuant
 from qonnx.custom_op.general.debugmarker import DebugMarker
 from qonnx.custom_op.general.floatquant import FloatQuant
@@ -34,36 +35,23 @@
 from qonnx.custom_op.general.intquant import IntQuant
 from qonnx.custom_op.general.maxpoolnhwc import MaxPoolNHWC
 from qonnx.custom_op.general.multithreshold import MultiThreshold
+from qonnx.custom_op.general.quant import Quant
 from qonnx.custom_op.general.quantavgpool2d import QuantAvgPool2d
 from qonnx.custom_op.general.trunc import Trunc_v1, Trunc_v2
 from qonnx.custom_op.general.xnorpopcount import XnorPopcountMatMul
 
-custom_op = dict()
-
-custom_op["DebugMarker"] = DebugMarker
-custom_op["QuantAvgPool2d"] = QuantAvgPool2d
-custom_op["MaxPoolNHWC"] = MaxPoolNHWC
-custom_op["GenericPartition"] = GenericPartition
-custom_op["MultiThreshold"] = MultiThreshold
-custom_op["XnorPopcountMatMul"] = XnorPopcountMatMul
-custom_op["Im2Col"] = Im2Col
-custom_op["IntQuant"] = IntQuant
-custom_op["Quant"] = IntQuant
-custom_op["Trunc"] = Trunc_v1
-custom_op["BipolarQuant"] = BipolarQuant
-custom_op["FloatQuant"] = FloatQuant
-
-custom_op["DebugMarker_v1"] = DebugMarker
-custom_op["QuantAvgPool2d_v1"] = QuantAvgPool2d
-custom_op["MaxPoolNHWC_v1"] = MaxPoolNHWC
-custom_op["GenericPartition_v1"] = GenericPartition
-custom_op["MultiThreshold_v1"] = MultiThreshold
-custom_op["XnorPopcountMatMul_v1"] = XnorPopcountMatMul
-custom_op["Im2Col_v1"] = Im2Col
-custom_op["IntQuant_v1"] = IntQuant
-custom_op["Quant_v1"] = IntQuant
-custom_op["Trunc_v1"] = Trunc_v1
-custom_op["BipolarQuant_v1"] = BipolarQuant
-custom_op["FloatQuant_v1"] = FloatQuant
-
-custom_op["Trunc_v2"] = Trunc_v2
+__all__ = [
+    "BipolarQuant",
+    "DebugMarker",
+    "FloatQuant",
+    "GenericPartition",
+    "Im2Col",
+    "IntQuant",
+    "MaxPoolNHWC",
+    "MultiThreshold",
+    "Quant",
+    "QuantAvgPool2d",
+    "Trunc_v1",
+    "Trunc_v2",
+    "XnorPopcountMatMul",
+]