tridec 0.1.0__tar.gz

tridec-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tridec-0.1.0/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: tridec
+Version: 0.1.0
+Summary: Vendor-portable GPU decoders for quantum LDPC codes: Triton min-sum BP and Relay-BP on NVIDIA (CUDA) and AMD (ROCm), with CPU reference implementations, consuming any stim DetectorErrorModel or raw parity-check matrices.
+Author: Blake Ledden
+License: Apache-2.0
+Project-URL: Repository, https://github.com/bledden/tridec
+Project-URL: Documentation, https://github.com/bledden/tridec/blob/master/docs/benchmark.md
+Project-URL: Issues, https://github.com/bledden/tridec/issues
+Keywords: quantum error correction,qLDPC,decoder,belief propagation,triton,stim,GPU
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: scipy>=1.10
+Requires-Dist: stim>=1.13
+Provides-Extra: torch
+Requires-Dist: torch>=2.4; extra == "torch"
+Provides-Extra: gpu
+Requires-Dist: torch>=2.4; extra == "gpu"
+Requires-Dist: triton>=3.0; extra == "gpu"
+Provides-Extra: decoders
+Requires-Dist: ldpc>=2.4.1; extra == "decoders"
+Requires-Dist: relay-bp[stim]>=0.2.2; extra == "decoders"
+Provides-Extra: sinter
+Requires-Dist: sinter>=1.15; extra == "sinter"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: sinter>=1.15; extra == "dev"
+Requires-Dist: pymatching>=2.1; extra == "dev"
+Dynamic: license-file
+
+# tridec
+
+[![ci](https://github.com/bledden/tridec/actions/workflows/ci.yml/badge.svg)](https://github.com/bledden/tridec/actions/workflows/ci.yml)
+
+*Badge honesty: CI is CPU-only (ubuntu + macos arm64; the macos lane binds the
+strict exact-count receipt gates). There are no GPU runners — the CUDA/ROCm
+kernel paths are validated by the carried H200/MI300X receipts in
+`bench/receipts/`, and the experimental Metal tier runs on a local machine.*
+
+An open, vendor-portable GPU decoder library for quantum LDPC codes — Triton
+min-sum BP and Relay-BP decoders that consume any stim `DetectorErrorModel` or
+raw parity-check matrices, with CPU reference implementations, validated
+against the standard CPU references (`ldpc`, `relay-bp`), running on NVIDIA
+(CUDA) and AMD (ROCm) GPUs.
+
+The same Triton kernels run unmodified on both vendors: the Relay-BP kernel
+reproduces its logical-error-rate validation numbers identically on an NVIDIA
+H200 (CUDA 12.4, triton 3.0) and an AMD MI300X (ROCm 7.0, triton 3.4) — see
+[docs/benchmark.md](docs/benchmark.md) and the raw receipts in
+`bench/receipts/`. Validated scope is NVIDIA + AMD; Apple silicon runs the
+same kernels through [triton-metal](https://github.com/bledden/triton-metal)
+as an **experimental** backend (see below).
+
+## Install
+
+Most users want `pip install "tridec[torch,decoders]"` (CPU+GPU torch backend
+plus the reference adapters). The bare install is the **numpy CPU reference
+only** — correct but slow.
+
+```bash
+pip install tridec                # numpy CPU reference only
+pip install "tridec[torch]"       # + batched torch backend (CPU/GPU)
+pip install "tridec[gpu]"         # + Triton GPU kernels (CUDA or ROCm)
+pip install "tridec[decoders]"    # + ldpc / relay-bp reference adapters
+pip install "tridec[sinter]"      # + sinter.collect integration
+```
+
+## Quickstart
+
+```python
+import stim
+import tridec
+
+circuit = stim.Circuit.from_file("memory.stim")
+dem = circuit.detector_error_model(decompose_errors=False)
+
+decoder = tridec.from_dem(dem, backend="auto")   # triton > torch > numpy
+
+dets, obs = circuit.compile_detector_sampler(seed=0).sample(
+    100_000, separate_observables=True)
+pred = decoder.decode_batch(dets)                      # (shots, n_obs) bool
+print("logical error rate:", (pred != obs).any(axis=1).mean())
+```
+
+Raw matrices work too: `tridec.from_matrices(H, priors, observables=Lo)`.
+Relay-BP: `tridec.from_dem(dem, algorithm="relay")` (Triton kernels only).
+
+With [sinter](https://pypi.org/project/sinter/) (the `[sinter]` extra):
+
+```python
+import sinter
+from tridec.sinter import sinter_decoders
+
+stats = sinter.collect(
+    num_workers=4, tasks=tasks,
+    decoders=["tridec_bp", "pymatching"],
+    custom_decoders=sinter_decoders(),
+    max_shots=1_000_000)
+```
+
+## Backend × algorithm matrix (honest availability)
+
+| Algorithm | `numpy` | `torch` | `triton` | `metal` (experimental) |
+|---|---|---|---|---|
+| min-sum BP | yes (CPU reference) | yes (CPU + CUDA/ROCm) | yes (CUDA + ROCm) | yes (fp32) |
+| Relay-BP | no | no | yes (CUDA + ROCm) | yes (fp32, slow — see below) |
+
+There is no in-package CPU Relay-BP; its CPU reference is IBM's `relay-bp`
+Rust decoder, wrapped in `tridec.adapters` and used as the validation
+oracle for the Triton path.
+
+## What's validated where
+
+| Environment | Status |
+|---|---|
+| CPU (any) | numpy BP reference; torch BP bit-identical to numpy at fp64 (one iteration), LER-identical full decode |
+| NVIDIA H200, CUDA 12.4, torch 2.4.1, triton 3.0.0 | Triton BP: ≥99.5% hard-decision agreement vs fp64 references, LER-identical (156 = 156 = 156 fails / 2000 shots vs numpy/torch). Triton Relay-BP: LER-matches the `relay-bp` Rust oracle (31 vs 38 fails / 2000, overlapping Wilson CIs) — carried source-repo receipts |
+| AMD MI300X, ROCm 7.0.0, torch 2.9, triton 3.4.0 | Same kernels, unmodified: identical primitive-identity numbers (pre-leg posterior max-diff 1.8e-15) and the same oracle-vs-Triton LER identity (carried receipts) — **and validated through the installed package for v0.1.0** (`bench/receipts/mi300x_packaged.json`): full suite 88 passed / 10 skipped on gfx942 (GPU tiers bind, darwin-only strict tiers skip), packaged-API BP 166 = numpy 166 fails / 2000, Relay-BP fp32 34 vs Rust oracle 31 (overlapping CIs), throughput within ±2.2% of the carried receipt |
+| Apple silicon (M4 Max), triton-metal | **Experimental, spike-validated only** (`bench/receipts/metal_spike.md`): both kernels pass the same correctness gates at fp32; see the section below |
+
+## Experimental: Apple silicon (Metal)
+
+The same Triton kernels run on Apple-silicon GPUs through
+[triton-metal](https://github.com/bledden/triton-metal), with **zero changes
+to the kernel source**. This is experimental: validated at spike level on one
+machine (M4 Max), fp32 only (Metal has no fp64), and not part of the
+official receipt set.
+
+```bash
+# triton-metal + a triton >= 3.6 build + torch must be importable, then:
+pip install tridec
+python -c "import tridec; print(tridec.available_backends())"  # ['metal', ...]
+```
+
+`backend="auto"` detects the triton-metal environment (darwin, `triton` +
+`triton_metal` importable, no CUDA/ROCm device) and selects `"metal"`;
+`backend="triton"` resolves to `"metal"` there too, and `backend="metal"`
+asserts the environment is present. The execution pattern is triton-metal's
+documented one — **CPU torch tensors** (zero-copy via unified memory; not
+`mps`) — so no device arguments are needed.
+
+What the spike measured (2000 canonical shots, seed 0, M4 Max — re-validated
+through this API path in `tests/test_metal.py`):
+
+- **min-sum BP (fp32)**: all correctness gates pass — one-iteration hard
+  agreement 1.000 vs the fp64 numpy reference on both the surface-code and
+  BB-code fixtures; LER 76 = 76 / 2000 (surface) and 167 vs 168 / 2000 (BB).
+  Batched decode of 2000 shots in 28 ms (surface) / 167 ms (BB) — **37–56×
+  the per-shot numpy baseline on the same machine**.
+- **Relay-BP (fp32)**: correct but slow — LER matches the `relay-bp` Rust
+  oracle (31 vs 39 fails / 2000, per-shot agreement 99.3%), but
+  `decode_batch(2000)` takes **31 s** vs 1.26 s for the Rust CPU oracle:
+  relay's per-iteration host loop (~7k small kernel launches) is
+  launch-overhead dominated on Metal. Use it for validation, not production.
+- Relay-BP on metal enforces fp32: `dtype="float64"` raises with a clear
+  error; the default resolves to `float32`.
+
+No claims beyond the spike: no official LER receipts, no cross-machine
+validation, no performance tuning. CUDA/ROCm remain the supported GPU paths.
+
+Compatibility floors in `pyproject.toml`; known-good pins: stim 1.15.0,
+ldpc 2.4.1, relay-bp 0.2.2, torch 2.4.1 / 2.9, triton 3.0 / 3.4.
+
+## Validation discipline
+
+`tridec.validation` ships the matched-protocol harness the numbers were
+produced with: `dem_hash` (sha256 of the DEM's canonical bytes), `run_matched`
+(one shared DEM, one shot set, fail-fast DEM-identity and tie-break gates),
+Wilson/TOST statistics and a paired per-shot gap-to-MLE bootstrap. The test
+suite pins the extraction byte-for-byte: 8 canonical BB-code fixture circuits
+must hash to the exact DEM sha256s recorded in the carried `zoo_grid.json`
+receipt, and a full 16,667-shot cell must reproduce the recorded
+logical-failure counts of the `ldpc` reference adapters exactly.
+
+For v0.1.0 the WHOLE grid was re-decoded in the receipt environment
+(`bench/full_grid_noregression.py`): 31 of 32 (cell, decoder) failure counts
+reproduce **exactly** — all 24 BP / BP-OSD-0 / BP-OSD-10 counts, and 7 of 8
+BPLSD counts. The single deviation (BPLSD, p=0.002/X: 879 vs 880, one shot
+in 200,000) is attributed by a same-environment repeat experiment to
+run-to-run nondeterminism inside ldpc's `BpLsdDecoder` itself (identical
+shots, fresh instances: 879/880/879) — documented in
+`bench/receipts/full_grid_noregression.json`.
+
+## Status
+
+`0.1.0` — first release. The kernels and their validation receipts are
+stable; the public API surface is young and may still move before 1.0.
+Minor `0.x` releases may rename or remove public API; `1.0` will lock the
+surface. GPU paths require triton + a CUDA/ROCm GPU (or the experimental
+triton-metal environment); the GPU/metal test tiers skip cleanly where
+unavailable.
+Validated through the installed package on MI300X/ROCm (v0.1.0) and via
+carried receipts on H200/CUDA; Metal is experimental.
+
+## License
+
+Apache-2.0.

tridec-0.1.0/README.md

@@ -0,0 +1,167 @@
+# tridec
+
+[![ci](https://github.com/bledden/tridec/actions/workflows/ci.yml/badge.svg)](https://github.com/bledden/tridec/actions/workflows/ci.yml)
+
+*Badge honesty: CI is CPU-only (ubuntu + macos arm64; the macos lane binds the
+strict exact-count receipt gates). There are no GPU runners — the CUDA/ROCm
+kernel paths are validated by the carried H200/MI300X receipts in
+`bench/receipts/`, and the experimental Metal tier runs on a local machine.*
+
+An open, vendor-portable GPU decoder library for quantum LDPC codes — Triton
+min-sum BP and Relay-BP decoders that consume any stim `DetectorErrorModel` or
+raw parity-check matrices, with CPU reference implementations, validated
+against the standard CPU references (`ldpc`, `relay-bp`), running on NVIDIA
+(CUDA) and AMD (ROCm) GPUs.
+
+The same Triton kernels run unmodified on both vendors: the Relay-BP kernel
+reproduces its logical-error-rate validation numbers identically on an NVIDIA
+H200 (CUDA 12.4, triton 3.0) and an AMD MI300X (ROCm 7.0, triton 3.4) — see
+[docs/benchmark.md](docs/benchmark.md) and the raw receipts in
+`bench/receipts/`. Validated scope is NVIDIA + AMD; Apple silicon runs the
+same kernels through [triton-metal](https://github.com/bledden/triton-metal)
+as an **experimental** backend (see below).
+
+## Install
+
+Most users want `pip install "tridec[torch,decoders]"` (CPU+GPU torch backend
+plus the reference adapters). The bare install is the **numpy CPU reference
+only** — correct but slow.
+
+```bash
+pip install tridec                # numpy CPU reference only
+pip install "tridec[torch]"       # + batched torch backend (CPU/GPU)
+pip install "tridec[gpu]"         # + Triton GPU kernels (CUDA or ROCm)
+pip install "tridec[decoders]"    # + ldpc / relay-bp reference adapters
+pip install "tridec[sinter]"      # + sinter.collect integration
+```
+
+## Quickstart
+
+```python
+import stim
+import tridec
+
+circuit = stim.Circuit.from_file("memory.stim")
+dem = circuit.detector_error_model(decompose_errors=False)
+
+decoder = tridec.from_dem(dem, backend="auto")   # triton > torch > numpy
+
+dets, obs = circuit.compile_detector_sampler(seed=0).sample(
+    100_000, separate_observables=True)
+pred = decoder.decode_batch(dets)                      # (shots, n_obs) bool
+print("logical error rate:", (pred != obs).any(axis=1).mean())
+```
+
+Raw matrices work too: `tridec.from_matrices(H, priors, observables=Lo)`.
+Relay-BP: `tridec.from_dem(dem, algorithm="relay")` (Triton kernels only).
+
+With [sinter](https://pypi.org/project/sinter/) (the `[sinter]` extra):
+
+```python
+import sinter
+from tridec.sinter import sinter_decoders
+
+stats = sinter.collect(
+    num_workers=4, tasks=tasks,
+    decoders=["tridec_bp", "pymatching"],
+    custom_decoders=sinter_decoders(),
+    max_shots=1_000_000)
+```
+
+## Backend × algorithm matrix (honest availability)
+
+| Algorithm | `numpy` | `torch` | `triton` | `metal` (experimental) |
+|---|---|---|---|---|
+| min-sum BP | yes (CPU reference) | yes (CPU + CUDA/ROCm) | yes (CUDA + ROCm) | yes (fp32) |
+| Relay-BP | no | no | yes (CUDA + ROCm) | yes (fp32, slow — see below) |
+
+There is no in-package CPU Relay-BP; its CPU reference is IBM's `relay-bp`
+Rust decoder, wrapped in `tridec.adapters` and used as the validation
+oracle for the Triton path.
+
+## What's validated where
+
+| Environment | Status |
+|---|---|
+| CPU (any) | numpy BP reference; torch BP bit-identical to numpy at fp64 (one iteration), LER-identical full decode |
+| NVIDIA H200, CUDA 12.4, torch 2.4.1, triton 3.0.0 | Triton BP: ≥99.5% hard-decision agreement vs fp64 references, LER-identical (156 = 156 = 156 fails / 2000 shots vs numpy/torch). Triton Relay-BP: LER-matches the `relay-bp` Rust oracle (31 vs 38 fails / 2000, overlapping Wilson CIs) — carried source-repo receipts |
+| AMD MI300X, ROCm 7.0.0, torch 2.9, triton 3.4.0 | Same kernels, unmodified: identical primitive-identity numbers (pre-leg posterior max-diff 1.8e-15) and the same oracle-vs-Triton LER identity (carried receipts) — **and validated through the installed package for v0.1.0** (`bench/receipts/mi300x_packaged.json`): full suite 88 passed / 10 skipped on gfx942 (GPU tiers bind, darwin-only strict tiers skip), packaged-API BP 166 = numpy 166 fails / 2000, Relay-BP fp32 34 vs Rust oracle 31 (overlapping CIs), throughput within ±2.2% of the carried receipt |
+| Apple silicon (M4 Max), triton-metal | **Experimental, spike-validated only** (`bench/receipts/metal_spike.md`): both kernels pass the same correctness gates at fp32; see the section below |
+
+## Experimental: Apple silicon (Metal)
+
+The same Triton kernels run on Apple-silicon GPUs through
+[triton-metal](https://github.com/bledden/triton-metal), with **zero changes
+to the kernel source**. This is experimental: validated at spike level on one
+machine (M4 Max), fp32 only (Metal has no fp64), and not part of the
+official receipt set.
+
+```bash
+# triton-metal + a triton >= 3.6 build + torch must be importable, then:
+pip install tridec
+python -c "import tridec; print(tridec.available_backends())"  # ['metal', ...]
+```
+
+`backend="auto"` detects the triton-metal environment (darwin, `triton` +
+`triton_metal` importable, no CUDA/ROCm device) and selects `"metal"`;
+`backend="triton"` resolves to `"metal"` there too, and `backend="metal"`
+asserts the environment is present. The execution pattern is triton-metal's
+documented one — **CPU torch tensors** (zero-copy via unified memory; not
+`mps`) — so no device arguments are needed.
+
+What the spike measured (2000 canonical shots, seed 0, M4 Max — re-validated
+through this API path in `tests/test_metal.py`):
+
+- **min-sum BP (fp32)**: all correctness gates pass — one-iteration hard
+  agreement 1.000 vs the fp64 numpy reference on both the surface-code and
+  BB-code fixtures; LER 76 = 76 / 2000 (surface) and 167 vs 168 / 2000 (BB).
+  Batched decode of 2000 shots in 28 ms (surface) / 167 ms (BB) — **37–56×
+  the per-shot numpy baseline on the same machine**.
+- **Relay-BP (fp32)**: correct but slow — LER matches the `relay-bp` Rust
+  oracle (31 vs 39 fails / 2000, per-shot agreement 99.3%), but
+  `decode_batch(2000)` takes **31 s** vs 1.26 s for the Rust CPU oracle:
+  relay's per-iteration host loop (~7k small kernel launches) is
+  launch-overhead dominated on Metal. Use it for validation, not production.
+- Relay-BP on metal enforces fp32: `dtype="float64"` raises with a clear
+  error; the default resolves to `float32`.
+
+No claims beyond the spike: no official LER receipts, no cross-machine
+validation, no performance tuning. CUDA/ROCm remain the supported GPU paths.
+
+Compatibility floors in `pyproject.toml`; known-good pins: stim 1.15.0,
+ldpc 2.4.1, relay-bp 0.2.2, torch 2.4.1 / 2.9, triton 3.0 / 3.4.
+
+## Validation discipline
+
+`tridec.validation` ships the matched-protocol harness the numbers were
+produced with: `dem_hash` (sha256 of the DEM's canonical bytes), `run_matched`
+(one shared DEM, one shot set, fail-fast DEM-identity and tie-break gates),
+Wilson/TOST statistics and a paired per-shot gap-to-MLE bootstrap. The test
+suite pins the extraction byte-for-byte: 8 canonical BB-code fixture circuits
+must hash to the exact DEM sha256s recorded in the carried `zoo_grid.json`
+receipt, and a full 16,667-shot cell must reproduce the recorded
+logical-failure counts of the `ldpc` reference adapters exactly.
+
+For v0.1.0 the WHOLE grid was re-decoded in the receipt environment
+(`bench/full_grid_noregression.py`): 31 of 32 (cell, decoder) failure counts
+reproduce **exactly** — all 24 BP / BP-OSD-0 / BP-OSD-10 counts, and 7 of 8
+BPLSD counts. The single deviation (BPLSD, p=0.002/X: 879 vs 880, one shot
+in 200,000) is attributed by a same-environment repeat experiment to
+run-to-run nondeterminism inside ldpc's `BpLsdDecoder` itself (identical
+shots, fresh instances: 879/880/879) — documented in
+`bench/receipts/full_grid_noregression.json`.
+
+## Status
+
+`0.1.0` — first release. The kernels and their validation receipts are
+stable; the public API surface is young and may still move before 1.0.
+Minor `0.x` releases may rename or remove public API; `1.0` will lock the
+surface. GPU paths require triton + a CUDA/ROCm GPU (or the experimental
+triton-metal environment); the GPU/metal test tiers skip cleanly where
+unavailable.
+Validated through the installed package on MI300X/ROCm (v0.1.0) and via
+carried receipts on H200/CUDA; Metal is experimental.
+
+## License
+
+Apache-2.0.

tridec-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tridec"
+version = "0.1.0"
+description = "Vendor-portable GPU decoders for quantum LDPC codes: Triton min-sum BP and Relay-BP on NVIDIA (CUDA) and AMD (ROCm), with CPU reference implementations, consuming any stim DetectorErrorModel or raw parity-check matrices."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Blake Ledden" }]
+keywords = ["quantum error correction", "qLDPC", "decoder", "belief propagation", "triton", "stim", "GPU"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+
+# Version floors are the oldest versions this package is validated against.
+# Known-good (validated) combinations — see README "Compatibility" for the full matrix:
+#   stim 1.15.0, ldpc 2.4.1, relay-bp 0.2.2,
+#   torch 2.4.1 + triton 3.0.0 (CUDA 12.4, H200),
+#   torch 2.9 + triton 3.4 (ROCm 7.0, MI300X).
+dependencies = [
+    "numpy>=1.24",
+    "scipy>=1.10",
+    "stim>=1.13",
+]
+
+[project.urls]
+Repository = "https://github.com/bledden/tridec"
+Documentation = "https://github.com/bledden/tridec/blob/master/docs/benchmark.md"
+Issues = "https://github.com/bledden/tridec/issues"
+
+[project.optional-dependencies]
+# torch backend: batched BP that runs on CPU and CUDA/ROCm devices.
+torch = ["torch>=2.4"]
+# gpu: the Triton fast path (NVIDIA CUDA or AMD ROCm builds of torch+triton).
+gpu = ["torch>=2.4", "triton>=3.0"]
+# decoders: optional CPU reference decoder adapters (validation targets).
+decoders = ["ldpc>=2.4.1", "relay-bp[stim]>=0.2.2"]
+# sinter: the sinter.collect custom-decoder integration (tridec.sinter).
+sinter = ["sinter>=1.15"]
+dev = ["pytest>=8.0", "sinter>=1.15", "pymatching>=2.1"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"
+# Environment markers: the suite runs on three kinds of machines —
+#   CPU-only      : gpu + metal tests skip (importorskip / module-level skips)
+#   CUDA/ROCm GPU : gpu tests run, metal tests skip
+#   Apple silicon + triton-metal : metal tests run, gpu tests skip
+markers = [
+    "gpu: requires triton + a CUDA/ROCm GPU",
+    "metal: requires the experimental triton-metal environment (Apple silicon)",
+]

tridec-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+