Document native batch and parallel decoding in the Guppy DEM workflow - #526
Open
ciaranra wants to merge 1 commit into
Open
Document native batch and parallel decoding in the Guppy DEM workflow#526ciaranra wants to merge 1 commit into
ciaranra wants to merge 1 commit into
Conversation
…he Guppy DEM workflow
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Guppy DEM decoding workflow doc previously showed per-shot Python decode loops and mentioned
decode_countin one sentence. This adds a section on the nativeSampleBatchdecode paths:decode_count,decode_count_parallel, anddecode_count_batch, with guidance on when each pays off."pymatching"-is-correlated vsPyMatchingDecoder.from_dem-is-uncorrelated distinction (the executable blocks use"pymatching_uncorrelated"so their equality assertions against the hand-built loop are exact).evaluate_result_columns()in aSampleBatchso stage 4b shots ride the same native parallel path.decode_stats_parallelfor latency quantiles.All new code blocks are tested: the doc-test suite (
just docs-test) passes with the generated workflow test running all 11 blocks, and the equality assertions between the native paths and the hand-written loops execute as part of it.Verification
just docs-test: 288 passed, 12 skipped (includes the 11 generated blocks for this doc).just lint: clean, no formatter rewrites.