ONNX Passes
Collection of ONNX model graph transformation and analysis passes based on ONNX IR and ONNX Script for fast and interactive prototyping of model optimizations
Motivation
Custom ONNX compilers, such as FINN make heavy use of graph transformations to gradually convert and optimize the ONNX graph to a representation understood by the compiler backend. The most prominent set of such graph transformations in the FINN framework is the so-called streamlining to uncover the underlying integer-only compute of a quantized neural network as part of the optimizing compiler frontend.
Usually these transformations follow a stereotypical structure of (1) detecting a particular pattern within the graph, (2) checking a set of conditions on this pattern and, based on the result of these checks, (3) inserting a new or modified pattern into the graph. However, most of the work needs to be done by hand with only thin wrappers around the raw ONNX representation based on QONNX This causes significant development overheads when integrating complex transformations. Furthermore, this can lead to code-bloat, is error-prone and prevents effective reuse of transformations outside the FINN and QONNX ecosystem.
This is an experimental reimagination of this graph transformation framework based on infrastructure provided by ONNX IR and ONNX Script, in particular pattern-based graph rewriter, to simplify integrating novel graph transformations by avoiding most of the boilerplate. This pattern-based graph rewriter closely follows the familiar (1)-(3) process while hiding most of the graph internals, such as node removal and insertion or wiring node inputs and outputs to other nodes.
Installation
pip install onnx-passes
Tightly Verified Transformations
When successively transforming and optimizing a model, it is important to ensure that the resulting model still matches the original model (at least within some reasonable tolerance). To do this, the FINN framework injects verification steps at a coarse schedule into the flow by evaluating the model and comparing the outputs to a known reference. This project experiments with taking this a step further by allowing to tightly verify the model after each individual pass application. As a pass developer, novel passes can easily be enabled for verification by tagging them with the appropriate verification decorator.
# This transformation rewires any addition with two distinct inputs to add the
# first input to itself while ignoring the second one. This is not a valid
# equivalent transformation. However, as it is tagged to verify equality,
# applying this to any model containing Adds will raise a VerificationError
@passes.verify.equality
@passes.register()
class BreakAdds(Transformation, RewriteRulePass):
def pattern(self, op, x, y):
return op.Add(x, y)
def check(self, _, x, y):
return x != y
def rewrite(self, op, x, y):
return op.Add(x, x)
Applying this demo transformation with the command-line flow will produce outputs roughly as follows:
$ onnx-passes -c cfg.yaml -o out.onnx model.onnx ... BreakAdds ...
...
Applied 1 of general pattern rewrite rules.
PostconditionError: Post-condition for pass 'BreakAdds' failed
VerificationError: global_output_0 not as expected
Currently three verification methods are implemented: equality-, tolerance- and metric-based verification, where equality- and tolerance-based roughly correspond to what is implemented in FINN, where the novel metric-based method allows the user to inject metrics and accepted metric ranges for verification. This method could become relevant once introducing approximating optimizations which no longer guarantee model equality and tracking degradation of a task-specific metric, such as accuracy, is more indicative.
Roadmap and Ideas
- Skeleton of pass base-classes: Analysis, Annotation, Transformation, RewriteRulePass and ComposePass
- Basic cleanup and constant-folding transformations based on ONNX IR and ONNX Script
- Infrastructure for tight verification of transformations via ONNX Runtime model execution
- Simple command-line script
onnx-passesfor experimenting with pass-application and verification - QONNX interoperability:
Quant,BipolarQuant,TruncandMultiThresholdoperators, arbitrary-precision integer data types (work in progress) - Reimplement streamlining similar to FINN (work in progress)
- Annotating and resolving pass dependencies and follow-up post-processing transformations, e.g., streamline needs shape-inference and must be followed by cleanup
- Verification of structural properties of a graph, e.g., cycle-free, isomorphic to..., connected, ...
- ...
Metadata
Release files for onnx-passes 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| onnx_passes-0.4.1.tar.gz | 101.9 kB | Without provenance | Details for onnx_passes-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| onnx_passes-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for onnx_passes-0.4.1-py3-none-any.whl |
Total release size: 244.2 kB
Release files / onnx_passes-0.4.1.tar.gz
| Download URL | onnx_passes-0.4.1.tar.gz |
|---|---|
| Size | 101.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d5b666ac753ea7bd6bbe0c9c081172e0941fd06644d1a172810930a0d6630a8e
|
|
BLAKE2b-256 checksum How to use checksums |
a80a2b9f565e936595f8c239cc58838e14ba015ba88306f108d7df6c98fa9abe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.11.15 Linux/6.17.0-1010-azure
|
Release files / onnx_passes-0.4.1-py3-none-any.whl
| Download URL | onnx_passes-0.4.1-py3-none-any.whl |
|---|---|
| Size | 142.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
20bc96cd5268b6358be536189de63e72f3d5b83f76e4ea1de84140e11e8f62e7
|
|
BLAKE2b-256 checksum How to use checksums |
b39e098bd7097abd623ec394074d672491f7ea620aa58673423f871b17d89724
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.11.15 Linux/6.17.0-1010-azure
|
Security for onnx-passes 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.