File tree Expand file tree Collapse file tree 1 file changed +11
-0
lines changed
Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Original file line number Diff line number Diff line change 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
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
You can’t perform that action at this time.
0 commit comments