Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: TensorBFS/BPDecoderPlus
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: main
Choose a base ref
...
head repository: TensorBFS/BPDecoderPlus
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: docs/presentation-ready-getting-started
Choose a head ref
Checking mergeability… Don’t worry, you can still create the pull request.
  • 5 commits
  • 13 files changed
  • 1 contributor

Commits on Jan 26, 2026

  1. 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
    @ChanceSiyuan
    ChanceSiyuan committed Jan 26, 2026
    Configuration menu
    Copy the full SHA
    e878890 View commit details
    Browse the repository at this point in the history

  2. 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
    @ChanceSiyuan
    ChanceSiyuan committed Jan 26, 2026
    Configuration menu
    Copy the full SHA
    c1053a3 View commit details
    Browse the repository at this point in the history

  3. docs: update poster and lecture notes

    @ChanceSiyuan
    ChanceSiyuan committed Jan 26, 2026
    Configuration menu
    Copy the full SHA
    25a5e2f View commit details
    Browse the repository at this point in the history

  4. compile poster

    @ChanceSiyuan
    ChanceSiyuan committed Jan 26, 2026
    Configuration menu
    Copy the full SHA
    1831b01 View commit details
    Browse the repository at this point in the history

  5. Add PPT

    @ChanceSiyuan
    ChanceSiyuan committed Jan 26, 2026
    Configuration menu
    Copy the full SHA
    75b2b80 View commit details
    Browse the repository at this point in the history
Loading