Skip to content

Gamma ensemble performance docs - #755

Merged
eliotheinrich merged 9 commits into
NVIDIA:mainfrom
eliotheinrich:pr-docs-gamma-ensemble
Jul 30, 2026
Merged

Gamma ensemble performance docs#755
eliotheinrich merged 9 commits into
NVIDIA:mainfrom
eliotheinrich:pr-docs-gamma-ensemble

Conversation

@eliotheinrich

Copy link
Copy Markdown
Collaborator

Description

This PR adds a documentation page demonstrating the performance tuning using the ensemble gamma version of Relay BP. It introduces a new .rst example, along with figures.

eliotheinrich and others added 4 commits July 24, 2026 10:27
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
@eliotheinrich eliotheinrich added the documentation Improvements or additions to documentation label Jul 28, 2026
@eliotheinrich
eliotheinrich marked this pull request as ready for review July 28, 2026 23:37

@bmhowe23 bmhowe23 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is look great, @eliotheinrich. A few comments below...

Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_ensemble_gamma_user_guide.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_ensemble_gamma_user_guide.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/examples.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_ensemble_gamma_user_guide.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/examples.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_ensemble_gamma_user_guide.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_ensemble_gamma_user_guide.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_ensemble_gamma_user_guide.rst Outdated
Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_ensemble_gamma_user_guide.rst Outdated
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
@eliotheinrich
eliotheinrich force-pushed the pr-docs-gamma-ensemble branch from 80fb024 to f89666a Compare July 29, 2026 16:33

@bmhowe23 bmhowe23 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Eliot. I think I just have one more minor comment.

Comment thread docs/sphinx/examples_rst/qec/nv_qldpc_gamma_ensemble_user_guide.rst Outdated
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>

@bmhowe23 bmhowe23 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks, Eliot!

@eliotheinrich
eliotheinrich merged commit 674cb8f into NVIDIA:main Jul 30, 2026
15 checks passed
melody-ren pushed a commit that referenced this pull request Jul 30, 2026
## Description

This PR adds a documentation page demonstrating the performance tuning
using the ensemble gamma version of Relay BP. It introduces a new .rst
example, along with figures.

---------

Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
(cherry picked from commit 674cb8f)
Signed-off-by: Melody Ren <melodyr@nvidia.com>
melody-ren added a commit to melody-ren/cudaqx that referenced this pull request Jul 30, 2026
- Introduce a top-level Performance Studies section: a headline-leading
  landing plus Eliot Heinrich's Relay BP gamma-ensemble study and figures
  (NVIDIA#755); the figures are tracked with git LFS.
- Point the Belief Propagation Methods lists on the QEC Decoders concept and
  example pages at the nv-qldpc-decoder API reference instead of enumerating
  them.
- Cross-link the study from the QEC Decoders concept page, and add a See Also
  (concept, example, C++/Python API) to the study page.
- Reword the remaining component-page references to name the actual page or
  section.

Signed-off-by: Melody Ren <melodyr@nvidia.com>
melody-ren added a commit to melody-ren/cudaqx that referenced this pull request Jul 30, 2026
Integrate NVIDIA#755 (gamma-ensemble docs) and NVIDIA#753 (nv-qldpc API update), both
already incorporated in our layout. Keep the restructured examples toctree and
the Performance Studies home for the gamma-ensemble study, dropping the duplicate
examples_rst/qec/nv_qldpc_gamma_ensemble_user_guide.rst that the merge introduced.

Signed-off-by: Melody Ren <melodyr@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation releases/v0.7.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants