cid-engine 0.4.2__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.
- cid_engine-0.4.2/LICENSE +202 -0
- cid_engine-0.4.2/MANIFEST.in +4 -0
- cid_engine-0.4.2/PKG-INFO +175 -0
- cid_engine-0.4.2/README.md +143 -0
- cid_engine-0.4.2/csrc/bindings.cpp +10 -0
- cid_engine-0.4.2/csrc/cuda/display_stats.cu +168 -0
- cid_engine-0.4.2/csrc/cuda/materialize_snapshot.cu +192 -0
- cid_engine-0.4.2/csrc/cuda/prefix_allocation.cu +140 -0
- cid_engine-0.4.2/csrc/include/cid_engine/ops.hpp +52 -0
- cid_engine-0.4.2/csrc/ops.cpp +186 -0
- cid_engine-0.4.2/csrc/refine.cpp +431 -0
- cid_engine-0.4.2/csrc/registration.cpp +44 -0
- cid_engine-0.4.2/pyproject.toml +62 -0
- cid_engine-0.4.2/setup.cfg +4 -0
- cid_engine-0.4.2/setup.py +48 -0
- cid_engine-0.4.2/src/cid_engine/__init__.py +114 -0
- cid_engine-0.4.2/src/cid_engine/benchmark.py +87 -0
- cid_engine-0.4.2/src/cid_engine/reference.py +353 -0
- cid_engine-0.4.2/src/cid_engine.egg-info/PKG-INFO +175 -0
- cid_engine-0.4.2/src/cid_engine.egg-info/SOURCES.txt +27 -0
- cid_engine-0.4.2/src/cid_engine.egg-info/dependency_links.txt +1 -0
- cid_engine-0.4.2/src/cid_engine.egg-info/entry_points.txt +2 -0
- cid_engine-0.4.2/src/cid_engine.egg-info/requires.txt +10 -0
- cid_engine-0.4.2/src/cid_engine.egg-info/top_level.txt +1 -0
- cid_engine-0.4.2/tests/test_compile.py +20 -0
- cid_engine-0.4.2/tests/test_cuda.py +210 -0
- cid_engine-0.4.2/tests/test_engine.py +274 -0
- cid_engine-0.4.2/tests/test_fuzz.py +351 -0
- cid_engine-0.4.2/tests/test_precision.py +216 -0
cid_engine-0.4.2/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: cid-engine
|
|
3
|
+
Version: 0.4.2
|
|
4
|
+
Summary: C++20 execution engine for Continuous Interaction Diffusion
|
|
5
|
+
Author: fwerkor
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/fwerkor/cid-engine
|
|
8
|
+
Project-URL: Repository, https://github.com/fwerkor/cid-engine
|
|
9
|
+
Project-URL: Issues, https://github.com/fwerkor/cid-engine/issues
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Intended Audience :: Science/Research
|
|
12
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
13
|
+
Classifier: Programming Language :: C++
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: torch>=2.4
|
|
24
|
+
Provides-Extra: dev
|
|
25
|
+
Requires-Dist: hypothesis>=6.112; extra == "dev"
|
|
26
|
+
Requires-Dist: pytest>=8; extra == "dev"
|
|
27
|
+
Requires-Dist: ruff>=0.8; extra == "dev"
|
|
28
|
+
Provides-Extra: release
|
|
29
|
+
Requires-Dist: build>=1.2; extra == "release"
|
|
30
|
+
Requires-Dist: twine>=6; extra == "release"
|
|
31
|
+
Dynamic: license-file
|
|
32
|
+
|
|
33
|
+
# cid-engine
|
|
34
|
+
|
|
35
|
+
cid-engine is the native execution engine for Continuous Interaction Diffusion (CID).
|
|
36
|
+
|
|
37
|
+
The engine core is written in C++20. Python is a thin integration surface for the current CID
|
|
38
|
+
model and for semantic-reference tests; it is not the execution core.
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
PyPI releases can be installed with:
|
|
43
|
+
|
|
44
|
+
pip install cid-engine
|
|
45
|
+
|
|
46
|
+
The current PyPI distribution is source-based so that installation can select the correct native
|
|
47
|
+
backend for the target machine. A C++20 compiler is required. If the installed PyTorch build has
|
|
48
|
+
CUDA support and `CUDA_HOME` points to a CUDA toolkit, the CUDA backend is built automatically;
|
|
49
|
+
otherwise cid-engine builds its CPU backend.
|
|
50
|
+
|
|
51
|
+
For an environment that already pins a particular PyTorch build, install against that exact local
|
|
52
|
+
PyTorch ABI with:
|
|
53
|
+
|
|
54
|
+
pip install cid-engine --no-build-isolation
|
|
55
|
+
|
|
56
|
+
## Architecture
|
|
57
|
+
|
|
58
|
+
CID Python/model frontend
|
|
59
|
+
|
|
|
60
|
+
v
|
|
61
|
+
thin Python API
|
|
62
|
+
|
|
|
63
|
+
v
|
|
64
|
+
+-----------------------+
|
|
65
|
+
| cid-engine C++20 core |
|
|
66
|
+
| ATen custom operators |
|
|
67
|
+
+-----------------------+
|
|
68
|
+
|
|
|
69
|
+
+---- CPU
|
|
70
|
+
+---- CUDA (display, allocation, and materialization kernels)
|
|
71
|
+
+---- Ascend (planned)
|
|
72
|
+
|
|
73
|
+
The current C++ core owns CID-specific tensor primitives and the post-statistics display refinement policy:
|
|
74
|
+
|
|
75
|
+
- live thought-slot occupancy with retired-slot masking;
|
|
76
|
+
- deterministic first-free prefix allocation;
|
|
77
|
+
- thought diffusion corruption from a supplied epsilon tensor;
|
|
78
|
+
- display-token confidence/prediction statistics;
|
|
79
|
+
- C++ reveal/revision/EOS/structural-edit policy from those statistics;
|
|
80
|
+
- compact materialization snapshots for one-transfer TCT control-state decoding.
|
|
81
|
+
|
|
82
|
+
They are registered as torch.ops.cid_engine C++ operators, so tensors cross the Python/C++
|
|
83
|
+
boundary without NumPy copies. The pure-Python implementation remains only as a semantic oracle.
|
|
84
|
+
|
|
85
|
+
## Semantic contract
|
|
86
|
+
|
|
87
|
+
The default engine may change floating-point reduction order, but it must not change CID
|
|
88
|
+
algorithmic decisions or runtime policy.
|
|
89
|
+
|
|
90
|
+
Tests require exact equality for boolean masks, allocation decisions, token IDs, and argmax
|
|
91
|
+
results, plus numerically close floating-point outputs for mathematically equivalent reductions.
|
|
92
|
+
|
|
93
|
+
Hot-path native operators assume token IDs already satisfy the model vocabulary contract; CID validates
|
|
94
|
+
that invariant when constructing the display tensor, avoiding a device-to-host synchronization per step.
|
|
95
|
+
|
|
96
|
+
Quantization, skipped diffusion steps, approximate attention, speculative execution, or new
|
|
97
|
+
early-exit policies are outside this contract.
|
|
98
|
+
|
|
99
|
+
## Build
|
|
100
|
+
|
|
101
|
+
A C++20 compiler and PyTorch/LibTorch are required.
|
|
102
|
+
|
|
103
|
+
pip install torch
|
|
104
|
+
pip install -e '.[dev]' --no-build-isolation
|
|
105
|
+
pytest
|
|
106
|
+
ruff check .
|
|
107
|
+
|
|
108
|
+
The core can also be built and tested without the Python API:
|
|
109
|
+
|
|
110
|
+
cmake -S . -B build -DCMAKE_PREFIX_PATH="$(python -c 'import torch; print(torch.utils.cmake_prefix_path)')"
|
|
111
|
+
cmake --build build
|
|
112
|
+
ctest --test-dir build --output-on-failure
|
|
113
|
+
|
|
114
|
+
## Verification
|
|
115
|
+
|
|
116
|
+
`cid-engine` treats semantic and numerical equivalence as release requirements. The test stack has
|
|
117
|
+
three complementary layers:
|
|
118
|
+
|
|
119
|
+
- property-based differential fuzzing compares native operators with independent Python semantic
|
|
120
|
+
oracles across randomized shapes, dtypes, strides, thresholds, EOS layouts, and structural edits;
|
|
121
|
+
- precision tests compare floating-point kernels with float64 oracles on adversarial logits,
|
|
122
|
+
near-ties, large offsets, diffusion boundary timesteps, and vocabulary sizes up to 65,537;
|
|
123
|
+
- a Clang libFuzzer target drives the C++ core directly under AddressSanitizer and
|
|
124
|
+
UndefinedBehaviorSanitizer.
|
|
125
|
+
|
|
126
|
+
The normal test suite uses a bounded fuzz budget. A scheduled stress workflow raises the Hypothesis
|
|
127
|
+
budget substantially and runs the coverage-guided native fuzzer. The same native target can be run
|
|
128
|
+
locally with Clang:
|
|
129
|
+
|
|
130
|
+
CXX=clang++ cmake -S . -B build-fuzz \
|
|
131
|
+
-DCID_ENGINE_BUILD_TESTS=OFF -DCID_ENGINE_BUILD_FUZZERS=ON \
|
|
132
|
+
-DCMAKE_PREFIX_PATH="$(python -c 'import torch; print(torch.utils.cmake_prefix_path)')"
|
|
133
|
+
cmake --build build-fuzz --parallel 2
|
|
134
|
+
cp -a tests/fuzz/corpus /tmp/cid-engine-fuzz-corpus
|
|
135
|
+
OMP_NUM_THREADS=1 MKL_NUM_THREADS=1 ASAN_OPTIONS=detect_leaks=0 \
|
|
136
|
+
./build-fuzz/cid_engine_fuzz /tmp/cid-engine-fuzz-corpus -max_total_time=60
|
|
137
|
+
|
|
138
|
+
## Use
|
|
139
|
+
|
|
140
|
+
import torch
|
|
141
|
+
import cid_engine
|
|
142
|
+
|
|
143
|
+
token_ids = torch.randint(0, 32000, (1, 128), device="cuda")
|
|
144
|
+
logits = torch.randn(1, 128, 32000, device="cuda", dtype=torch.bfloat16)
|
|
145
|
+
|
|
146
|
+
confidence, predicted, current_confidence = cid_engine.display_token_statistics(
|
|
147
|
+
token_ids,
|
|
148
|
+
logits,
|
|
149
|
+
)
|
|
150
|
+
|
|
151
|
+
The underlying operator is also available directly through
|
|
152
|
+
torch.ops.cid_engine.display_token_statistics. The Python reference module is retained only for semantic tests and benchmarks.
|
|
153
|
+
|
|
154
|
+
## Benchmark
|
|
155
|
+
|
|
156
|
+
cid-engine-bench --device cuda --batch 1 --tokens 128 --vocab 65536
|
|
157
|
+
|
|
158
|
+
The benchmark verifies C++/reference equivalence before reporting timing.
|
|
159
|
+
|
|
160
|
+
Moving Python tensor expressions into C++ does not by itself guarantee a speedup. If C++ launches
|
|
161
|
+
the same sequence of ATen kernels, device work is essentially unchanged. Establishing the native
|
|
162
|
+
core first gives CID a stable place for fused CUDA, CPU, and Ascend implementations and for future
|
|
163
|
+
scheduler and memory-planner logic.
|
|
164
|
+
|
|
165
|
+
## Roadmap
|
|
166
|
+
|
|
167
|
+
1. Keep model-visible TCT numeric state device-resident across CID steps.
|
|
168
|
+
2. Move the remaining materialization/control-state transitions into native state.
|
|
169
|
+
3. Expand fused CUDA coverage only where profiling shows a material gain.
|
|
170
|
+
4. Add CID-aware buffer lifetime and stream scheduling.
|
|
171
|
+
5. Overlap model/device work with asynchronous tool/source execution.
|
|
172
|
+
6. Add the Ascend backend behind the same C++ engine interface.
|
|
173
|
+
7. Keep PyTorch as the training/reference frontend until replacing a layer has measured value.
|
|
174
|
+
|
|
175
|
+
Apache-2.0, matching the main CID repository.
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# cid-engine
|
|
2
|
+
|
|
3
|
+
cid-engine is the native execution engine for Continuous Interaction Diffusion (CID).
|
|
4
|
+
|
|
5
|
+
The engine core is written in C++20. Python is a thin integration surface for the current CID
|
|
6
|
+
model and for semantic-reference tests; it is not the execution core.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
PyPI releases can be installed with:
|
|
11
|
+
|
|
12
|
+
pip install cid-engine
|
|
13
|
+
|
|
14
|
+
The current PyPI distribution is source-based so that installation can select the correct native
|
|
15
|
+
backend for the target machine. A C++20 compiler is required. If the installed PyTorch build has
|
|
16
|
+
CUDA support and `CUDA_HOME` points to a CUDA toolkit, the CUDA backend is built automatically;
|
|
17
|
+
otherwise cid-engine builds its CPU backend.
|
|
18
|
+
|
|
19
|
+
For an environment that already pins a particular PyTorch build, install against that exact local
|
|
20
|
+
PyTorch ABI with:
|
|
21
|
+
|
|
22
|
+
pip install cid-engine --no-build-isolation
|
|
23
|
+
|
|
24
|
+
## Architecture
|
|
25
|
+
|
|
26
|
+
CID Python/model frontend
|
|
27
|
+
|
|
|
28
|
+
v
|
|
29
|
+
thin Python API
|
|
30
|
+
|
|
|
31
|
+
v
|
|
32
|
+
+-----------------------+
|
|
33
|
+
| cid-engine C++20 core |
|
|
34
|
+
| ATen custom operators |
|
|
35
|
+
+-----------------------+
|
|
36
|
+
|
|
|
37
|
+
+---- CPU
|
|
38
|
+
+---- CUDA (display, allocation, and materialization kernels)
|
|
39
|
+
+---- Ascend (planned)
|
|
40
|
+
|
|
41
|
+
The current C++ core owns CID-specific tensor primitives and the post-statistics display refinement policy:
|
|
42
|
+
|
|
43
|
+
- live thought-slot occupancy with retired-slot masking;
|
|
44
|
+
- deterministic first-free prefix allocation;
|
|
45
|
+
- thought diffusion corruption from a supplied epsilon tensor;
|
|
46
|
+
- display-token confidence/prediction statistics;
|
|
47
|
+
- C++ reveal/revision/EOS/structural-edit policy from those statistics;
|
|
48
|
+
- compact materialization snapshots for one-transfer TCT control-state decoding.
|
|
49
|
+
|
|
50
|
+
They are registered as torch.ops.cid_engine C++ operators, so tensors cross the Python/C++
|
|
51
|
+
boundary without NumPy copies. The pure-Python implementation remains only as a semantic oracle.
|
|
52
|
+
|
|
53
|
+
## Semantic contract
|
|
54
|
+
|
|
55
|
+
The default engine may change floating-point reduction order, but it must not change CID
|
|
56
|
+
algorithmic decisions or runtime policy.
|
|
57
|
+
|
|
58
|
+
Tests require exact equality for boolean masks, allocation decisions, token IDs, and argmax
|
|
59
|
+
results, plus numerically close floating-point outputs for mathematically equivalent reductions.
|
|
60
|
+
|
|
61
|
+
Hot-path native operators assume token IDs already satisfy the model vocabulary contract; CID validates
|
|
62
|
+
that invariant when constructing the display tensor, avoiding a device-to-host synchronization per step.
|
|
63
|
+
|
|
64
|
+
Quantization, skipped diffusion steps, approximate attention, speculative execution, or new
|
|
65
|
+
early-exit policies are outside this contract.
|
|
66
|
+
|
|
67
|
+
## Build
|
|
68
|
+
|
|
69
|
+
A C++20 compiler and PyTorch/LibTorch are required.
|
|
70
|
+
|
|
71
|
+
pip install torch
|
|
72
|
+
pip install -e '.[dev]' --no-build-isolation
|
|
73
|
+
pytest
|
|
74
|
+
ruff check .
|
|
75
|
+
|
|
76
|
+
The core can also be built and tested without the Python API:
|
|
77
|
+
|
|
78
|
+
cmake -S . -B build -DCMAKE_PREFIX_PATH="$(python -c 'import torch; print(torch.utils.cmake_prefix_path)')"
|
|
79
|
+
cmake --build build
|
|
80
|
+
ctest --test-dir build --output-on-failure
|
|
81
|
+
|
|
82
|
+
## Verification
|
|
83
|
+
|
|
84
|
+
`cid-engine` treats semantic and numerical equivalence as release requirements. The test stack has
|
|
85
|
+
three complementary layers:
|
|
86
|
+
|
|
87
|
+
- property-based differential fuzzing compares native operators with independent Python semantic
|
|
88
|
+
oracles across randomized shapes, dtypes, strides, thresholds, EOS layouts, and structural edits;
|
|
89
|
+
- precision tests compare floating-point kernels with float64 oracles on adversarial logits,
|
|
90
|
+
near-ties, large offsets, diffusion boundary timesteps, and vocabulary sizes up to 65,537;
|
|
91
|
+
- a Clang libFuzzer target drives the C++ core directly under AddressSanitizer and
|
|
92
|
+
UndefinedBehaviorSanitizer.
|
|
93
|
+
|
|
94
|
+
The normal test suite uses a bounded fuzz budget. A scheduled stress workflow raises the Hypothesis
|
|
95
|
+
budget substantially and runs the coverage-guided native fuzzer. The same native target can be run
|
|
96
|
+
locally with Clang:
|
|
97
|
+
|
|
98
|
+
CXX=clang++ cmake -S . -B build-fuzz \
|
|
99
|
+
-DCID_ENGINE_BUILD_TESTS=OFF -DCID_ENGINE_BUILD_FUZZERS=ON \
|
|
100
|
+
-DCMAKE_PREFIX_PATH="$(python -c 'import torch; print(torch.utils.cmake_prefix_path)')"
|
|
101
|
+
cmake --build build-fuzz --parallel 2
|
|
102
|
+
cp -a tests/fuzz/corpus /tmp/cid-engine-fuzz-corpus
|
|
103
|
+
OMP_NUM_THREADS=1 MKL_NUM_THREADS=1 ASAN_OPTIONS=detect_leaks=0 \
|
|
104
|
+
./build-fuzz/cid_engine_fuzz /tmp/cid-engine-fuzz-corpus -max_total_time=60
|
|
105
|
+
|
|
106
|
+
## Use
|
|
107
|
+
|
|
108
|
+
import torch
|
|
109
|
+
import cid_engine
|
|
110
|
+
|
|
111
|
+
token_ids = torch.randint(0, 32000, (1, 128), device="cuda")
|
|
112
|
+
logits = torch.randn(1, 128, 32000, device="cuda", dtype=torch.bfloat16)
|
|
113
|
+
|
|
114
|
+
confidence, predicted, current_confidence = cid_engine.display_token_statistics(
|
|
115
|
+
token_ids,
|
|
116
|
+
logits,
|
|
117
|
+
)
|
|
118
|
+
|
|
119
|
+
The underlying operator is also available directly through
|
|
120
|
+
torch.ops.cid_engine.display_token_statistics. The Python reference module is retained only for semantic tests and benchmarks.
|
|
121
|
+
|
|
122
|
+
## Benchmark
|
|
123
|
+
|
|
124
|
+
cid-engine-bench --device cuda --batch 1 --tokens 128 --vocab 65536
|
|
125
|
+
|
|
126
|
+
The benchmark verifies C++/reference equivalence before reporting timing.
|
|
127
|
+
|
|
128
|
+
Moving Python tensor expressions into C++ does not by itself guarantee a speedup. If C++ launches
|
|
129
|
+
the same sequence of ATen kernels, device work is essentially unchanged. Establishing the native
|
|
130
|
+
core first gives CID a stable place for fused CUDA, CPU, and Ascend implementations and for future
|
|
131
|
+
scheduler and memory-planner logic.
|
|
132
|
+
|
|
133
|
+
## Roadmap
|
|
134
|
+
|
|
135
|
+
1. Keep model-visible TCT numeric state device-resident across CID steps.
|
|
136
|
+
2. Move the remaining materialization/control-state transitions into native state.
|
|
137
|
+
3. Expand fused CUDA coverage only where profiling shows a material gain.
|
|
138
|
+
4. Add CID-aware buffer lifetime and stream scheduling.
|
|
139
|
+
5. Overlap model/device work with asynchronous tool/source execution.
|
|
140
|
+
6. Add the Ascend backend behind the same C++ engine interface.
|
|
141
|
+
7. Keep PyTorch as the training/reference frontend until replacing a layer has measured value.
|
|
142
|
+
|
|
143
|
+
Apache-2.0, matching the main CID repository.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
#include <pybind11/pybind11.h>
|
|
2
|
+
|
|
3
|
+
PYBIND11_MODULE(TORCH_EXTENSION_NAME, m) {
|
|
4
|
+
m.doc() = "Native C++20 core for cid-engine";
|
|
5
|
+
#ifdef CID_ENGINE_WITH_CUDA
|
|
6
|
+
m.attr("cuda_backend_built") = pybind11::bool_(true);
|
|
7
|
+
#else
|
|
8
|
+
m.attr("cuda_backend_built") = pybind11::bool_(false);
|
|
9
|
+
#endif
|
|
10
|
+
}
|