hyperonnx 1.0.0__tar.gz

hyperonnx-1.0.0/.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: check coding styles
+run-name: ${{ github.actor }} lint
+on:
+  pull_request:
+    paths:
+      - 'hyperonnx/**'
+      - 'tests/**'
+jobs:
+  run-lint-public:
+    runs-on: [ubuntu-latest]
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 2
+      - name: Install uv and set the Python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/Jod
+      - name: pyright type check
+        run: |
+          uv sync --extra=test -U
+          uv run pyright hyperonnx
+          uv run pre-commit run -s HEAD^ -o HEAD

hyperonnx-1.0.0/.github/workflows/unittest.yml

@@ -0,0 +1,26 @@
+name: Run hyperonnx unit tests
+run-name: ${{ github.actor }} unit tests
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/*.yml'
+      - 'hyperonnx/**.py'
+      - 'tests/**.py'
+jobs:
+  run-public-tests:
+    runs-on: [ubuntu-latest]
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv and set the Python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          uv sync --extra=test -U
+      - name: Run pytest and coverage
+        run: |
+          uv run pytest --cov=hyperonnx tests

hyperonnx-1.0.0/.gitignore

@@ -0,0 +1,16 @@
+.*/
+!.github/
+*.egg-info
+__pycache__
+# pdm build tool
+.pdm-python
+__pypackages__/
+# pypa
+dist/
+build/
+tests/models/
+!tests/models/.gitkeep
+!tests/models/model.list
+
+uv.lock
+.coverage

hyperonnx-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+fail_fast: false
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-json
+    -   id: check-toml
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/PyCQA/isort
+    rev: 6.0.1
+    hooks:
+    -   id: isort
+        args: ['--profile=black']
+-   repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+    -   id: codespell
+        args: [-w, -I=.github/words_bag.txt]
+        exclude: (\.(txt|diff|patch)$)
+-   repo: https://github.com/pycqa/flake8
+    rev: 7.3.0
+    hooks:
+    - id: flake8
+      additional_dependencies: [Flake8-pyproject]
+      args:
+      - '--ignore=W503,E203,E231,E241'
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.17.1
+    hooks:
+    -   id: mypy
+        args:
+        - '--ignore-missing-imports'
+        - '--exclude=tests.*\.py'

hyperonnx-1.0.0/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS

hyperonnx-1.0.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: hyperonnx
+Version: 1.0.0
+Summary: Copyright (C) 2025 The HYPERONNX Authors.
+Author-email: Wenyi Tang <wenyitang@outlook.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development
+License-File: LICENSE
+Requires-Dist: onnxifier>=2.0.0
+Requires-Dist: onnxscript
+Requires-Dist: onnx>=1.18.0
+Requires-Dist: torch
+Requires-Dist: mypy ; extra == "test"
+Requires-Dist: onnxruntime ; extra == "test"
+Requires-Dist: pre-commit ; extra == "test"
+Requires-Dist: pyright>=1.1.408 ; extra == "test"
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: pytest-cov ; extra == "test"
+Requires-Dist: torchvision ; extra == "test"
+Project-URL: Docs, https://loseall.github.io/hyperonnx
+Project-URL: Home, https://github.com/LoSealL/hyperonnx
+Provides-Extra: test
+
+# 🚀 HYPER-ONNX
+
+[中文](./README_CN.md)|[EN](./README.md)
+
+Hyper-ONNX can export pytorch models (`nn.Module`) in a hierachical manner. It can keep the module hier information and make a nested onnx graph. ✨
+
+
+## 📦 Install
+
+Simply install from pypi:
+
+```bash
+pip install hyperonnx
+```
+
+Or you may install from source:
+
+```bash
+git clone https://github.com/LoSealL/hyperonnx.git
+pip install -e hyperonnx[test]
+```
+
+## 🧪 Usage Example
+
+### 1) Export `nn.Module` with specified hier info
+
+```python
+import torch
+import torchvision as tv
+from torchvision.models.resnet import BasicBlock, Bottleneck, ResNet
+
+from hyperonnx import export_hyper_onnx
+
+model = tv.models.resnet18()
+export_hyper_onnx(
+    resnet,
+    (torch.randn(1, 3, 224, 224),),
+    "hyper-resnet18.onnx",
+    input_names=["img"],
+    output_names=["features"],
+    hiera=[ResNet, BasicBlock, Bottleneck],
+    do_optimization=False,
+    dynamo=False,
+)
+```
+
+![r18-sample](docs/assets/r18-sample.gif)
+
+### 2) Export any call to a model by auto tracing
+
+```python
+from hyperonnx import auto_trace_method
+from hyperonnx.patch import patch_transformers
+from transformers import (
+    GenerationConfig,
+    Qwen2_5OmniThinkerForConditionalGeneration,
+)
+from transformers.models.qwen2_5_omni.modeling_qwen2_5_omni import (
+    Qwen2_5_VisionPatchEmbed,
+    Qwen2_5_VisionRotaryEmbedding,
+    Qwen2_5OmniAudioEncoderLayer,
+    Qwen2_5OmniDecoderLayer,
+    Qwen2_5OmniPatchMerger,
+    Qwen2_5OmniVisionBlock,
+)
+
+thinker = Qwen2_5OmniThinkerForConditionalGeneration.from_pretrained(
+    "Qwen/Qwen2.5-Omni-3B",
+    dtype="float16",
+    device_map="cuda",
+)
+with (
+    patch_transformers(),
+    auto_trace_method(thinker.model.forward) as text_tracer,
+    auto_trace_method(thinker.visual.forward) as visual_tracer,
+    auto_trace_method(thinker.audio_tower.forward) as audio_tracer,
+):
+    try:
+        outputs = thinker.generate(
+            **inputs,  # your any input data
+            max_new_tokens=2048,
+            generation_config=GenerationConfig(use_cache=False),
+        )
+    except StopIteration:
+        pass
+    text_tracer.export(
+        "qwen-omni-2.5-3b-text.onnx",
+        input_names=["input_ids"],
+        output_names=["hidden_states"],
+        hiera=[
+            Qwen2_5OmniDecoderLayer,
+        ],
+        external_data=True,
+        external_directory="qwen25_omni/text",
+        do_optimization=True,
+    )
+    visual_tracer.export(
+        "qwen-omni-2.5-3b-vision.onnx",
+        input_names=["hidden_states"],
+        output_names=["last_hidden_state"],
+        hiera=[
+            Qwen2_5_VisionPatchEmbed,
+            Qwen2_5_VisionRotaryEmbedding,
+            Qwen2_5OmniVisionBlock,
+            Qwen2_5OmniPatchMerger,
+        ],
+        external_data=True,
+        external_directory="qwen25_omni/vision",
+        do_optimization=True,
+    )
+    audio_tracer.export(
+        "qwen-omni-2.5-3b-audio.onnx",
+        input_names=["hidden_states"],
+        output_names=["last_hidden_state"],
+        hiera=[
+            Qwen2_5OmniAudioEncoderLayer,
+        ],
+        external_data=True,
+        external_directory="qwen25_omni/audio",
+        do_optimization=True,
+    )
+```
+
+![qwen2](docs/assets/qwen2_omni_vision.gif)
+---
+
+If you run into issues or want to contribute, feel free to open an Issue or PR. 💡
+

