Skip to content

Commit 2e68bf1

Browse files
committed
Addressed additional review comments
Signed-off-by: Chuck Ketcham <cketcham@nvidia.com>
1 parent 143fe9a commit 2e68bf1

3 files changed

Lines changed: 13 additions & 5 deletions

File tree

docs/sphinx/examples/qec/realtime_decoding_demo/CMakeLists.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
# surface_code_realtime_decoding generator: --target stim; writes the
1515
# decoder config + syndrome files.
1616
# surface_code_realtime_decoding-cqr lowered kernel: adds -frealtime-lowering
17-
# -DQEC_APP_EXTERNAL_DECODING_SERVER; the
18-
# live QPU kernel that streams syndromes to
19-
# the delivered decoding_server over UDP.
17+
# -DQEC_APP_CQR; the live QPU kernel that
18+
# streams syndromes to the delivered
19+
# decoding_server over UDP.
2020
#
2121
# The decoding_server and the FPGA playback tool are DELIVERABLES (installed,
2222
# not built here); run_realtime_decoding.sh resolves them from --install-prefix.

docs/sphinx/examples/qec/realtime_decoding_demo/run_realtime_decoding.sh

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,14 +193,22 @@ if [[ "$SOURCE" != "qpu-kernel" && "$SOURCE" != "fpga" ]]; then
193193
echo "ERROR: --source must be qpu-kernel or fpga (got '$SOURCE')" >&2; exit 1
194194
fi
195195

196+
# The example source also supports 'sliding_window', but that decoder is not
197+
# yet supported over the realtime decoding path to the GPU (it needs matching
198+
# updates to the proprietary cudevice archive), so this script does not accept
199+
# it.
196200
case "$DECODER" in
197201
pymatching|nv-qldpc-decoder|multi_error_lut) ;;
202+
sliding_window)
203+
echo "ERROR: sliding_window is not yet supported over the realtime" >&2
204+
echo " decoding path to the GPU." >&2; exit 1 ;;
198205
*) echo "ERROR: --decoder must be pymatching, nv-qldpc-decoder, or" >&2
199206
echo " multi_error_lut (got '$DECODER')" >&2; exit 1 ;;
200207
esac
201208

202209
_log() { echo "==> $*"; }
203210
_info() { echo " $*"; }
211+
_warn() { echo "WARNING: $*" >&2; }
204212
_err() { echo "ERROR: $*" >&2; }
205213
_banner() { echo; echo "========================================";
206214
echo " $*"; echo "========================================"; echo; }
@@ -598,7 +606,7 @@ run_fpga() {
598606
local HSB_WQE_DEPTH=64
599607
local GPU_ROCE_NUM_PAGES="$HSB_WQE_DEPTH"
600608
if (( NUM_SLOTS > HSB_WQE_DEPTH )); then
601-
_err "NUM_SLOTS=$NUM_SLOTS exceeds the HSB WQE depth ($HSB_WQE_DEPTH); clamping"
609+
_warn "NUM_SLOTS=$NUM_SLOTS exceeds the HSB WQE depth ($HSB_WQE_DEPTH); clamping"
602610
NUM_SLOTS="$HSB_WQE_DEPTH"
603611
fi
604612
if [[ "$TRANSPORT" == "gpu_roce" ]]; then

docs/sphinx/examples_rst/qec/realtime_decoding_demo.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ SDK — using only installed headers and libraries:
4646
- ``surface_code_realtime_decoding`` — the **generator** (``--target stim``):
4747
writes the decoder configuration and, for the FPGA source, a syndrome file.
4848
- ``surface_code_realtime_decoding-cqr`` — the **lowered kernel**
49-
(``-frealtime-lowering -DQEC_APP_EXTERNAL_DECODING_SERVER``): the live
49+
(``-frealtime-lowering -DQEC_APP_CQR``): the live
5050
syndrome source that streams to the server over UDP.
5151

5252

0 commit comments

Comments
 (0)