docs(qec): standalone decoding server reference page#686
Draft
vedika-saravanan wants to merge 1 commit into
Draft
docs(qec): standalone decoding server reference page#686vedika-saravanan wants to merge 1 commit into
vedika-saravanan wants to merge 1 commit into
Conversation
Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
vedika-saravanan
force-pushed
the
docs/decoding-server
branch
from
July 14, 2026 18:05
48fc6c4 to
93b25ab
Compare
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
Adds
docs/sphinx/examples_rst/qec/decoding_server.rst, a newreference page for the standalone
decoding_serverbinary introducedin the realtime decoding server work.
udp(CI/dev),cpu_roce(SoftRoCE /HSB FPGA HOST_CALL), and
gpu_roce(DOCA + Hololink device-graphscheduler), with when-to-use guidance for each.
transportandcuda_device_id; Python binding note forcuda_device_id; note onorchestration script auto-injection.
cuda_device_idvsHOLOLINK_GPU_IDresolution at startup.symbols (
decoder_rpc_dispatch.cu/cudaq-qec-realtime-decoder-rpc-dispatchwhole-archive link) with public-build fallback behavior explained.
all three transports.
constraint, the
512 x 64 = 32768failure case, and the--gpu-roce-num-pages autofix.hsb_fpga_decoding_server_test.sh): fulloption reference (modes, actions, decoder options, data generation,
run options, network options, build options) with quick-start examples.
missing proprietary symbols, ILA deterministic verification fix
(expected sample count vs. stabilization heuristic), and common
network issues.
Linked from the QEC examples toctree (
examples.rst) and therealtime decoding section of
introduction.rst.Generated with Claude Code
Runtime / performance impact
Self-review checklist
Please confirm each item before requesting review. Check
[x]or strikethrough and explain.
Before requesting review
Scope and size
(if so, an issue has been raised).
Tests
just when it is missing.
EXPECT_*/assertchecks areinsufficient for algorithmic correctness.
Documentation
tracked.
Code style
snake_casevscamelCase) forthe area being modified.
Dependencies
OSRB tickets filed.