Skip to content

Commit 38565c0

Browse files
authored
update the readme to have starting point for configurations (#121)
Added the long beam and short beam from the paper as starting points for setting up the Tesseract decoder configurations.
1 parent 39661b3 commit 38565c0

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,37 @@ print(f"Predicted errors indices: {predicted_errors}")
206206
for i in predicted_errors:
207207
print(f" {i}: {decoder.errors[i]}")
208208
```
209+
## Good Starting Points for Tesseract Configurations:
210+
The [Tesseract paper](https://arxiv.org/pdf/2503.10988) recommends two setup for starting your exploration with tesseract:
209211

210212

213+
(1) Long-beam setup:
214+
```
215+
tesseract_config = tesseract.TesseractConfig(
216+
dem=dem,
217+
pqlimit=1_000_000,
218+
det_beam=20,
219+
beam_climbing=True,
220+
num_det_orders=21,
221+
det_order=tesseract_decoder.utils.DetOrder.DetIndex,
222+
no_revisit_dets=True,
223+
)
224+
```
225+
(2) Short-beam setup:
226+
227+
```
228+
tesseract_config = tesseract.TesseractConfig(
229+
dem=dem,
230+
pqlimit=200_000,
231+
det_beam=15,
232+
beam_climbing=True,
233+
num_det_orders=16,
234+
det_order=tesseract_decoder.utils.DetOrder.DetIndex,
235+
no_revisit_dets=True,
236+
)
237+
```
238+
For `det_order`, you can use two other options of `DetIndex` and `DetCoordinate` as well.
239+
These values balance decoding speed and accuracy across the benchmarks reported in the paper and can be adjusted for specific use cases.
211240
## Help
212241

213242
* Do you have a feature request or want to report a bug? [Open an issue on

0 commit comments

Comments
 (0)