comfyui-orbitquant 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,49 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: ["main"]
6
+ pull_request:
7
+
8
+ jobs:
9
+ node-pack-tests:
10
+ name: Node pack tests
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - name: Check out repository
14
+ uses: actions/checkout@v7.0.0
15
+
16
+ - name: Set up Python
17
+ uses: actions/setup-python@v6.3.0
18
+ with:
19
+ python-version: "3.12"
20
+
21
+ - name: Set up uv
22
+ uses: astral-sh/setup-uv@v8.3.0
23
+
24
+ - name: Install test environment
25
+ shell: bash
26
+ run: |
27
+ uv venv
28
+ uv pip install --python .venv/bin/python --no-deps -e .
29
+ uv pip install --python .venv/bin/python pytest ruff build twine
30
+
31
+ - name: Lint
32
+ run: uv run --no-sync ruff check .
33
+
34
+ - name: Test
35
+ run: uv run --no-sync pytest -q
36
+
37
+ - name: Build package
38
+ run: uv run --no-sync python -m build
39
+
40
+ - name: Check package metadata
41
+ run: uv run --no-sync python -m twine check dist/*
42
+
43
+ - name: Smoke test wheel
44
+ shell: bash
45
+ run: |
46
+ tmpdir="$(mktemp -d)"
47
+ uv venv "$tmpdir/.venv"
48
+ uv pip install --python "$tmpdir/.venv/bin/python" --no-deps dist/comfyui_orbitquant-0.1.0-py3-none-any.whl
49
+ "$tmpdir/.venv/bin/python" -c "import comfyui_orbitquant; print(sorted(comfyui_orbitquant.NODE_CLASS_MAPPINGS))"
@@ -0,0 +1,95 @@
1
+ name: Publish PyPI
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ inputs:
6
+ version:
7
+ description: Version to publish
8
+ required: true
9
+ default: "0.1.0"
10
+
11
+ jobs:
12
+ build:
13
+ name: Build distributions
14
+ if: github.ref == 'refs/heads/main'
15
+ runs-on: ubuntu-latest
16
+ permissions:
17
+ contents: read
18
+ steps:
19
+ - name: Check out repository
20
+ uses: actions/checkout@v7.0.0
21
+
22
+ - name: Set up Python
23
+ uses: actions/setup-python@v6.3.0
24
+ with:
25
+ python-version: "3.12"
26
+
27
+ - name: Set up uv
28
+ uses: astral-sh/setup-uv@v8.3.0
29
+
30
+ - name: Verify version
31
+ shell: bash
32
+ run: |
33
+ version="$(
34
+ python - <<'PY'
35
+ import tomllib
36
+
37
+ with open("pyproject.toml", "rb") as file:
38
+ print(tomllib.load(file)["project"]["version"])
39
+ PY
40
+ )"
41
+ test "$version" = "${{ inputs.version }}"
42
+
43
+ - name: Install test environment
44
+ shell: bash
45
+ run: |
46
+ uv venv
47
+ uv pip install --python .venv/bin/python --no-deps -e .
48
+ uv pip install --python .venv/bin/python pytest ruff build twine
49
+
50
+ - name: Lint
51
+ run: uv run --no-sync ruff check .
52
+
53
+ - name: Test
54
+ run: uv run --no-sync pytest -q
55
+
56
+ - name: Build package
57
+ run: uv run --no-sync python -m build
58
+
59
+ - name: Check package metadata
60
+ run: uv run --no-sync python -m twine check dist/*
61
+
62
+ - name: Smoke test wheel
63
+ shell: bash
64
+ run: |
65
+ tmpdir="$(mktemp -d)"
66
+ uv venv "$tmpdir/.venv"
67
+ uv pip install --python "$tmpdir/.venv/bin/python" --no-deps dist/*.whl
68
+ "$tmpdir/.venv/bin/python" -c "import comfyui_orbitquant; print(sorted(comfyui_orbitquant.NODE_CLASS_MAPPINGS))"
69
+
70
+ - name: Upload distributions
71
+ uses: actions/upload-artifact@v6.0.0
72
+ with:
73
+ name: python-distributions
74
+ path: dist/*
75
+ if-no-files-found: error
76
+
77
+ publish:
78
+ name: Publish distributions
79
+ needs: build
80
+ runs-on: ubuntu-latest
81
+ environment:
82
+ name: pypi
83
+ url: https://pypi.org/p/comfyui-orbitquant
84
+ permissions:
85
+ contents: read
86
+ id-token: write
87
+ steps:
88
+ - name: Download distributions
89
+ uses: actions/download-artifact@v7.0.0
90
+ with:
91
+ name: python-distributions
92
+ path: dist
93
+
94
+ - name: Publish package distributions to PyPI
95
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,6 @@
1
+ __pycache__/
2
+ .pytest_cache/
3
+ .ruff_cache/
4
+ .venv/
5
+ dist/
6
+ *.pyc
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted under this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 WaveCut
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,166 @@
1
+ Metadata-Version: 2.4
2
+ Name: comfyui-orbitquant
3
+ Version: 0.1.0
4
+ Summary: ComfyUI custom nodes for OrbitQuant artifacts
5
+ Author: WaveCut
6
+ License-Expression: Apache-2.0
7
+ License-File: LICENSE
8
+ Requires-Python: >=3.11
9
+ Requires-Dist: orbitquant>=0.1.2
10
+ Provides-Extra: dev
11
+ Requires-Dist: pytest>=8.4; extra == 'dev'
12
+ Requires-Dist: ruff>=0.12; extra == 'dev'
13
+ Description-Content-Type: text/markdown
14
+
15
+ # ComfyUI-OrbitQuant
16
+
17
+ ComfyUI custom nodes for inspecting OrbitQuant artifacts and attaching a
18
+ quantized transformer component to an existing pipeline object.
19
+
20
+ The quantization implementation lives in the `orbitquant` Python package. This
21
+ node pack only validates artifacts, reports metadata, and calls OrbitQuant's
22
+ component-loading API.
23
+
24
+ ## Nodes
25
+
26
+ | Node | Purpose |
27
+ | --- | --- |
28
+ | `OrbitQuant Inspect Artifact` | Validate an OrbitQuant artifact directory and return a text summary plus structured metadata. |
29
+ | `OrbitQuant Pipeline Component Loader` | Attach an OrbitQuant component artifact to a pipeline attribute such as `transformer`. |
30
+ | `OrbitQuant FLUX Loader` | Attach a FLUX or FLUX.2 transformer artifact and reject non-FLUX policies. |
31
+ | `OrbitQuant Z-Image Loader` | Attach a Z-Image transformer artifact and reject other target policies. |
32
+ | `OrbitQuant Wan Loader` | Attach a Wan transformer artifact and reject other target policies. |
33
+
34
+ The same nodes are exposed through the legacy `NODE_CLASS_MAPPINGS` interface
35
+ and the modern ComfyUI V3 `comfy_entrypoint` interface when `comfy_api` is
36
+ available.
37
+
38
+ ## Install
39
+
40
+ Clone this repository into ComfyUI's custom node directory:
41
+
42
+ ```bash
43
+ cd ComfyUI/custom_nodes
44
+ git clone https://github.com/iamwavecut/ComfyUI-OrbitQuant.git
45
+ ```
46
+
47
+ Install the `orbitquant` package into the Python environment used by ComfyUI.
48
+ Use the released package when available:
49
+
50
+ ```bash
51
+ python -m pip install "orbitquant>=0.1.2"
52
+ ```
53
+
54
+ For the default optimized `runtime_mode="auto_fused"` path on CUDA or for
55
+ Hub-published native packed matmul kernels, install OrbitQuant with its kernel
56
+ runtime extra:
57
+
58
+ ```bash
59
+ python -m pip install "orbitquant[kernels]>=0.1.2"
60
+ ```
61
+
62
+ For a source checkout, install the package from the local OrbitQuant repository:
63
+
64
+ ```bash
65
+ python -m pip install -e /path/to/OrbitQuant
66
+ ```
67
+
68
+ For a source checkout with the kernel runtime dependencies:
69
+
70
+ ```bash
71
+ python -m pip install -e "/path/to/OrbitQuant[kernels]"
72
+ ```
73
+
74
+ Restart ComfyUI after installation.
75
+
76
+ ## Usage
77
+
78
+ Use an OrbitQuant artifact directory produced by the OrbitQuant package or
79
+ downloaded from Hugging Face.
80
+
81
+ 1. Load or create the source Diffusers pipeline in your workflow.
82
+ 2. Add the matching OrbitQuant loader node.
83
+ 3. Set `artifact_path` to the local artifact directory.
84
+ 4. Connect the pipeline object into the loader node.
85
+ 5. Keep `runtime_mode` at `auto_fused` for optimized packed-weight inference.
86
+ 6. Use the returned pipeline object for the downstream generation nodes.
87
+
88
+ For model-specific loaders, the artifact `target_policy` is checked before the
89
+ component is attached:
90
+
91
+ | Loader | Accepted `target_policy` |
92
+ | --- | --- |
93
+ | `OrbitQuant FLUX Loader` | `flux`, `flux2` |
94
+ | `OrbitQuant Z-Image Loader` | `z_image` |
95
+ | `OrbitQuant Wan Loader` | `wan` |
96
+
97
+ ### Runtime Modes
98
+
99
+ `runtime_mode` defaults to `auto_fused`. On supported devices, OrbitQuant will
100
+ use packed low-bit matmul kernels instead of materializing a full BF16/FP16
101
+ weight matrix. `activation_kernel_backend` defaults to `auto`.
102
+
103
+ Use `runtime_mode="dequant_bf16"` only as an explicit compatibility or debug
104
+ path when packed kernels are not installed in the ComfyUI Python environment.
105
+
106
+ ## Artifact Requirements
107
+
108
+ The loader expects the standard OrbitQuant component artifact layout:
109
+
110
+ ```text
111
+ artifact/
112
+ README.md
113
+ SHA256SUMS
114
+ model_index.json
115
+ model.safetensors
116
+ quantization_config.json
117
+ orbitquant_manifest.json
118
+ orbitquant_codebooks.safetensors
119
+ orbitquant_rotations.safetensors
120
+ prompts.json
121
+ benchmark/summary.json
122
+ ```
123
+
124
+ `OrbitQuant Inspect Artifact` validates required files, checksums, tensor
125
+ shapes, source model metadata, bit settings, runtime mode, target policy, and
126
+ module counts.
127
+
128
+ ## Python API
129
+
130
+ The node classes can also be called directly from Python when building a custom
131
+ ComfyUI workflow wrapper.
132
+
133
+ Inspect an artifact:
134
+
135
+ ```python
136
+ from comfyui_orbitquant.nodes import OrbitQuantArtifactInspector
137
+
138
+ summary, info = OrbitQuantArtifactInspector().inspect(
139
+ "/models/orbitquant/flux1-schnell-w4a4"
140
+ )
141
+ print(summary)
142
+ print(info["target_policy"])
143
+ ```
144
+
145
+ Attach a FLUX-family transformer artifact to an existing pipeline object:
146
+
147
+ ```python
148
+ from comfyui_orbitquant.nodes import OrbitQuantFluxLoader
149
+
150
+ pipeline, info = OrbitQuantFluxLoader().load(
151
+ pipeline,
152
+ "/models/orbitquant/flux1-schnell-w4a4",
153
+ strict=True,
154
+ runtime_mode="auto_fused",
155
+ activation_kernel_backend="auto",
156
+ )
157
+ ```
158
+
159
+ The nodes delegate artifact parsing and component loading to OrbitQuant:
160
+
161
+ ```python
162
+ from orbitquant.artifacts import OrbitQuantManifest, validate_orbitquant_artifact
163
+ from orbitquant.pipeline import load_quantized_pipeline_component
164
+ ```
165
+
166
+ No quantization math or artifact parsing logic is duplicated in this repository.
@@ -0,0 +1,152 @@
1
+ # ComfyUI-OrbitQuant
2
+
3
+ ComfyUI custom nodes for inspecting OrbitQuant artifacts and attaching a
4
+ quantized transformer component to an existing pipeline object.
5
+
6
+ The quantization implementation lives in the `orbitquant` Python package. This
7
+ node pack only validates artifacts, reports metadata, and calls OrbitQuant's
8
+ component-loading API.
9
+
10
+ ## Nodes
11
+
12
+ | Node | Purpose |
13
+ | --- | --- |
14
+ | `OrbitQuant Inspect Artifact` | Validate an OrbitQuant artifact directory and return a text summary plus structured metadata. |
15
+ | `OrbitQuant Pipeline Component Loader` | Attach an OrbitQuant component artifact to a pipeline attribute such as `transformer`. |
16
+ | `OrbitQuant FLUX Loader` | Attach a FLUX or FLUX.2 transformer artifact and reject non-FLUX policies. |
17
+ | `OrbitQuant Z-Image Loader` | Attach a Z-Image transformer artifact and reject other target policies. |
18
+ | `OrbitQuant Wan Loader` | Attach a Wan transformer artifact and reject other target policies. |
19
+
20
+ The same nodes are exposed through the legacy `NODE_CLASS_MAPPINGS` interface
21
+ and the modern ComfyUI V3 `comfy_entrypoint` interface when `comfy_api` is
22
+ available.
23
+
24
+ ## Install
25
+
26
+ Clone this repository into ComfyUI's custom node directory:
27
+
28
+ ```bash
29
+ cd ComfyUI/custom_nodes
30
+ git clone https://github.com/iamwavecut/ComfyUI-OrbitQuant.git
31
+ ```
32
+
33
+ Install the `orbitquant` package into the Python environment used by ComfyUI.
34
+ Use the released package when available:
35
+
36
+ ```bash
37
+ python -m pip install "orbitquant>=0.1.2"
38
+ ```
39
+
40
+ For the default optimized `runtime_mode="auto_fused"` path on CUDA or for
41
+ Hub-published native packed matmul kernels, install OrbitQuant with its kernel
42
+ runtime extra:
43
+
44
+ ```bash
45
+ python -m pip install "orbitquant[kernels]>=0.1.2"
46
+ ```
47
+
48
+ For a source checkout, install the package from the local OrbitQuant repository:
49
+
50
+ ```bash
51
+ python -m pip install -e /path/to/OrbitQuant
52
+ ```
53
+
54
+ For a source checkout with the kernel runtime dependencies:
55
+
56
+ ```bash
57
+ python -m pip install -e "/path/to/OrbitQuant[kernels]"
58
+ ```
59
+
60
+ Restart ComfyUI after installation.
61
+
62
+ ## Usage
63
+
64
+ Use an OrbitQuant artifact directory produced by the OrbitQuant package or
65
+ downloaded from Hugging Face.
66
+
67
+ 1. Load or create the source Diffusers pipeline in your workflow.
68
+ 2. Add the matching OrbitQuant loader node.
69
+ 3. Set `artifact_path` to the local artifact directory.
70
+ 4. Connect the pipeline object into the loader node.
71
+ 5. Keep `runtime_mode` at `auto_fused` for optimized packed-weight inference.
72
+ 6. Use the returned pipeline object for the downstream generation nodes.
73
+
74
+ For model-specific loaders, the artifact `target_policy` is checked before the
75
+ component is attached:
76
+
77
+ | Loader | Accepted `target_policy` |
78
+ | --- | --- |
79
+ | `OrbitQuant FLUX Loader` | `flux`, `flux2` |
80
+ | `OrbitQuant Z-Image Loader` | `z_image` |
81
+ | `OrbitQuant Wan Loader` | `wan` |
82
+
83
+ ### Runtime Modes
84
+
85
+ `runtime_mode` defaults to `auto_fused`. On supported devices, OrbitQuant will
86
+ use packed low-bit matmul kernels instead of materializing a full BF16/FP16
87
+ weight matrix. `activation_kernel_backend` defaults to `auto`.
88
+
89
+ Use `runtime_mode="dequant_bf16"` only as an explicit compatibility or debug
90
+ path when packed kernels are not installed in the ComfyUI Python environment.
91
+
92
+ ## Artifact Requirements
93
+
94
+ The loader expects the standard OrbitQuant component artifact layout:
95
+
96
+ ```text
97
+ artifact/
98
+ README.md
99
+ SHA256SUMS
100
+ model_index.json
101
+ model.safetensors
102
+ quantization_config.json
103
+ orbitquant_manifest.json
104
+ orbitquant_codebooks.safetensors
105
+ orbitquant_rotations.safetensors
106
+ prompts.json
107
+ benchmark/summary.json
108
+ ```
109
+
110
+ `OrbitQuant Inspect Artifact` validates required files, checksums, tensor
111
+ shapes, source model metadata, bit settings, runtime mode, target policy, and
112
+ module counts.
113
+
114
+ ## Python API
115
+
116
+ The node classes can also be called directly from Python when building a custom
117
+ ComfyUI workflow wrapper.
118
+
119
+ Inspect an artifact:
120
+
121
+ ```python
122
+ from comfyui_orbitquant.nodes import OrbitQuantArtifactInspector
123
+
124
+ summary, info = OrbitQuantArtifactInspector().inspect(
125
+ "/models/orbitquant/flux1-schnell-w4a4"
126
+ )
127
+ print(summary)
128
+ print(info["target_policy"])
129
+ ```
130
+
131
+ Attach a FLUX-family transformer artifact to an existing pipeline object:
132
+
133
+ ```python
134
+ from comfyui_orbitquant.nodes import OrbitQuantFluxLoader
135
+
136
+ pipeline, info = OrbitQuantFluxLoader().load(
137
+ pipeline,
138
+ "/models/orbitquant/flux1-schnell-w4a4",
139
+ strict=True,
140
+ runtime_mode="auto_fused",
141
+ activation_kernel_backend="auto",
142
+ )
143
+ ```
144
+
145
+ The nodes delegate artifact parsing and component loading to OrbitQuant:
146
+
147
+ ```python
148
+ from orbitquant.artifacts import OrbitQuantManifest, validate_orbitquant_artifact
149
+ from orbitquant.pipeline import load_quantized_pipeline_component
150
+ ```
151
+
152
+ No quantization math or artifact parsing logic is duplicated in this repository.
@@ -0,0 +1,14 @@
1
+ import sys
2
+ from pathlib import Path
3
+
4
+ src_path = Path(__file__).resolve().parent / "src"
5
+ if str(src_path) not in sys.path:
6
+ sys.path.insert(0, str(src_path))
7
+
8
+ from comfyui_orbitquant import ( # noqa: E402
9
+ NODE_CLASS_MAPPINGS,
10
+ NODE_DISPLAY_NAME_MAPPINGS,
11
+ comfy_entrypoint,
12
+ )
13
+
14
+ __all__ = ["NODE_CLASS_MAPPINGS", "NODE_DISPLAY_NAME_MAPPINGS", "comfy_entrypoint"]