Commit 36e91f0
authored
docs: rewrite getting_started.md for presentation-ready format (#74)
* docs: polish documentation and expand API reference
- Update getting_started.md: fix "Next Steps" to reflect BP+OSD is available
- Expand api_reference.md with comprehensive API documentation:
- Add DEM functions (extract_dem, build_parity_check_matrix, build_decoding_uai)
- Add BatchBPDecoder and BatchOSDDecoder documentation
- Add Syndrome Database functions
- Add Circuit Generation functions
- Organize into logical sections
* docs: rewrite getting_started.md for presentation-ready format
Restructure the getting started guide into 5 clear sections designed
for a ~15 minute presentation:
1. The Decoding Problem - circuit-level noise, detection events
2. Pipeline Overview - Mermaid flowchart, DEM as rulebook
3. BP Algorithm & Why It Fails - factor graph, degeneracy problem
4. OSD Post-Processing - OSD-0 algorithm, soft-weighted cost
5. Live Demo - minimal code example, threshold results
Key changes:
- Reduced from 493 to 280 lines
- Added 3 Mermaid flowcharts for visual understanding
- Condensed code examples to essential snippets
- Corrected threshold values (BP+OSD ~0.7%, not ~10%)
- Moved detailed CLI options to usage_guide.md
- Removed troubleshooting and advanced usage sections
* docs: update poster and lecture notes
* compile poster1 parent 69fe6de commit 36e91f0
File tree
6 files changed
+1988
-2247
lines changed- docs
- poster
- note
6 files changed
+1988
-2247
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
4 | 74 | | |
5 | 75 | | |
6 | 76 | | |
| |||
43 | 113 | | |
44 | 114 | | |
45 | 115 | | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
0 commit comments