sinter 1.15.dev1743871966__tar.gz → 1.15.dev1743880617__tar.gz

{sinter-1.15.dev1743871966/src/sinter.egg-info → sinter-1.15.dev1743880617}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sinter
-Version: 1.15.dev1743871966
+Version: 1.15.dev1743880617
 Summary: Samples stim circuits and decodes them using pymatching.
 Author: Craig Gidney
 Author-email: craig.gidney@gmail.com

{sinter-1.15.dev1743871966 → sinter-1.15.dev1743880617}/setup.py

@@ -19,7 +19,7 @@ with open('README.md', encoding='UTF-8') as f:
 with open('requirements.txt', encoding='UTF-8') as f:
     requirements = f.read().splitlines()
 
-__version__ = '1.15.dev1743871966'
+__version__ = '1.15.dev1743880617'
 
 setup(
     name='sinter',

{sinter-1.15.dev1743871966 → sinter-1.15.dev1743880617}/src/sinter/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.15.dev1743871966'
+__version__ = '1.15.dev1743880617'
 
 from sinter._collection import (
     collect,

{sinter-1.15.dev1743871966 → sinter-1.15.dev1743880617}/src/sinter/_collection/_collection_worker_test.py

@@ -163,7 +163,15 @@ def test_worker_finish_work():
     handler.expected_task = ta
     _put_wait_not_empty(inp, ('change_job', (ta, sinter.CollectionOptions(max_errors=100_000_000), 100_000_000)))
     _put_wait_not_empty(inp, ('accept_shots', (ta.strong_id(), 10000)))
-    assert worker.process_messages() == 2
+    t0 = time.monotonic()
+    num_processed = 0
+    while True:
+        num_processed += worker.process_messages()
+        if num_processed >= 2:
+            break
+        if time.monotonic() - t0 > 1:
+            raise ValueError("Messages not processed")
+    assert num_processed == 2
     _assert_drain_queue(out, [
         ('changed_job', 5, (ta.strong_id(),)),
         ('accepted_shots', 5, (ta.strong_id(), 10000)),

{sinter-1.15.dev1743871966 → sinter-1.15.dev1743880617}/src/sinter/_decoding/_decoding_decoder_class.py

@@ -55,7 +55,7 @@ class CompiledDecoder(metaclass=abc.ABCMeta):
         pass
 
 
-class Decoder(metaclass=abc.ABCMeta):
+class Decoder:
     """Abstract base class for custom decoders.
 
     Custom decoders can be explained to sinter by inheriting from this class and
@@ -63,6 +63,10 @@ class Decoder(metaclass=abc.ABCMeta):
 
     Decoder classes MUST be serializable (e.g. via pickling), so that they can
     be given to worker processes when using python multiprocessing.
+
+    Child classes should implement `compile_decoder_for_dem`, but (for legacy
+    reasons) can alternatively implement `decode_via_files`. At least one of
+    the two methods must be implemented.
     """
 
     def compile_decoder_for_dem(
@@ -95,7 +99,6 @@ class Decoder(metaclass=abc.ABCMeta):
         """
         raise NotImplementedError('compile_decoder_for_dem')
 
-    @abc.abstractmethod
     def decode_via_files(self,
                          *,
                          num_shots: int,
@@ -141,4 +144,18 @@ class Decoder(metaclass=abc.ABCMeta):
                 temporary objects. All cleanup should be done via sinter
                 deleting this directory after killing the decoder.
         """
-        pass
+        dem = stim.DetectorErrorModel.from_file(dem_path)
+
+        try:
+            compiled = self.compile_decoder_for_dem(dem=dem)
+        except NotImplementedError as ex:
+            raise NotImplementedError(f"{type(self).__qualname__} didn't implement `compile_decoder_for_dem` or `decode_via_files`.") from ex
+
+        num_det_bytes = -(-num_dets // 8)
+        num_obs_bytes = -(-num_obs // 8)
+        dets = np.fromfile(dets_b8_in_path, dtype=np.uint8, count=num_shots * num_det_bytes)
+        dets = dets.reshape(num_shots, num_det_bytes)
+        obs = compiled.decode_shots_bit_packed(bit_packed_detection_event_data=dets)
+        if obs.dtype != np.uint8 or obs.shape != (num_shots, num_obs_bytes):
+            raise ValueError(f"Got a numpy array with dtype={obs.dtype},shape={obs.shape} instead of dtype={np.uint8},shape={(num_shots, num_obs_bytes)} from {type(self).__qualname__}(...).compile_decoder_for_dem(...).decode_shots_bit_packed(...).")
+        obs.tofile(obs_predictions_b8_out_path)

{sinter-1.15.dev1743871966 → sinter-1.15.dev1743880617}/src/sinter/_decoding/_decoding_test.py

@@ -10,6 +10,7 @@ import pytest
 import sinter
 import stim
 
+from sinter import CompiledDecoder
 from sinter._collection import post_selection_mask_from_4th_coord
 from sinter._decoding._decoding_all_built_in_decoders import BUILT_IN_DECODERS
 from sinter._decoding._decoding import sample_decode
@@ -391,3 +392,89 @@ def test_full_scale(decoder: str):
     assert result.discards == 0
     assert result.shots == 1000
     assert result.errors == 0
+
+
+def test_infer_decode_via_files_from_decode_from_compile_decoder_for_dem():
+    class IncompleteDecoder(sinter.Decoder):
+        pass
+
+    class WrongDecoder(sinter.Decoder, sinter.CompiledDecoder):
+        def compile_decoder_for_dem(
+                self,
+                *,
+                dem: stim.DetectorErrorModel,
+        ) -> CompiledDecoder:
+            return self
+        def decode_shots_bit_packed(
+                self,
+                *,
+                bit_packed_detection_event_data: np.ndarray,
+        ) -> np.ndarray:
+            return np.zeros(shape=5, dtype=np.bool_)
+
+    class TrivialCompiledDecoder(sinter.CompiledDecoder):
+        def __init__(self, num_obs: int):
+            self.num_obs = -(-num_obs // 8)
+
+        def decode_shots_bit_packed(
+                self,
+                *,
+                bit_packed_detection_event_data: np.ndarray,
+        ) -> np.ndarray:
+            return np.zeros(dtype=np.uint8, shape=(bit_packed_detection_event_data.shape[0], self.num_obs))
+
+    class TrivialDecoder(sinter.Decoder):
+        def compile_decoder_for_dem(
+            self,
+            *,
+            dem: stim.DetectorErrorModel,
+        ) -> CompiledDecoder:
+                return TrivialCompiledDecoder(num_obs=dem.num_observables)
+
+    circuit = stim.Circuit.generated("repetition_code:memory", distance=3, rounds=3)
+    dem = circuit.detector_error_model()
+
+    with tempfile.TemporaryDirectory() as d:
+        d = pathlib.Path(d)
+
+        circuit.compile_detector_sampler().sample_write(
+            shots=10,
+            filepath=d / 'dets.b8',
+            format='b8',
+        )
+
+        dem.to_file(d / 'dem.dem')
+
+        with pytest.raises(NotImplementedError, match='compile_decoder_for_dem'):
+            IncompleteDecoder().decode_via_files(
+                num_shots=10,
+                num_dets=dem.num_detectors,
+                num_obs=dem.num_observables,
+                dem_path=d / 'dem.dem',
+                dets_b8_in_path=d / 'dets.b8',
+                obs_predictions_b8_out_path=d / 'obs.b8',
+                tmp_dir=d,
+            )
+
+        with pytest.raises(ValueError, match='shape='):
+            WrongDecoder().decode_via_files(
+                num_shots=10,
+                num_dets=dem.num_detectors,
+                num_obs=dem.num_observables,
+                dem_path=d / 'dem.dem',
+                dets_b8_in_path=d / 'dets.b8',
+                obs_predictions_b8_out_path=d / 'obs.b8',
+                tmp_dir=d,
+            )
+
+        TrivialDecoder().decode_via_files(
+            num_shots=10,
+            num_dets=dem.num_detectors,
+            num_obs=dem.num_observables,
+            dem_path=d / 'dem.dem',
+            dets_b8_in_path=d / 'dets.b8',
+            obs_predictions_b8_out_path=d / 'obs.b8',
+            tmp_dir=d,
+        )
+        obs = np.fromfile(d / 'obs.b8', dtype=np.uint8, count=10)
+        np.testing.assert_array_equal(obs, [0] * 10)

{sinter-1.15.dev1743871966 → sinter-1.15.dev1743880617}/src/sinter/_decoding/_stim_then_decode_sampler.py

@@ -140,7 +140,7 @@ def _compile_decoder_with_disk_fallback(
 ) -> CompiledDecoder:
     try:
         return decoder.compile_decoder_for_dem(dem=task.detector_error_model)
-    except (NotImplementedError, ValueError):
+    except NotImplementedError:
         pass
     if tmp_dir is None:
         raise ValueError(f"Decoder {task.decoder=} didn't implement `compile_decoder_for_dem`, but no temporary directory was provided for falling back to `decode_via_files`.")

{sinter-1.15.dev1743871966 → sinter-1.15.dev1743880617/src/sinter.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sinter
-Version: 1.15.dev1743871966
+Version: 1.15.dev1743880617
 Summary: Samples stim circuits and decodes them using pymatching.
 Author: Craig Gidney
 Author-email: craig.gidney@gmail.com