onnx-ir 0.1.6__tar.gz → 0.1.8__tar.gz

{onnx_ir-0.1.6/src/onnx_ir.egg-info → onnx_ir-0.1.8}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: onnx-ir
-Version: 0.1.6
+Version: 0.1.8
 Summary: Efficient in-memory representation for ONNX
 Author-email: ONNX Contributors <onnx-technical-discuss@lists.lfaidata.foundation>
-License: Apache License v2.0
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://onnx.ai/ir-py
 Project-URL: Issues, https://github.com/onnx/ir-py/issues
 Project-URL: Repository, https://github.com/onnx/ir-py
@@ -13,7 +13,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -23,7 +22,7 @@ Requires-Dist: typing_extensions>=4.10
 Requires-Dist: ml_dtypes
 Dynamic: license-file
 
-# ONNX IR
+# <img src="docs/_static/logo-light.png" alt="ONNX IR" width="250"/>
 
 [![PyPI - Version](https://img.shields.io/pypi/v/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
@@ -61,6 +60,10 @@ pip install git+https://github.com/onnx/ir-py.git
 - Pythonic and familiar APIs: Classes define Pythonic apis and still map to ONNX protobuf concepts in an intuitive way.
 - No protobuf dependency: The IR does not require protobuf once the model is converted to the IR representation, decoupling from the serialization format.
 
+## Concept Diagram
+
+![Concept Diagram](docs/resource/onnx-ir-entities.svg)
+
 ## Code Organization 🗺️
 
 - [`_protocols.py`](src/onnx_ir/_protocols.py): Interfaces defined for all entities in the IR.

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/README.md

@@ -1,4 +1,4 @@
-# ONNX IR
+# <img src="docs/_static/logo-light.png" alt="ONNX IR" width="250"/>
 
 [![PyPI - Version](https://img.shields.io/pypi/v/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
@@ -36,6 +36,10 @@ pip install git+https://github.com/onnx/ir-py.git
 - Pythonic and familiar APIs: Classes define Pythonic apis and still map to ONNX protobuf concepts in an intuitive way.
 - No protobuf dependency: The IR does not require protobuf once the model is converted to the IR representation, decoupling from the serialization format.
 
+## Concept Diagram
+
+![Concept Diagram](docs/resource/onnx-ir-entities.svg)
+
 ## Code Organization 🗺️
 
 - [`_protocols.py`](src/onnx_ir/_protocols.py): Interfaces defined for all entities in the IR.

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=70"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -11,7 +11,8 @@ authors = [
 ]
 readme = "README.md"
 requires-python = ">=3.9"
-license = {text = "Apache License v2.0"}
+license = "Apache-2.0"
+license-files = ["LICEN[CS]E*"]
 classifiers = [
   "Development Status :: 4 - Beta",
   "Programming Language :: Python :: 3.9",
@@ -19,7 +20,6 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
-  "License :: OSI Approved :: Apache Software License",
 ]
 dependencies = ["numpy", "onnx>=1.16", "typing_extensions>=4.10", "ml_dtypes"]
 

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/__init__.py

@@ -167,4 +167,4 @@ def __set_module() -> None:
 
 
 __set_module()
-__version__ = "0.1.6"
+__version__ = "0.1.8"

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/_convenience/__init__.py

@@ -58,44 +58,52 @@ def _infer_attribute_type(attr: SupportedAttrTypes) -> _enums.AttributeType:
         return _enums.AttributeType.STRING
     if isinstance(attr, _core.Attr):
         return attr.type
-    if isinstance(attr, Sequence) and all(isinstance(x, int) for x in attr):
-        return _enums.AttributeType.INTS
-    if isinstance(attr, Sequence) and all(isinstance(x, float) for x in attr):
-        return _enums.AttributeType.FLOATS
-    if isinstance(attr, Sequence) and all(isinstance(x, str) for x in attr):
-        return _enums.AttributeType.STRINGS
+    if isinstance(attr, (_core.Graph, onnx.GraphProto, _protocols.GraphProtocol)):
+        return _enums.AttributeType.GRAPH
     if isinstance(attr, (_core.TensorBase, onnx.TensorProto, _protocols.TensorProtocol)):
         # Be sure to check TensorProtocol last because isinstance checking on Protocols can be slower
         return _enums.AttributeType.TENSOR
-    if isinstance(attr, Sequence) and all(
-        isinstance(x, (_core.TensorBase, onnx.TensorProto, _protocols.TensorProtocol))
-        for x in attr
-    ):
-        return _enums.AttributeType.TENSORS
-    if isinstance(attr, (_core.Graph, onnx.GraphProto, _protocols.GraphProtocol)):
-        return _enums.AttributeType.GRAPH
-    if isinstance(attr, Sequence) and all(
-        isinstance(x, (_core.Graph, onnx.GraphProto, _protocols.GraphProtocol)) for x in attr
-    ):
-        return _enums.AttributeType.GRAPHS
     if isinstance(
         attr,
         (_core.TensorType, _core.SequenceType, _core.OptionalType, _protocols.TypeProtocol),
     ):
         return _enums.AttributeType.TYPE_PROTO
-    if isinstance(attr, Sequence) and all(
-        isinstance(
-            x,
-            (
-                _core.TensorType,
-                _core.SequenceType,
-                _core.OptionalType,
-                _protocols.TypeProtocol,
-            ),
-        )
-        for x in attr
-    ):
-        return _enums.AttributeType.TYPE_PROTOS
+    if isinstance(attr, Sequence):
+        if not attr:
+            logger.warning(
+                "Attribute type is ambiguous because it is an empty sequence. "
+                "Please create an Attr with an explicit type. Defaulted to INTS"
+            )
+            return _enums.AttributeType.INTS
+        if all(isinstance(x, int) for x in attr):
+            return _enums.AttributeType.INTS
+        if all(isinstance(x, float) for x in attr):
+            return _enums.AttributeType.FLOATS
+        if all(isinstance(x, str) for x in attr):
+            return _enums.AttributeType.STRINGS
+        if all(
+            isinstance(x, (_core.TensorBase, onnx.TensorProto, _protocols.TensorProtocol))
+            for x in attr
+        ):
+            return _enums.AttributeType.TENSORS
+        if all(
+            isinstance(x, (_core.Graph, onnx.GraphProto, _protocols.GraphProtocol))
+            for x in attr
+        ):
+            return _enums.AttributeType.GRAPHS
+        if all(
+            isinstance(
+                x,
+                (
+                    _core.TensorType,
+                    _core.SequenceType,
+                    _core.OptionalType,
+                    _protocols.TypeProtocol,
+                ),
+            )
+            for x in attr
+        ):
+            return _enums.AttributeType.TYPE_PROTOS
     raise TypeError(f"Unsupported attribute type: '{type(attr)}'")
 
 
@@ -218,7 +226,7 @@ def convert_attributes(
         ...     "type_protos": [ir.TensorType(ir.DataType.FLOAT), ir.TensorType(ir.DataType.FLOAT)],
         ... }
         >>> convert_attributes(attrs)
-        [Attr('int', INT, 1), Attr('float', FLOAT, 1.0), Attr('str', STRING, 'hello'), Attr('ints', INTS, [1, 2, 3]), Attr('floats', FLOATS, [1.0, 2.0, 3.0]), Attr('strings', STRINGS, ['hello', 'world']), Attr('tensor', TENSOR, Tensor<DOUBLE,[3]>(array([1., 2., 3.]), name=None)), Attr('tensor_proto', TENSOR, TensorProtoTensor<FLOAT,[3]>(array([1., 2., 3.], dtype=float32), name='proto')), Attr('graph', INTS, Graph(
+        [Attr('int', INT, 1), Attr('float', FLOAT, 1.0), Attr('str', STRING, 'hello'), Attr('ints', INTS, [1, 2, 3]), Attr('floats', FLOATS, [1.0, 2.0, 3.0]), Attr('strings', STRINGS, ['hello', 'world']), Attr('tensor', TENSOR, Tensor<DOUBLE,[3]>(array([1., 2., 3.]), name=None)), Attr('tensor_proto', TENSOR, TensorProtoTensor<FLOAT,[3]>(array([1., 2., 3.], dtype=float32), name='proto')), Attr('graph', GRAPH, Graph(
             name='graph0',
             inputs=(
         <BLANKLINE>
@@ -247,11 +255,20 @@ def convert_attributes(
             len()=0
         )]), Attr('type_proto', TYPE_PROTO, Tensor(FLOAT)), Attr('type_protos', TYPE_PROTOS, [Tensor(FLOAT), Tensor(FLOAT)])]
 
+    .. important::
+        An empty sequence should be created with an explicit type by initializing
+        an Attr object with an attribute type to avoid type ambiguity. For example::
+
+            ir.Attr("empty", [], type=ir.AttributeType.INTS)
+
     Args:
         attrs: A dictionary of {<attribute name>: <python objects>} to convert.
 
     Returns:
-        A list of _core.Attr objects.
+        A list of :class:`_core.Attr` objects.
+
+    Raises:
+        TypeError: If an attribute type is not supported.
     """
     attributes: list[_core.Attr] = []
     for name, attr in attrs.items():

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/_core.py

@@ -836,6 +836,11 @@ class StringTensor(TensorBase, _protocols.TensorProtocol):  # pylint: disable=to
         """The shape of the tensor. Immutable."""
         return self._shape
 
+    @property
+    def nbytes(self) -> int:
+        """The number of bytes in the tensor."""
+        return sum(len(string) for string in self.string_data())
+
     @property
     def raw(self) -> Sequence[bytes] | npt.NDArray[np.bytes_]:
         """Backing data of the tensor. Immutable."""
@@ -2564,14 +2569,23 @@ class Graph(_protocols.GraphProtocol, Sequence[Node], _display.PrettyPrintable):
 
         .. versionadded:: 0.1.2
         """
-        seen_graphs: set[Graph] = set()
-        for node in onnx_ir.traversal.RecursiveGraphIterator(self):
-            graph = node.graph
+        # Use a dict to preserve order
+        seen_graphs: dict[Graph, None] = {}
+
+        # Need to use the enter_graph callback so that empty subgraphs are collected
+        def enter_subgraph(graph) -> None:
             if graph is self:
-                continue
-            if graph is not None and graph not in seen_graphs:
-                seen_graphs.add(graph)
-                yield graph
+                return
+            if not isinstance(graph, Graph):
+                raise TypeError(
+                    f"Expected a Graph, got {type(graph)}. The model may be invalid"
+                )
+            if graph not in seen_graphs:
+                seen_graphs[graph] = None
+
+        for _ in onnx_ir.traversal.RecursiveGraphIterator(self, enter_graph=enter_subgraph):
+            pass
+        yield from seen_graphs.keys()
 
     # Mutation methods
     def append(self, node: Node, /) -> None:
@@ -3180,6 +3194,21 @@ class Function(_protocols.FunctionProtocol, Sequence[Node], _display.PrettyPrint
     def attributes(self) -> _graph_containers.Attributes:
         return self._attributes
 
+    @property
+    def graph(self) -> Graph:
+        """The underlying Graph object that contains the nodes of this function.
+
+        Only use this graph for identity comparison::
+
+            if value.graph is function.graph:
+                # Do something with the value that belongs to this function
+
+        Otherwise use the Function object directly to access the nodes and other properties.
+
+        .. versionadded:: 0.1.7
+        """
+        return self._graph
+
     @typing.overload
     def __getitem__(self, index: int) -> Node: ...
     @typing.overload
@@ -3240,14 +3269,22 @@ class Function(_protocols.FunctionProtocol, Sequence[Node], _display.PrettyPrint
 
         .. versionadded:: 0.1.2
         """
-        seen_graphs: set[Graph] = set()
-        for node in onnx_ir.traversal.RecursiveGraphIterator(self):
-            graph = node.graph
-            if graph is self._graph:
-                continue
-            if graph is not None and graph not in seen_graphs:
-                seen_graphs.add(graph)
-                yield graph
+        seen_graphs: dict[Graph, None] = {}
+
+        # Need to use the enter_graph callback so that empty subgraphs are collected
+        def enter_subgraph(graph) -> None:
+            if graph is self:
+                return
+            if not isinstance(graph, Graph):
+                raise TypeError(
+                    f"Expected a Graph, got {type(graph)}. The model may be invalid"
+                )
+            if graph not in seen_graphs:
+                seen_graphs[graph] = None
+
+        for _ in onnx_ir.traversal.RecursiveGraphIterator(self, enter_graph=enter_subgraph):
+            pass
+        yield from seen_graphs.keys()
 
     # Mutation methods
     def append(self, node: Node, /) -> None:
@@ -3349,7 +3386,7 @@ class Attr(
 ):
     """Base class for ONNX attributes or references."""
 
-    __slots__ = ("_name", "_ref_attr_name", "_type", "_value", "doc_string")
+    __slots__ = ("_metadata", "_name", "_ref_attr_name", "_type", "_value", "doc_string")
 
     def __init__(
         self,
@@ -3365,6 +3402,7 @@ class Attr(
         self._value = value
         self._ref_attr_name = ref_attr_name
         self.doc_string = doc_string
+        self._metadata: _metadata.MetadataStore | None = None
 
     @property
     def name(self) -> str:
@@ -3386,6 +3424,17 @@ class Attr(
     def ref_attr_name(self) -> str | None:
         return self._ref_attr_name
 
+    @property
+    def meta(self) -> _metadata.MetadataStore:
+        """The metadata store for intermediate analysis.
+
+        Write to the :attr:`metadata_props` if you would like the metadata to be serialized
+        to the ONNX proto.
+        """
+        if self._metadata is None:
+            self._metadata = _metadata.MetadataStore()
+        return self._metadata
+
     def is_ref(self) -> bool:
         """Check if this attribute is a reference attribute."""
         return self.ref_attr_name is not None

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/_enums.py

@@ -5,6 +5,7 @@
 from __future__ import annotations
 
 import enum
+from typing import Any
 
 import ml_dtypes
 import numpy as np
@@ -77,7 +78,7 @@ class DataType(enum.IntEnum):
         if dtype in _NP_TYPE_TO_DATA_TYPE:
             return cls(_NP_TYPE_TO_DATA_TYPE[dtype])
 
-        if np.issubdtype(dtype, np.str_):
+        if np.issubdtype(dtype, np.str_) or np.issubdtype(dtype, np.bytes_):
             return DataType.STRING
 
         # Special cases for handling custom dtypes defined in ONNX (as of onnx 1.18)
@@ -131,6 +132,146 @@ class DataType(enum.IntEnum):
             raise TypeError(f"Bitwidth not available for ONNX data type: {self}")
         return _BITWIDTH_MAP[self]
 
+    @property
+    def exponent_bitwidth(self) -> int:
+        """Returns the bit width of the exponent for floating-point types.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not supported.
+        """
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).nexp
+
+        raise TypeError(f"Exponent not available for ONNX data type: {self}")
+
+    @property
+    def mantissa_bitwidth(self) -> int:
+        """Returns the bit width of the mantissa for floating-point types.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not supported.
+        """
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).nmant
+
+        raise TypeError(f"Mantissa not available for ONNX data type: {self}")
+
+    @property
+    def eps(self) -> int | np.floating[Any]:
+        """Returns the difference between 1.0 and the next smallest representable float larger than 1.0 for the ONNX data type.
+
+        Returns 1 for integers.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not a numeric data type.
+        """
+        if self.is_integer():
+            return 1
+
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).eps
+
+        raise TypeError(f"Eps not available for ONNX data type: {self}")
+
+    @property
+    def tiny(self) -> int | np.floating[Any]:
+        """Returns the smallest positive non-zero value for the ONNX data type.
+
+        Returns 1 for integers.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not a numeric data type.
+        """
+        if self.is_integer():
+            return 1
+
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).tiny
+
+        raise TypeError(f"Tiny not available for ONNX data type: {self}")
+
+    @property
+    def min(self) -> int | np.floating[Any]:
+        """Returns the minimum representable value for the ONNX data type.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not a numeric data type.
+        """
+        if self.is_integer():
+            return ml_dtypes.iinfo(self.numpy()).min
+
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).min
+
+        raise TypeError(f"Minimum not available for ONNX data type: {self}")
+
+    @property
+    def max(self) -> int | np.floating[Any]:
+        """Returns the maximum representable value for the ONNX data type.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not a numeric data type.
+        """
+        if self.is_integer():
+            return ml_dtypes.iinfo(self.numpy()).max
+
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).max
+
+        raise TypeError(f"Maximum not available for ONNX data type: {self}")
+
+    @property
+    def precision(self) -> int:
+        """Returns the precision for the ONNX dtype if supported.
+
+        For floats returns the approximate number of decimal digits to which
+        this kind of float is precise. Returns 0 for integers.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not a numeric data type.
+        """
+        if self.is_integer():
+            return 0
+
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).precision
+
+        raise TypeError(f"Precision not available for ONNX data type: {self}")
+
+    @property
+    def resolution(self) -> int | np.floating[Any]:
+        """Returns the resolution for the ONNX dtype if supported.
+
+        Returns the approximate decimal resolution of this type, i.e.,
+         10**-precision. Returns 1 for integers.
+
+        .. versionadded:: 0.1.8
+
+        Raises:
+            TypeError: If the data type is not a numeric data type.
+        """
+        if self.is_integer():
+            return 1
+
+        if self.is_floating_point():
+            return ml_dtypes.finfo(self.numpy()).resolution
+
+        raise TypeError(f"Resolution not available for ONNX data type: {self}")
+
     def numpy(self) -> np.dtype:
         """Returns the numpy dtype for the ONNX data type.
 
@@ -215,6 +356,10 @@ class DataType(enum.IntEnum):
             DataType.FLOAT8E8M0,
         }
 
+    def is_string(self) -> bool:
+        """Returns True if the data type is a string type."""
+        return self == DataType.STRING
+
     def __repr__(self) -> str:
         return self.name
 

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/passes/common/__init__.py

@@ -6,6 +6,7 @@ __all__ = [
     "CheckerPass",
     "ClearMetadataAndDocStringPass",
     "CommonSubexpressionEliminationPass",
+    "DeduplicateHashedInitializersPass",
     "DeduplicateInitializersPass",
     "IdentityEliminationPass",
     "InlinePass",
@@ -36,6 +37,7 @@ from onnx_ir.passes.common.identity_elimination import (
     IdentityEliminationPass,
 )
 from onnx_ir.passes.common.initializer_deduplication import (
+    DeduplicateHashedInitializersPass,
     DeduplicateInitializersPass,
 )
 from onnx_ir.passes.common.inliner import InlinePass

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/passes/common/constant_manipulation.py

@@ -148,6 +148,7 @@ class LiftSubgraphInitializersToMainGraphPass(ir.passes.InPlacePass):
             if graph is model.graph:
                 continue
             for name in tuple(graph.initializers):
+                assert name is not None
                 initializer = graph.initializers[name]
                 if initializer.is_graph_input():
                     # Skip the ones that are also graph inputs
@@ -156,17 +157,24 @@ class LiftSubgraphInitializersToMainGraphPass(ir.passes.InPlacePass):
                         initializer.name,
                     )
                     continue
+                if initializer.is_graph_output():
+                    logger.debug(
+                        "Initializer '%s' is used as output, so it can't be lifted",
+                        initializer.name,
+                    )
+                    continue
                 # Remove the initializer from the subgraph
                 graph.initializers.pop(name)
                 # To avoid name conflicts, we need to rename the initializer
                 # to a unique name in the main graph
-                if name in registered_initializer_names:
-                    name_count = registered_initializer_names[name]
-                    initializer.name = f"{name}_{name_count}"
-                    registered_initializer_names[name] = name_count + 1
-                else:
-                    assert initializer.name is not None
-                    registered_initializer_names[initializer.name] = 1
+                new_name = name
+                while new_name in model.graph.initializers:
+                    if name in registered_initializer_names:
+                        registered_initializer_names[name] += 1
+                    else:
+                        registered_initializer_names[name] = 1
+                    new_name = f"{name}_{registered_initializer_names[name]}"
+                initializer.name = new_name
                 model.graph.register_initializer(initializer)
                 count += 1
                 logger.debug(

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/passes/common/identity_elimination.py

@@ -19,6 +19,7 @@ class IdentityEliminationPass(ir.passes.InPlacePass):
     """Pass for eliminating redundant Identity nodes.
 
     This pass removes Identity nodes according to the following rules:
+
     1. For any node of the form `y = Identity(x)`, where `y` is not an output
        of any graph, replace all uses of `y` with a use of `x`, and remove the node.
     2. If `y` is an output of a graph, and `x` is not an input of any graph,

onnx_ir-0.1.8/src/onnx_ir/passes/common/initializer_deduplication.py

@@ -0,0 +1,179 @@
+# Copyright (c) ONNX Project Contributors
+# SPDX-License-Identifier: Apache-2.0
+"""Pass for removing duplicated initializer tensors from a graph."""
+
+from __future__ import annotations
+
+__all__ = ["DeduplicateInitializersPass", "DeduplicateHashedInitializersPass"]
+
+
+import hashlib
+import logging
+
+import numpy as np
+
+import onnx_ir as ir
+
+logger = logging.getLogger(__name__)
+
+
+def _should_skip_initializer(initializer: ir.Value, size_limit: int) -> bool:
+    """Check if the initializer should be skipped for deduplication."""
+    if initializer.is_graph_input() or initializer.is_graph_output():
+        # Skip graph inputs and outputs
+        logger.warning(
+            "Skipped deduplication of initializer '%s' as it is a graph input or output",
+            initializer.name,
+        )
+        return True
+
+    const_val = initializer.const_value
+    if const_val is None:
+        # Skip if initializer has no constant value
+        logger.warning(
+            "Skipped deduplication of initializer '%s' as it has no constant value. The model may contain invalid initializers",
+            initializer.name,
+        )
+        return True
+
+    if const_val.size > size_limit:
+        # Skip if the initializer is larger than the size limit
+        logger.debug(
+            "Skipped initializer '%s' as it exceeds the size limit of %d elements",
+            initializer.name,
+            size_limit,
+        )
+        return True
+    return False
+
+
+def _tobytes(val):
+    """StringTensor does not support tobytes. Use 'string_data' instead.
+
+    However, 'string_data' yields a list of bytes which cannot be hashed, i.e.,
+    cannot be used to index into a dict. To generate keys for identifying
+    tensors in initializer deduplication the following converts the list of
+    bytes to an array of fixed-length strings which can be flattened into a
+    bytes-string. This, together with the tensor shape, is sufficient for
+    identifying tensors for deduplication, but it differs from the
+    representation used for serializing tensors (that is string_data) by adding
+    padding bytes so that each string occupies the same number of consecutive
+    bytes in the flattened .tobytes representation.
+    """
+    if val.dtype.is_string():
+        return np.array(val.string_data()).tobytes()
+    return val.tobytes()
+
+
+class DeduplicateInitializersPass(ir.passes.InPlacePass):
+    """Remove duplicated initializer tensors from the main graph and all subgraphs.
+
+    This pass detects initializers with identical shape, dtype, and content,
+    and replaces all duplicate references with a canonical one.
+
+    Initializers are deduplicated within each graph. To deduplicate initializers
+    in the model globally (across graphs), use :class:`~onnx_ir.passes.common.LiftSubgraphInitializersToMainGraphPass`
+    to lift the initializers to the main graph first before running pass.
+
+    .. versionadded:: 0.1.3
+    .. versionchanged:: 0.1.7
+        This pass now deduplicates initializers in subgraphs as well.
+    """
+
+    def __init__(self, size_limit: int = 1024):
+        super().__init__()
+        self.size_limit = size_limit
+
+    def call(self, model: ir.Model) -> ir.passes.PassResult:
+        modified = False
+
+        for graph in model.graphs():
+            initializers: dict[tuple[ir.DataType, tuple[int, ...], bytes], ir.Value] = {}
+            for initializer in tuple(graph.initializers.values()):
+                if _should_skip_initializer(initializer, self.size_limit):
+                    continue
+
+                const_val = initializer.const_value
+                assert const_val is not None
+
+                key = (const_val.dtype, tuple(const_val.shape), _tobytes(const_val))
+                if key in initializers:
+                    modified = True
+                    initializer_to_keep = initializers[key]  # type: ignore[index]
+                    ir.convenience.replace_all_uses_with(initializer, initializer_to_keep)
+                    assert initializer.name is not None
+                    graph.initializers.pop(initializer.name)
+                    logger.info(
+                        "Replaced initializer '%s' with existing initializer '%s'",
+                        initializer.name,
+                        initializer_to_keep.name,
+                    )
+                else:
+                    initializers[key] = initializer  # type: ignore[index]
+
+        return ir.passes.PassResult(model=model, modified=modified)
+
+
+class DeduplicateHashedInitializersPass(ir.passes.InPlacePass):
+    """Remove duplicated initializer tensors (using a hashed method) from the graph.
+
+    This pass detects initializers with identical shape, dtype, and hashed content,
+    and replaces all duplicate references with a canonical one.
+
+    This pass should have a lower peak memory usage than :class:`DeduplicateInitializersPass`
+    as it does not store the full tensor data in memory, but instead uses a hash of the tensor data.
+
+    .. versionadded:: 0.1.7
+    """
+
+    def __init__(self, size_limit: int = 4 * 1024 * 1024 * 1024):
+        super().__init__()
+        # 4 GB default size limit for deduplication
+        self.size_limit = size_limit
+
+    def call(self, model: ir.Model) -> ir.passes.PassResult:
+        modified = False
+
+        for graph in model.graphs():
+            initializers: dict[tuple[ir.DataType, tuple[int, ...], str], ir.Value] = {}
+
+            for initializer in tuple(graph.initializers.values()):
+                if _should_skip_initializer(initializer, self.size_limit):
+                    continue
+
+                const_val = initializer.const_value
+                assert const_val is not None
+
+                # Hash tensor data to avoid storing large amounts of data in memory
+                hashed = hashlib.sha512()
+                tensor_data = const_val.numpy()
+                hashed.update(tensor_data)
+                tensor_digest = hashed.hexdigest()
+
+                tensor_dims = tuple(const_val.shape.numpy())
+
+                key = (const_val.dtype, tensor_dims, tensor_digest)
+
+                if key in initializers:
+                    if _tobytes(initializers[key].const_value) != _tobytes(const_val):
+                        logger.warning(
+                            "Initializer deduplication failed: "
+                            "hashes match but values differ with values %s and %s",
+                            initializers[key],
+                            initializer,
+                        )
+                        continue
+                    modified = True
+                    initializer_to_keep = initializers[key]  # type: ignore[index]
+                    ir.convenience.replace_all_uses_with(initializer, initializer_to_keep)
+                    assert initializer.name is not None
+                    graph.initializers.pop(initializer.name)
+                    logger.info(
+                        "Replaced initializer '%s' with existing initializer '%s'",
+                        initializer.name,
+                        initializer_to_keep.name,
+                    )
+                else:
+                    initializers[key] = initializer  # type: ignore[index]
+
+        return ir.passes.PassResult(model=model, modified=modified)

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/passes/common/naming.py

@@ -64,7 +64,7 @@ class NameFixPass(ir.passes.InPlacePass):
             def custom_value_name(value: ir.Value) -> str:
                 return f"custom_value_{value.type}"
 
-        name_fix_pass = NameFixPass(nameGenerator=CustomNameGenerator())
+        name_fix_pass = NameFixPass(name_generator=CustomNameGenerator())
 
     .. versionadded:: 0.1.6
     """

{onnx_ir-0.1.6 → onnx_ir-0.1.8}/src/onnx_ir/serde.py

@@ -682,8 +682,8 @@ def deserialize_graph(proto: onnx.GraphProto) -> _core.Graph:
     Returns:
         IR Graph.
 
-    .. versionadded:: 0.3
-        Support for *quantization_annotation* is added.
+    .. versionadded:: 0.1.3
+        Support for `quantization_annotation` is added.
     """
     return _deserialize_graph(proto, [])
 
@@ -760,6 +760,18 @@ def _deserialize_graph(
     # Build the value info dictionary to allow for quick lookup for this graph scope
     value_info = {info.name: info for info in proto.value_info}
 
+    # Declare values for all node outputs from this graph scope. This is necessary
+    # to handle the case where a node in a subgraph uses a value that is declared out
+    # of order in the outer graph. Declaring the values first allows us to find the
+    # values later when deserializing the nodes in subgraphs.
+    for node in proto.node:
+        _declare_node_outputs(
+            node,
+            values,
+            value_info=value_info,
+            quantization_annotations=quantization_annotations,
+        )
+
     # Deserialize nodes with all known values
     nodes = [
         _deserialize_node(node, scoped_values, value_info, quantization_annotations)
@@ -798,6 +810,55 @@ def _deserialize_graph(
     )
 
 
+def _declare_node_outputs(
+    proto: onnx.NodeProto,
+    current_value_scope: dict[str, _core.Value],
+    value_info: dict[str, onnx.ValueInfoProto],
+    quantization_annotations: dict[str, onnx.TensorAnnotation],
+) -> None:
+    """Declare outputs for a node in the current graph scope.
+
+    This is necessary to handle the case where a node in a subgraph uses a value that is declared
+    out of order in the outer graph. Declaring the values first allows us to find the values later
+    when deserializing the nodes in subgraphs.
+
+    Args:
+        proto: The ONNX NodeProto to declare outputs for.
+        current_value_scope: The current scope of values, mapping value names to their corresponding Value objects.
+        value_info: A dictionary mapping value names to their corresponding ValueInfoProto.
+        quantization_annotations: A dictionary mapping tensor names to their corresponding TensorAnnotation.
+
+    Raises:
+        ValueError: If an output name is redeclared in the current graph scope.
+    """
+    for output_name in proto.output:
+        if output_name == "":
+            continue
+        if output_name in current_value_scope:
+            raise ValueError(
+                f"Output '{output_name}' is redeclared in the current graph scope. "
+                f"Original declaration {current_value_scope[output_name]}. "
+                f"New declaration: by operator '{proto.op_type}' of node '{proto.name}'. "
+                "The model is invalid"
+            )
+
+        # Create the value and add it to the current scope.
+        value = _core.Value(name=output_name)
+        current_value_scope[output_name] = value
+        # Fill in shape/type information if they exist
+        if output_name in value_info:
+            deserialize_value_info_proto(value_info[output_name], value)
+        else:
+            logger.debug(
+                "ValueInfoProto not found for output '%s' in node '%s' of type '%s'",
+                output_name,
+                proto.name,
+                proto.op_type,
+            )
+        if output_name in quantization_annotations:
+            _deserialize_quantization_annotation(quantization_annotations[output_name], value)
+
+
 @_capture_errors(lambda proto: proto.name)
 def deserialize_function(proto: onnx.FunctionProto) -> _core.Function:
     """Deserialize an ONNX FunctionProto into an IR Function.
@@ -812,7 +873,14 @@ def deserialize_function(proto: onnx.FunctionProto) -> _core.Function:
     values: dict[str, _core.Value] = {v.name: v for v in inputs}  # type: ignore[misc]
     value_info = {info.name: info for info in getattr(proto, "value_info", [])}
 
-    # TODO(justinchuby): Handle unsorted nodes
+    for node in proto.node:
+        _declare_node_outputs(
+            node,
+            values,
+            value_info=value_info,
+            quantization_annotations={},
+        )
+
     nodes = [
         _deserialize_node(node, [values], value_info=value_info, quantization_annotations={})
         for node in proto.node
@@ -1137,8 +1205,15 @@ def deserialize_node(proto: onnx.NodeProto) -> _core.Node:
     Returns:
         An IR Node object representing the ONNX node.
     """
+    value_scope: dict[str, _core.Value] = {}
+    _declare_node_outputs(
+        proto,
+        value_scope,
+        value_info={},
+        quantization_annotations={},
+    )
     return _deserialize_node(
-        proto, scoped_values=[{}], value_info={}, quantization_annotations={}
+        proto, scoped_values=[value_scope], value_info={}, quantization_annotations={}
     )
 
 
@@ -1161,18 +1236,18 @@ def _deserialize_node(
         for values in reversed(scoped_values):
             if input_name not in values:
                 continue
+
             node_inputs.append(values[input_name])
             found = True
             del values  # Remove the reference so it is not used by mistake
             break
         if not found:
-            # If the input is not found, we know the graph may be unsorted and
-            # the input may be a supposed-to-be initializer or an output of a node that comes later.
-            # Here we create the value with the name and add it to the current scope.
-            # Nodes need to check the value pool for potentially initialized outputs
+            # If the input is not found, we know the graph is invalid because the value
+            # is not declared. We will still create a new input for the node so that
+            # it can be fixed later.
             logger.warning(
-                "Input '%s' of node '%s(%s::%s:%s)' not found in any scope. "
-                "The graph may be unsorted. Creating a new input (current depth: %s) .",
+                "Input '%s' of node '%s' (%s::%s:%s) cannot be found in any scope. "
+                "The model is invalid but we will still create a new input for the node (current depth: %s)",
                 input_name,
                 proto.name,
                 proto.domain,
@@ -1208,35 +1283,22 @@ def _deserialize_node(
             node_outputs.append(_core.Value(name=""))
             continue
 
-        # 1. When the graph is unsorted, we may be able to find the output already created
+        # The outputs should already be declared in the current scope by _declare_node_outputs.
+        #
+        # When the graph is unsorted, we may be able to find the output already created
         # as an input to some other nodes in the current scope.
         # Note that a value is always owned by the producing node. Even though a value
         # can be created when parsing inputs of other nodes, the new node created here
         # that produces the value will assume ownership. It is then impossible to transfer
         # the ownership to any other node.
-
+        #
         # The output can only be found in the current scope. It is impossible for
         # a node to produce an output that is not in its own scope.
         current_scope = scoped_values[-1]
-        if output_name in current_scope:
-            value = current_scope[output_name]
-        else:
-            # 2. Common scenario: the graph is sorted and this is the first time we see the output.
-            # Create the value and add it to the current scope.
-            value = _core.Value(name=output_name)
-            current_scope[output_name] = value
-        # Fill in shape/type information if they exist
-        if output_name in value_info:
-            deserialize_value_info_proto(value_info[output_name], value)
-        else:
-            logger.debug(
-                "ValueInfoProto not found for output '%s' in node '%s' of type '%s'",
-                output_name,
-                proto.name,
-                proto.op_type,
-            )
-        if output_name in quantization_annotations:
-            _deserialize_quantization_annotation(quantization_annotations[output_name], value)
+        assert output_name in current_scope, (
+            f"Output '{output_name}' not found in the current scope. This is unexpected"
+        )
+        value = current_scope[output_name]
         node_outputs.append(value)
     return _core.Node(
         proto.domain,
@@ -1469,8 +1531,6 @@ def serialize_graph_into(
         serialize_value_into(graph_proto.input.add(), input_)
         if input_.name not in from_.initializers:
             # Annotations for initializers will be added below to avoid double adding
-            # TODO(justinchuby): We should add a method is_initializer() on Value when
-            # the initializer list is tracked
             _maybe_add_quantization_annotation(graph_proto, input_)
     input_names = {input_.name for input_ in from_.inputs}
     # TODO(justinchuby): Support sparse_initializer
@@ -1724,11 +1784,12 @@ def _fill_in_value_for_attribute(
 ) -> None:
     if type_ == _enums.AttributeType.INT:
         # value: int
-        attribute_proto.i = value
+        # Cast bool to int, for example
+        attribute_proto.i = int(value)
         attribute_proto.type = onnx.AttributeProto.INT
     elif type_ == _enums.AttributeType.FLOAT:
         # value: float
-        attribute_proto.f = value
+        attribute_proto.f = float(value)
         attribute_proto.type = onnx.AttributeProto.FLOAT
     elif type_ == _enums.AttributeType.STRING:
         # value: str
@@ -1818,7 +1879,7 @@ def serialize_value(value: _protocols.ValueProtocol, *, name: str = "") -> onnx.
     return value_info_proto
 
 
-@_capture_errors(lambda value_info_proto, from_: repr(from_))
+@_capture_errors(lambda value_info_proto, from_, name="": repr(from_))
 def serialize_value_into(
     value_info_proto: onnx.ValueInfoProto,
     from_: _protocols.ValueProtocol,

{onnx_ir-0.1.6 → onnx_ir-0.1.8/src/onnx_ir.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: onnx-ir
-Version: 0.1.6
+Version: 0.1.8
 Summary: Efficient in-memory representation for ONNX
 Author-email: ONNX Contributors <onnx-technical-discuss@lists.lfaidata.foundation>
-License: Apache License v2.0
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://onnx.ai/ir-py
 Project-URL: Issues, https://github.com/onnx/ir-py/issues
 Project-URL: Repository, https://github.com/onnx/ir-py
@@ -13,7 +13,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -23,7 +22,7 @@ Requires-Dist: typing_extensions>=4.10
 Requires-Dist: ml_dtypes
 Dynamic: license-file
 
-# ONNX IR
+# <img src="docs/_static/logo-light.png" alt="ONNX IR" width="250"/>
 
 [![PyPI - Version](https://img.shields.io/pypi/v/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/onnx-ir.svg)](https://pypi.org/project/onnx-ir)
@@ -61,6 +60,10 @@ pip install git+https://github.com/onnx/ir-py.git
 - Pythonic and familiar APIs: Classes define Pythonic apis and still map to ONNX protobuf concepts in an intuitive way.
 - No protobuf dependency: The IR does not require protobuf once the model is converted to the IR representation, decoupling from the serialization format.
 
+## Concept Diagram
+
+![Concept Diagram](docs/resource/onnx-ir-entities.svg)
+
 ## Code Organization 🗺️
 
 - [`_protocols.py`](src/onnx_ir/_protocols.py): Interfaces defined for all entities in the IR.

onnx_ir-0.1.6/src/onnx_ir/passes/common/initializer_deduplication.py

@@ -1,56 +0,0 @@
-# Copyright (c) ONNX Project Contributors
-# SPDX-License-Identifier: Apache-2.0
-"""Pass for removing duplicated initializer tensors from a graph."""
-
-from __future__ import annotations
-
-__all__ = [
-    "DeduplicateInitializersPass",
-]
-
-
-import onnx_ir as ir
-
-
-class DeduplicateInitializersPass(ir.passes.InPlacePass):
-    """Remove duplicated initializer tensors from the graph.
-
-    This pass detects initializers with identical shape, dtype, and content,
-    and replaces all duplicate references with a canonical one.
-
-    To deduplicate initializers from subgraphs, use :class:`~onnx_ir.passes.common.LiftSubgraphInitializersToMainGraphPass`
-    to lift the initializers to the main graph first before running pass.
-
-    .. versionadded:: 0.1.3
-    """
-
-    def __init__(self, size_limit: int = 1024):
-        super().__init__()
-        self.size_limit = size_limit
-
-    def call(self, model: ir.Model) -> ir.passes.PassResult:
-        graph = model.graph
-        initializers: dict[tuple[ir.DataType, tuple[int, ...], bytes], ir.Value] = {}
-        modified = False
-
-        for initializer in tuple(graph.initializers.values()):
-            # TODO(justinchuby): Handle subgraphs as well. For now users can lift initializers
-            # out from the main graph before running this pass.
-            const_val = initializer.const_value
-            if const_val is None:
-                # Skip if initializer has no constant value
-                continue
-
-            if const_val.size > self.size_limit:
-                continue
-
-            key = (const_val.dtype, tuple(const_val.shape), const_val.tobytes())
-            if key in initializers:
-                modified = True
-                ir.convenience.replace_all_uses_with(initializer, initializers[key])  # type: ignore[index]
-                assert initializer.name is not None
-                graph.initializers.pop(initializer.name)
-            else:
-                initializers[key] = initializer  # type: ignore[index]
-
-        return ir.passes.PassResult(model=model, modified=modified)