hyperonnx-1.0.0/README.md

@@ -0,0 +1,127 @@
+# 🚀 HYPER-ONNX
+
+[中文](./README_CN.md)|[EN](./README.md)
+
+Hyper-ONNX can export pytorch models (`nn.Module`) in a hierachical manner. It can keep the module hier information and make a nested onnx graph. ✨
+
+
+## 📦 Install
+
+Simply install from pypi:
+
+```bash
+pip install hyperonnx
+```
+
+Or you may install from source:
+
+```bash
+git clone https://github.com/LoSealL/hyperonnx.git
+pip install -e hyperonnx[test]
+```
+
+## 🧪 Usage Example
+
+### 1) Export `nn.Module` with specified hier info
+
+```python
+import torch
+import torchvision as tv
+from torchvision.models.resnet import BasicBlock, Bottleneck, ResNet
+
+from hyperonnx import export_hyper_onnx
+
+model = tv.models.resnet18()
+export_hyper_onnx(
+    resnet,
+    (torch.randn(1, 3, 224, 224),),
+    "hyper-resnet18.onnx",
+    input_names=["img"],
+    output_names=["features"],
+    hiera=[ResNet, BasicBlock, Bottleneck],
+    do_optimization=False,
+    dynamo=False,
+)
+```
+
+![r18-sample](docs/assets/r18-sample.gif)
+
+### 2) Export any call to a model by auto tracing
+
+```python
+from hyperonnx import auto_trace_method
+from hyperonnx.patch import patch_transformers
+from transformers import (
+    GenerationConfig,
+    Qwen2_5OmniThinkerForConditionalGeneration,
+)
+from transformers.models.qwen2_5_omni.modeling_qwen2_5_omni import (
+    Qwen2_5_VisionPatchEmbed,
+    Qwen2_5_VisionRotaryEmbedding,
+    Qwen2_5OmniAudioEncoderLayer,
+    Qwen2_5OmniDecoderLayer,
+    Qwen2_5OmniPatchMerger,
+    Qwen2_5OmniVisionBlock,
+)
+
+thinker = Qwen2_5OmniThinkerForConditionalGeneration.from_pretrained(
+    "Qwen/Qwen2.5-Omni-3B",
+    dtype="float16",
+    device_map="cuda",
+)
+with (
+    patch_transformers(),
+    auto_trace_method(thinker.model.forward) as text_tracer,
+    auto_trace_method(thinker.visual.forward) as visual_tracer,
+    auto_trace_method(thinker.audio_tower.forward) as audio_tracer,
+):
+    try:
+        outputs = thinker.generate(
+            **inputs,  # your any input data
+            max_new_tokens=2048,
+            generation_config=GenerationConfig(use_cache=False),
+        )
+    except StopIteration:
+        pass
+    text_tracer.export(
+        "qwen-omni-2.5-3b-text.onnx",
+        input_names=["input_ids"],
+        output_names=["hidden_states"],
+        hiera=[
+            Qwen2_5OmniDecoderLayer,
+        ],
+        external_data=True,
+        external_directory="qwen25_omni/text",
+        do_optimization=True,
+    )
+    visual_tracer.export(
+        "qwen-omni-2.5-3b-vision.onnx",
+        input_names=["hidden_states"],
+        output_names=["last_hidden_state"],
+        hiera=[
+            Qwen2_5_VisionPatchEmbed,
+            Qwen2_5_VisionRotaryEmbedding,
+            Qwen2_5OmniVisionBlock,
+            Qwen2_5OmniPatchMerger,
+        ],
+        external_data=True,
+        external_directory="qwen25_omni/vision",
+        do_optimization=True,
+    )
+    audio_tracer.export(
+        "qwen-omni-2.5-3b-audio.onnx",
+        input_names=["hidden_states"],
+        output_names=["last_hidden_state"],
+        hiera=[
+            Qwen2_5OmniAudioEncoderLayer,
+        ],
+        external_data=True,
+        external_directory="qwen25_omni/audio",
+        do_optimization=True,
+    )
+```
+
+![qwen2](docs/assets/qwen2_omni_vision.gif)
+---
+
+If you run into issues or want to contribute, feel free to open an Issue or PR. 💡