rename pymatching decoder

qiskit-community · Feb 6, 2024 · 84117f0 · 84117f0
1 parent 2b02846
commit 84117f0
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/src/qiskit_qec/decoders/__init__.py b/src/qiskit_qec/decoders/__init__.py
@@ -28,5 +28,5 @@
 """
 
 from .decoding_graph import DecodingGraph
-from .pymatching_decoder import PyMatching
+from .pymatching_decoder import PyMatchingDecoder
 from .hdrg_decoders import BravyiHaahDecoder, UnionFindDecoder
diff --git a/src/qiskit_qec/decoders/pymatching_decoder.py b/src/qiskit_qec/decoders/pymatching_decoder.py
@@ -21,7 +21,7 @@
 from qiskit_qec.utils import DecodingGraphNode, DecodingGraphEdge
 
 
-class PyMatching:
+class PyMatchingDecoder:
     """
     Matching decoder using PyMatching.
     """

diff --git a/test/matching/test_matching.py b/test/matching/test_matching.py
@@ -21,7 +21,7 @@
 from random import choices
 
 from qiskit_qec.circuits import ArcCircuit, RepetitionCodeCircuit
-from qiskit_qec.decoders import PyMatching
+from qiskit_qec.decoders import PyMatchingDecoder
 from qiskit_qec.codes.hhc import HHC
 from qiskit_qec.circuits.css_code import CSSCodeCircuit
 from qiskit_qec.utils.stim_tools import get_counts_via_stim
@@ -46,7 +46,7 @@ def test_repetition_codes(self, code):
             ArcCircuit([(2 * j, 2 * j + 1, (2 * (j + 1)) % (2 * d - 2)) for j in range(d - 1)], 1)
         )
         for c, code in enumerate(codes):
-            matcher = PyMatching(code)
+            matcher = PyMatchingDecoder(code)
             min_error_num = code.d
             min_error_string = ""
             for _ in range(N):
@@ -87,7 +87,7 @@ def test_css_codes(self, code):
 
         codes = [CSSCodeCircuit(HHC(d), T=1, basis="x", noise_model=(p, p))]
         for c, code in enumerate(codes):
-            matcher = PyMatching(code)
+            matcher = PyMatchingDecoder(code)
             stim_counts = get_counts_via_stim(code.noisy_circuit["1"], N)
             errors = 0
             for string in stim_counts: