Skip to content

Add docs and example for decoder construction from Stim DEM strings#598

Merged
vedika-saravanan merged 6 commits into
NVIDIA:mainfrom
vedika-saravanan:GHI-595
Jun 10, 2026
Merged

Add docs and example for decoder construction from Stim DEM strings#598
vedika-saravanan merged 6 commits into
NVIDIA:mainfrom
vedika-saravanan:GHI-595

Conversation

@vedika-saravanan

@vedika-saravanan vedika-saravanan commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Description

Updates QEC docs and adds public C++ and Python examples for decoder construction from Stim DEM strings.

Closes: #595

Runtime / performance impact

N/A. Documentation/example-only change.

Self-review checklist

Please confirm each item before requesting review. Check [x] or strike
through and explain.

Before requesting review

  • I reviewed my own full diff in GitHub or my editor.
  • PR is in Draft if it is not yet ready for review.
  • Temporary / debugging changes have been removed.
  • Local test logs reviewed; no unexplained warnings or errors.
  • CI logs reviewed; no unexplained warnings or errors.
  • Full CI has been run.

Scope and size

  • PR is under ~1000 lines, or an exception is justified in the description.
  • Refactoring-only changes are isolated in their own PR(s).
  • No existing tests were disabled or modified just to make this PR pass
    (if so, an issue has been raised).

Tests

  • New functionality has new tests: Docs/example-only PR; runtime functionality is covered by Support Stim DEM strings in get_decoder #571 tests.
  • Tests fail if the new functionality is broken (including crashes), not
    just when it is missing: N/A, no runtime behavior added.
  • Negative tests added where exceptions are expected: N/A
  • Truth data added where simple EXPECT_* / assert checks are
    insufficient for algorithmic correctness: N/A
  • CI runtime impact considered; team notified if significant.

Documentation

  • Public-facing APIs have Doxygen docs.
  • User-visible behavior changes have public docs, or a follow-up is
    tracked.

Code style

  • Naming follows the existing convention (snake_case vs camelCase) for
    the area being modified.

Dependencies

  • No new third-party dependencies, or the team has been notified and
    OSRB tickets filed.

Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
@vedika-saravanan vedika-saravanan self-assigned this Jun 9, 2026
@vedika-saravanan vedika-saravanan marked this pull request as ready for review June 9, 2026 18:21
@vedika-saravanan vedika-saravanan marked this pull request as draft June 9, 2026 18:23
Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
@vedika-saravanan vedika-saravanan marked this pull request as ready for review June 9, 2026 18:37
@vedika-saravanan vedika-saravanan merged commit 94fdeb8 into NVIDIA:main Jun 10, 2026
20 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.

Add docs and examples for decoder construction from Stim DEM strings

2 participants