Skip to content

docs(qec): tensor network noise-learning decoder docs#554

Draft
vedika-saravanan wants to merge 1 commit into
NVIDIA:mainfrom
vedika-saravanan:noise-learning-docs
Draft

docs(qec): tensor network noise-learning decoder docs#554
vedika-saravanan wants to merge 1 commit into
NVIDIA:mainfrom
vedika-saravanan:noise-learning-docs

Conversation

@vedika-saravanan

Copy link
Copy Markdown
Collaborator

Summary

  • Adds Sphinx API updates and decoder narrative docs for tensor-network noise-learning decoders.
  • Splits documentation out of the integration PR so code and docs can be reviewed and merged independently.

Related

Test plan

@vedika-saravanan vedika-saravanan marked this pull request as draft May 19, 2026 21:14
Adds Sphinx API narrative and decoder docs for noise-learning integration,
split from the integration PR for focused review.

Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
@NVIDIA NVIDIA deleted a comment from copy-pr-bot Bot May 19, 2026
vedika-saravanan added a commit that referenced this pull request May 26, 2026
…526)

## Summary

Productizes Nico's `NMOptimizer` into the TN decoder. Fits per-error
noise
probabilities by backpropagating through a torch-backed tensor-network
contraction.

> `oe_torch` / `oe_torch_compiled` contractors aren't included, unused
by `NMOptimizer`.

## What's in it

- `NMOptimizer` + `make_compiled_step`, exposed top-level via `from
cudaq_qec import NMOptimizer`
- Three execute modes (`codegen` / `unrolled` / `opt_einsum`); optional
`torch.compile`; prior auto-clamping
- Unit tests parameterised over `(cpu, cuda)` × execute modes, plus
`test_forward_parity_with_tn_decoder` against the base TN decoder
- Example (`tn_noise_learning.py`) runs in CI as the end-to-end LER gate

## Test plan

- [x] `pytest libs/qec/python/tests/test_nm_optimizer.py -v`
- [x] `pytest libs/qec/python/tests/test_tensor_network_decoder.py -v`
- [x] `python3 docs/sphinx/examples/qec/python/tn_noise_learning.py`


## Follow-ups


- cuTensorNet backend (currently forced to torch for autograd), unlocks
  larger code distances (d=5+ surface codes)
- KPI on real partner noise data
- Decoder-agnostic mixin (QLDPC)
- Docs: [#554](#554)

NVBug for new deps: https://nvbugspro.nvidia.com/bug/6177164

---------

Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
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.

1 participant