Skip to content

Commit 2d44c5d

Browse files
authored
[docs] Update nv-qldpc-decoder docs for 0.6.0 (#499)
Signed-off-by: Ben Howe <bhowe@nvidia.com>
1 parent 84d18ca commit 2d44c5d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/sphinx/api/qec/nv_qldpc_decoder_api.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,12 @@
100100
- `clip_value` (float): Value to clip the BP messages to. Should be a
101101
non-negative value (defaults to 0.0, which disables clipping). Introduced in
102102
0.4.0.
103+
- `repeatable` (bool): Whether to make the BP algorithm (and Relay BP
104+
algorithm if enabled) bit-for-bit repeatable. Defaults to False. You
105+
must set `clip_value` to a non-zero value to use this option. Setting
106+
this option to True makes it run approximately 5-10% slower, but you
107+
are guaranteed to get repeatable results, which is often useful for
108+
both timing and detailed syndrome analysis. Introduced in 0.6.0.
103109
- `bp_method` (int): Core BP algorithm to use (defaults to 0). Introduced in 0.4.0,
104110
expanded in 0.5.0:
105111

@@ -137,6 +143,11 @@
137143
- "NConv": Stop after N convergences (requires `stop_nconv` parameter)
138144
- `stop_nconv` (int): Number of convergences to wait for before stopping
139145
(required only when `stopping_criterion="NConv"`)
146+
147+
.. note::
148+
Starting in version 0.6.0, convergence during the ``pre_iter`` phase counts as a
149+
successful convergence towards the stopping criteria. Prior to 0.6.0, convergence
150+
during pre-iterations did not count.
140151
- `bp_seed` (int): Seed for random number generation used in `bp_method=3` (disordered
141152
memory BP). Optional parameter, defaults to 42 if not provided. Introduced in 0.5.0.
142153
- `opt_results` (heterogeneous_map): Optional results to return. This field can be

0 commit comments

Comments
 (0)