Skip to content

Commit 6da2b8f

Browse files
authored
updated the readme (#79)
1 parent 0ebbcf8 commit 6da2b8f

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ A Search-Based Decoder for Quantum Error Correction.
99

1010
[Installation](#installation) –
1111
[Usage](#usage) –
12+
[Python Interface](#python-interface) –
1213
[Paper](https://arxiv.org/pdf/2503.10988) –
1314
[Help](#help) –
1415
[Citation](#citation) –
@@ -161,6 +162,9 @@ Here are some tips for improving performance:
161162
* *Statistics output*: includes number of shots, errors, low confidence shots, and processing time.
162163

163164
## Python Interface
165+
166+
[Full Python wrapper documentation](src/py/README.md)
167+
164168
This repository contains the C++ implementation of the Tesseract quantum error correction decoder, along with a Python wrapper. The Python wrapper/interface exposes the decoding algorithms and helper utilities, allowing Python users to leverage this high-performance decoding algorithm.
165169

166170
The following example demonstrates how to create and use the Tesseract decoder using the Python interface.
@@ -192,7 +196,6 @@ print(f"Detections: {detections}")
192196
print(f"Flipped observables: {flipped_observables}")
193197
```
194198

195-
For full documentation and detailed examples of the Python interface, please refer to the [docs](src/py/README.md).
196199

197200
## Help
198201

viz/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#Visualization
1+
# Visualization
22

33
This tool displays the detectors and errors from a Tesseract decoding run in 3D.
44

0 commit comments

Comments
 (0)