docs(qec): misc docs updates#744
Open
bmhowe23 wants to merge 4 commits into
Open
Conversation
…der options Close several documentation gaps for the 0.7.0 QEC release: - Add dedicated API fragments for the PyMatching (MWPM) and Chromobius color-code decoders and wire them into the Python and C++ "Built-in Decoders" lists; add matching tutorial sections in decoders.rst. - Document the surface-code `orientation` construction option (XV/XH/ZV/ZH, aliases O1-O4, default ZH) with usage examples. - Note that Python decode results are NumPy arrays as of 0.7.0 (DecoderResult / BatchDecoderResult / AsyncDecoderResult). - Document `trt_decoder` composite/global decoder chaining (`global_decoder` / `global_decoder_params`, including the supply-params-when-set caveat) and the `cuda_device_id` placement knob on the trt and nv-qldpc decoder parameter tables. All option names, values, and defaults verified against the plugin sources. Docs build clean (sphinx -n -W, zero warnings). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Ben Howe <bhowe@nvidia.com>
melody-ren
reviewed
Jul 24, 2026
melody-ren
reviewed
Jul 24, 2026
melody-ren
reviewed
Jul 24, 2026
Collaborator
|
Using this PR as a catch all place: I think decoder_context is not in the docs yet |
- Reword the cuda_device_id note (trt + nv-qldpc): when unpinned, the decoder runs on the default device (GPU 0) rather than a vague "current/default" device. - Simplify the get_decoder intro note for the PyMatching and Chromobius fragments per review feedback. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Ben Howe <bhowe@nvidia.com>
Collaborator
Author
I think it's actually already documented - it's under the Python casing DecoderContext (PascalCase vs snake_case as in many [but not all] of the Python vs C++ APIs). Coverage today:
|
melody-ren
approved these changes
Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documentation-only change that closes several gaps for the 0.7.0 QEC release,
where new or existing decoder features were not reflected in the docs. No code
or behavior changes.
Decoders newly documented
pymatching_api.rst(
error_rate_vec,merge_strategyand its five values, optionalOobservables matrix, matchable-graph requirement), wired into the Python and
C++ "Built-in Decoders" lists, plus a tutorial section in
decoders.rst.chromobius_api.rst(DEM-native construction from Stim DEM text, the "no parity-check matrix"
restriction, ≤64-observable limit, and the five boolean options), wired into
both API pages and
decoders.rst.Existing 0.7.0 features/options now documented
orientationconstruction option (XV/XH/ZV/ZH, aliasesO1–O4, defaultZH) with Python and C++ usage examples.trt_decodercomposite/global decoder chaining (global_decoder/global_decoder_params, including the "supply params — even empty — whenglobal_decoderis set" caveat).cuda_device_idplacement knob added to thetrt_decoderandnv-qldpc-decoderparameter tables.(
DecoderResult/BatchDecoderResult/AsyncDecoderResult).All option names, values, and defaults were verified against the plugin
sources (
pymatching.cpp,chromobius.cpp,surface_code.cpp,decoder.cpp,trt_decoder.cpp,py_decoder.cpp).This branch is based on
mainand is intended to be cherry-picked ontoreleases/v0.7.0.Runtime / performance impact
N/A — documentation only.
Self-review checklist
Before requesting review
sphinx -n -W --keep-goingsucceeds with zero warnings; the script's invalid-HTML checks pass.)Scope and size
Tests
New functionality has new tests.Documentation-only change; no code paths added.Tests fail if the new functionality is broken.N/A (docs only).Negative tests added where exceptions are expected.N/A (docs only).Truth data added.N/A (docs only).Documentation
Code style
*_api.rstfragment pattern.)Dependencies
🤖 Generated with Claude Code