docs(qec): update trt_decoder documentation for recent enhancements#408
Open
wsttiger wants to merge 2 commits intoNVIDIA:mainfrom
Open
docs(qec): update trt_decoder documentation for recent enhancements#408wsttiger wants to merge 2 commits intoNVIDIA:mainfrom
wsttiger wants to merge 2 commits intoNVIDIA:mainfrom
Conversation
Update TRT decoder documentation to reflect features introduced in commits eff6966, 2954c01, and 49bdde8, bringing it inline with other QEC decoder documentation. Key additions: 1. CUDA Graph Optimization (commit 2954c01): - Document new `use_cuda_graph` parameter (default: True) - Note ~20% performance improvement from CUDA graph optimization - Explain automatic fallback for models with dynamic shapes 2. Batch Processing Support (commit eff6966): - Document automatic batch size detection - Explain zero-padding behavior for single syndrome decode() - Clarify decode_batch() requirements for batch-size multiples 3. Real-Time Decoding Integration (commit 49bdde8): - Add comprehensive trt_decoder_config documentation - Include Python and C++ examples for real-time configuration - Document YAML serialization support - Add configuration reference in python_realtime_decoding_api.rst 4. Documentation Structure Improvements: - Add performance characteristics section - Add batch processing notes - Include cross-references to real-time decoding examples - Maintain consistency with nv-qldpc and sliding_window decoder docs Files changed: - docs/sphinx/api/qec/trt_decoder_api.rst: Added parameters, real-time config section, and performance notes - docs/sphinx/api/qec/python_realtime_decoding_api.rst: Added trt_decoder_config class documentation - docs/sphinx/examples_rst/qec/realtime_decoding.rst: Added TRT decoder to decoder selection section Signed-off-by: Scott Thornton <sthornton@nvidia.com>
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.
Update TRT decoder documentation to reflect features introduced in commits eff6966, 2954c01, and 49bdde8, bringing it inline with other QEC decoder documentation.
Key additions:
CUDA Graph Optimization (commit 2954c01):
use_cuda_graphparameter (default: True)Batch Processing Support (commit eff6966):
Real-Time Decoding Integration (commit 49bdde8):
Documentation Structure Improvements:
Files changed: