|
101 | 101 | 0.4.0. |
102 | 102 | - `bp_method` (int): Core BP algorithm to use (defaults to 0). Introduced in 0.4.0, |
103 | 103 | expanded in 0.5.0: |
104 | | - |
105 | | - - 0: sum-product |
106 | | - - 1: min-sum (introduced in 0.4.0) |
107 | | - - 2: min-sum+mem (uniform memory strength, introduced in 0.5.0) |
108 | | - - 3: min-sum+dmem (disordered memory strength, introduced in 0.5.0) |
| 104 | + - 0: sum-product |
| 105 | + - 1: min-sum (introduced in 0.4.0) |
| 106 | + - 2: min-sum+mem (uniform memory strength, introduced in 0.5.0) |
| 107 | + - 3: min-sum+dmem (disordered memory strength, introduced in 0.5.0) |
109 | 108 | - `composition` (int): Iteration strategy (defaults to 0). Introduced in 0.5.0: |
110 | | - |
111 | | - - 0: Standard (single run) |
112 | | - - 1: Sequential relay (multiple gamma legs). Requires: `bp_method=3`, `srelay_config` |
| 109 | + - 0: Standard (single run) |
| 110 | + - 1: Sequential relay (multiple gamma legs). Requires: `bp_method=3`, `srelay_config` |
113 | 111 | - `scale_factor` (float): The scale factor to use for min-sum. Defaults to 1.0. |
114 | 112 | When set to 0.0, the scale factor is dynamically computed based on the |
115 | 113 | number of iterations. Introduced in 0.4.0. |
|
124 | 122 | (one per relay leg). Overrides `gamma_dist` if provided. Introduced in 0.5.0. |
125 | 123 | - `srelay_config` (heterogeneous_map): Sequential relay configuration (required for |
126 | 124 | `composition=1`). Contains the following parameters. Introduced in 0.5.0: |
127 | | - |
128 | | - - `pre_iter` (int): Number of pre-iterations to run before relay legs |
129 | | - - `num_sets` (int): Number of relay sets (legs) to run |
130 | | - - `stopping_criterion` (string): When to stop relay legs: |
131 | | - |
132 | | - - "All": Run all legs |
133 | | - - "FirstConv": Stop relay after first convergence |
134 | | - - "NConv": Stop after N convergences (requires `stop_nconv` parameter) |
135 | | - - `stop_nconv` (int): Number of convergences to wait for before stopping |
136 | | - (required only when `stopping_criterion="NConv"`) |
| 125 | + - `pre_iter` (int): Number of pre-iterations to run before relay legs |
| 126 | + - `num_sets` (int): Number of relay sets (legs) to run |
| 127 | + - `stopping_criterion` (string): When to stop relay legs: |
| 128 | + - "All": Run all legs |
| 129 | + - "FirstConv": Stop relay after first convergence |
| 130 | + - "NConv": Stop after N convergences (requires `stop_nconv` parameter) |
| 131 | + - `stop_nconv` (int): Number of convergences to wait for before stopping |
| 132 | + (required only when `stopping_criterion="NConv"`) |
137 | 133 | - `bp_seed` (int): Seed for random number generation used in `bp_method=3` (disordered |
138 | 134 | memory BP). Optional parameter, defaults to 42 if not provided. Introduced in 0.5.0. |
139 | 135 | - `opt_results` (heterogeneous_map): Optional results to return. This field can be |
140 | 136 | left empty if no additional results are desired. Choices are: |
141 | | - |
142 | | - - `bp_llr_history` (int): Return the last `bp_llr_history` iterations |
143 | | - of the BP LLR history. Minimum value is 0 and maximum value is |
144 | | - max_iterations. The actual number of returned iterations might be fewer |
145 | | - than `bp_llr_history` if BP converges before the requested number of |
146 | | - iterations. Introduced in 0.4.0. Note: Not supported for `composition=1`. |
147 | | - - `num_iter` (bool): If true, return the number of BP iterations run. |
148 | | - Introduced in 0.5.0. |
| 137 | + - `bp_llr_history` (int): Return the last `bp_llr_history` iterations |
| 138 | + of the BP LLR history. Minimum value is 0 and maximum value is |
| 139 | + max_iterations. The actual number of returned iterations might be fewer |
| 140 | + than `bp_llr_history` if BP converges before the requested number of |
| 141 | + iterations. Introduced in 0.4.0. Note: Not supported for `composition=1`. |
| 142 | + - `num_iter` (bool): If true, return the number of BP iterations run. |
| 143 | + Introduced in 0.5.0. |
149 | 144 |
|
0 commit comments