Skip to content

Commit 9872492

Browse files
authored
Tweak layout, shorten intro, add citation, add QAI logo (#8)
* Tweak layout, shorten intro, add QAI logo Changes: - Edited the lead-in paragraph in an attempt to reduce redundancy with the "Features" section - Added a TOC and some customizations to the layout of the top - Added the QAI logo at the bottom of the page * Add QAI logo file * Add citation & help sections
1 parent 43ae070 commit 9872492

File tree

2 files changed

+67
-13
lines changed

2 files changed

+67
-13
lines changed

README.md

Lines changed: 55 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,39 @@
1+
<div align="center">
2+
13
# Tesseract Decoder
24

3-
A Search-Based Decoder for Quantum Error Correction
5+
A Search-Based Decoder for Quantum Error Correction.
46

57
[![Licensed under the Apache 2.0 open-source license](https://img.shields.io/badge/License-Apache%202.0-3c60b1.svg?logo=opensourceinitiative\&logoColor=white\&style=flat-square)](https://github.com/quantumlib/tesseract-decoder/blob/main/LICENSE)
8+
![C++](https://img.shields.io/badge/C++-20-fcbc2c?style=flat-square&logo=C%2B%2B&logoColor=white)
9+
10+
[Installation](#installation) &ndash;
11+
[Usage](#usage) &ndash;
12+
[Help](#help) &ndash;
13+
[Citation](#citation) &ndash;
14+
[Contact](#contact)
615

7-
## Overview
16+
</div>
817

918
Tesseract is a Most Likely Error decoder designed for Low Density Parity Check (LDPC) quantum
10-
error-correcting codes. It employs the A\* search algorithm to efficiently navigate the
11-
exponentially large graph of possible error subsets, identifying the most likely error configuration
12-
consistent with the observed syndrome. Tesseract leverages several pruning heuristics and manifold
13-
orientation techniques to achieve significant speed improvements over traditional integer
14-
programming-based decoders, while maintaining comparable accuracy at moderate physical error rates.
19+
error-correcting codes. It applies pruning heuristics and manifold orientation techniques during a
20+
search over the error subsets to identify the most likely error configuration consistent with the
21+
observed syndrome. Tesseract archives significant speed improvements over traditional integer
22+
programming-based decoders while maintaining comparable accuracy at moderate physical error rates.
1523

1624
We tested the Tesseract decoder for:
1725

1826
* Surface codes
1927
* Color codes
2028
* Bivariate-bicycle codes
21-
* Transversal CNOT protocols for surface codes Stim circuits for these protocols are stored in
22-
`testdata/`.
29+
* Transversal CNOT protocols for surface codes
2330

2431
## Features
2532

2633
* **A\* search:** deploys [A\* search](https://en.wikipedia.org/wiki/A*_search_algorithm) while
2734
running a [Dijkstra algorithm](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm) with early
2835
stop for high performance.
29-
* **Stim and DEM Support:** processes [Stim](https://github.com/quantumlib/stim) circuit files and
36+
* **Stim and DEM Support:** processes [Stim](https://github.com/quantumlib/stim) circuit files and
3037
[Detector Error Model
3138
(DEM)](https://github.com/quantumlib/Stim/blob/main/doc/file_format_dem_detector_error_model.md)
3239
files with arbitrary error models.
@@ -112,7 +119,6 @@ Using a Detection Event File and Observable Flips:
112119
Tesseract supports reading and writing from all of Stim's standard [output
113120
formats](https://github.com/quantumlib/Stim/blob/main/doc/result_formats.md).
114121

115-
116122
### Performance Optimization
117123

118124
Here are some tips for improving performance:
@@ -132,7 +138,36 @@ Here are some tips for improving performance:
132138
* *DEM usage frequency output*: if `--dem-out` is specified, outputs estimated error frequencies.
133139
* *Statistics output*: includes number of shots, errors, low confidence shots, and processing time.
134140

135-
<!-- ## Citing Tesseract Decoder<a name="how-to-cite-tesseract"> -->
141+
## Help
142+
143+
* Do you have a feature request or want to report a bug? [Open an issue on
144+
GitHub] to report it!
145+
* Do you have a code contribution? Read our [contribution guidelines], then
146+
open a [pull request]!
147+
148+
[Open an issue on GitHub]: https://github.com/quantumlib/tesseract-decoder/issues/new/choose
149+
[contribution guidelines]: https://github.com/quantumlib/tesseract-decoder/blob/main/CONTRIBUTING.md
150+
[pull request]: https://help.github.com/articles/about-pull-requests
151+
152+
We are committed to providing a friendly, safe, and welcoming environment for
153+
all. Please read and respect our [Code of Conduct](CODE_OF_CONDUCT.md).
154+
155+
## Citation
156+
157+
When publishing articles or otherwise writing about Tesseract Decoder, please
158+
cite the following:
159+
160+
```latex
161+
@misc{beni2025tesseractdecoder,
162+
title={Tesseract: A Search-Based Decoder for Quantum Error Correction},
163+
author={Laleh Aghababaie Beni and Oscar Higgott and Noah Shutty},
164+
year={2025},
165+
eprint={2503.10988},
166+
archivePrefix={arXiv},
167+
primaryClass={quant-ph},
168+
url={https://arxiv.org/abs/2503.10988},
169+
}
170+
```
136171

137172
## Contact
138173

@@ -142,6 +177,13 @@ For any questions or concerns not addressed here, please email <quantum-oss-main
142177

143178
Tesseract Decoder is not an officially supported Google product. This project is not eligible for
144179
the [Google Open Source Software Vulnerability Rewards
145-
Program](https://bughunters.google.com/open-source-security).
180+
Program](https://bughunters.google.com/open-source-security).
146181

147182
Copyright 2025 Google LLC.
183+
184+
<div align="center">
185+
<a href="https://quantumai.google">
186+
<img width="15%" alt="Google Quantum AI"
187+
src="./docs/images/quantum-ai-vertical.svg">
188+
</a>
189+
</div>
Lines changed: 12 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)