Skip to content

Conversation

@ChanceSiyuan
Copy link
Collaborator

Summary

  • Add MathJax support via pymdownx.arithmatex extension for proper LaTeX rendering
  • Create mathjax.js config for proper math rendering
  • Convert mathematical_description.md to use proper LaTeX notation
  • Add benchmark results section to getting_started.md
  • Include threshold plots and decoder comparison images

Changes

LaTeX Support

  • Updated mkdocs.yml with pymdownx.arithmatex extension
  • Created docs/javascripts/mathjax.js for MathJax configuration
  • Converted docs/mathematical_description.md to use proper LaTeX:
    • Message passing formulas: $\mu_{f \to x}(x)$
    • Damping update formula
    • Convergence conditions
    • Marginal probability computation

Benchmark Results

  • Added benchmark images to docs/images/:
    • threshold_plot.png
    • threshold_comparison.png
    • bp_failure_demo.png
    • osd_success_demo.png
  • Added Benchmark Results section to docs/getting_started.md with:
    • Threshold comparison plots
    • BP vs BP+OSD comparison
    • Decoding examples
    • Performance summary table

Closes #69

- Add MathJax support via pymdownx.arithmatex extension
- Create mathjax.js config for proper math rendering
- Convert mathematical_description.md to use proper LaTeX notation
- Add benchmark results section to getting_started.md
- Include threshold plots and decoder comparison images

Closes #69
@codecov
Copy link

codecov bot commented Jan 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.18%. Comparing base (7d3d79f) to head (59d7c63).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #72   +/-   ##
=======================================
  Coverage   95.18%   95.18%           
=======================================
  Files          10       10           
  Lines         747      747           
=======================================
  Hits          711      711           
  Misses         36       36           
Flag Coverage Δ
unittests 95.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@GiggleLiu GiggleLiu merged commit 5f1cf19 into main Jan 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation

3 participants