You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/GuillaumeLessard/qector-decoder/commits/main)
Copy file name to clipboardExpand all lines: docs/API_STABILITY.md
+84-27Lines changed: 84 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,17 @@
1
-
# QECTOR API Stability Guide
1
+
# QECTOR API Stability Guide — v0.5.7
2
2
3
-
QECTOR Decoder v3 is a source-available research and commercial-evaluation platform. This file separates the APIs that are intended to be stable for normal local use from experimental surfaces that require extra caution.
3
+
QECTOR Decoder v3 is a source-available research and commercial-evaluation platform.
4
+
This file separates the APIs that are stable for normal local use from experimental
5
+
surfaces that require extra caution.
4
6
5
7
## Stability levels
6
8
7
9
| Level | Meaning | Examples |
8
10
|---|---|---|
9
-
| Stable local API | Expected to remain usable across compatible `0.5.x` releases, with bug-fix-level changes only | Core Python decoders, code generators, local source build, benchmark artifact format basics|
11
+
| Stable local API | Expected to remain usable across compatible `0.5.x` releases with bug-fix-level changes only | Core Python decoders, code generators, local source build, benchmark artifact format |
10
12
| Supported but workload-sensitive | Supported, but claims must be regenerated for the local code family, hardware, batch size, and dependency set | Stim/PyMatching comparisons, BP-OSD/LDPC experiments, CPU/GPU batch workflows |
11
-
| Experimental / preview | Available for research, demos, or partner review, but not a compatibility promise | REST service, gRPC, MCP, metrics, hybrid/GNN paths, hosted API, OEM embedding |
12
-
| Internal implementation detail | May change without notice | Rust module internals, fallback heuristics, private helper functions, benchmark script internals not documented here|
13
+
| Experimental / preview | Available for research, demos, or partner review but not a compatibility promise | REST service, gRPC, MCP, metrics, hybrid/GNN paths, hosted API, OEM embedding |
14
+
| Internal implementation detail | May change without notice | Rust module internals, fallback heuristics, private helper functions |
0 commit comments