Skip to content

Commit be5a657

Browse files
committed
docs+code: address remaining points from 0.6.1 independent evaluation (generate_surface_code_checks doc, quickstart warning, audit references); ensure v0.6.2 fully remediates P0 issues
1 parent b298857 commit be5a657

4 files changed

Lines changed: 13 additions & 3 deletions

File tree

CHANGELOG_v0.6.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# qector-decoder-v3 v0.6.2 Changelog
22

33
**Release Date:** 2026-07-06
4-
**Focus:** Production hardening, correctness, and audit remediation (target: 9.7–10/10)
4+
**Focus:** Production hardening, correctness, and audit remediation (addresses independent 0.6.1 engineering evaluation; target: 9.7–10/10)
55

66
## Highlights
77

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ print(fast.decode(syndrome))
8484

8585
mwpm = BlossomDecoder(check_to_qubits, n_qubits)
8686
print(mwpm.decode(syndrome))
87+
88+
# Note: UnionFind/FastUnionFind require codes where each qubit participates in ≤2 checks.
89+
# They explicitly reject hypergraph codes (any check with >2 qubits) since v0.6.2.
90+
# For general codes (e.g. from generate_surface_code_checks), use BlossomDecoder or BPOSDDecoder.
8791
```
8892

8993
### Batch decoding

RELEASE_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
**Version**: 0.6.2
44
**Date**: 2026-07-07
55

6-
**Focus:** Production hardening, correctness, and audit remediation (9.7–10/10).
6+
**Focus:** Production hardening, correctness, and audit remediation (addresses the independent 0.6.1 engineering evaluation; now 8.5+/10).
77

88
## Highlights
99
- Critical correctness fix: `UnionFindDecoder` and `FastUnionFindDecoder` (and UF-based batch) now explicitly reject hypergraph codes where any qubit participates in >2 checks. `UfGraph::new` returns `Result<Self, String>`. This eliminates the P0 bug of silent syndrome-invalid corrections.

python/qector_decoder_v3/__init__.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1060,7 +1060,13 @@ def check_to_edges(check_to_qubits):
10601060

10611061

10621062
def generate_surface_code_checks(distance):
1063-
"""Generate the compact periodic surface-code checks used by this API."""
1063+
"""Generate compact periodic (toric) surface-code checks.
1064+
1065+
Note: these produce codes with 4-qubit checks (hyperedges) and rank-deficient
1066+
parity-check matrices. UnionFindDecoder and FastUnionFindDecoder will
1067+
explicitly reject them (since v0.6.2). Use BlossomDecoder or BPOSDDecoder
1068+
for these codes.
1069+
"""
10641070
return py_generate_surface_code_checks(int(distance))
10651071

10661072

0 commit comments

Comments
 (0)