Skip to content

Commit e8e23d2

Browse files
committed
Add required parameters for BP options in introduction
Signed-off-by: Melody Ren <[email protected]>
1 parent c1165a1 commit e8e23d2

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/sphinx/components/qec/introduction.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -645,15 +645,14 @@ API provides various post-processing options, which can be selected through its
645645
The decoder supports multiple BP algorithms (configured via ``bp_method``):
646646

647647
* **Sum-Product BP** (``bp_method=0``, default): Classic belief propagation algorithm that computes exact probabilities.
648-
* **Min-Sum BP** (``bp_method=1``): Approximation to sum-product that uses min operations instead of sum, with optional ``scale_factor``.
649-
* **Memory-based BP** (``bp_method=2``): Min-sum with uniform memory strength (``gamma0``) across all variable nodes, helping to escape local minima.
650-
* **Disordered Memory BP** (``bp_method=3``): Min-sum with per-variable memory strengths (``gamma_dist`` or ``explicit_gammas``), providing more flexibility.
648+
* **Min-Sum BP** (``bp_method=1``): Approximation to sum-product that uses min operations instead of sum. Optionally accepts ``scale_factor``.
649+
* **Memory-based BP** (``bp_method=2``): Min-sum with uniform memory strength across all variable nodes. **Requires:** ``gamma0``.
650+
* **Disordered Memory BP** (``bp_method=3``): Min-sum with per-variable memory strengths. **Requires:** ``gamma_dist`` [min, max] OR ``explicit_gammas`` (2D vector).
651651

652652
**Sequential Relay Decoding:**
653653

654654
Starting with version 0.5.0, the decoder supports Sequential Relay BP (configured via ``composition=1``), which combines disordered memory BP
655-
with multiple "relay legs" - sequential runs with different gamma configurations. Sequential Relay BP requires ``bp_method=3`` and the ``srelay_config`` parameter
656-
to specify pre-iterations, number of relay legs, and stopping criteria.
655+
with multiple "relay legs" - sequential runs with different gamma configurations. **Requires:** ``bp_method=3``, ``gamma0``, ``srelay_config``, and either ``gamma_dist`` OR ``explicit_gammas``.
657656

658657
The QLDPC decoder `nv-qldpc-decoder` requires a CUDA-Q compatible GPU. See the list below for dependencies and compatibility:
659658
https://nvidia.github.io/cuda-quantum/latest/using/install/local_installation.html#dependencies-and-compatibility

0 commit comments

Comments
 (0)