Compile detector method inside Simplex and Tesseract decoder (#76)

Address issue #75

Author: draganaurosgrbic

src/py/shared_decoding_tests.py

@@ -202,3 +202,17 @@ def shared_test_decode_from_detection_events(decoder_class, config_class):
     assert isinstance(predicted3, np.ndarray)
     assert predicted3.dtype.type == np.bool_
     assert np.array_equal(predicted3, np.array([False], dtype=bool))
+
+def shared_test_compile_decoder(config_class, decoder_class):
+    """
+    Tests the `compile_decoder` method on a config class.
+    """
+    dem_string = "error(0.1) D0 D1 L0"
+    dem = stim.DetectorErrorModel(dem_string)
+    config = config_class(dem)
+    
+    decoder = config.compile_decoder()
+    
+    assert isinstance(decoder, decoder_class)
+    assert decoder.config.dem == config.dem
+    assert decoder.num_observables == dem.num_observables

src/py/simplex_test.py

@@ -26,6 +26,7 @@
     shared_test_decode_complex_dem,
     shared_test_decode_batch,
     shared_test_decode_from_detection_events,
+    shared_test_compile_decoder,
 )
 
 _DETECTOR_ERROR_MODEL = stim.DetectorErrorModel(
@@ -55,6 +56,14 @@ def test_create_simplex_decoder():
     assert decoder.get_observables_from_errors([1]) == []
     assert decoder.cost_from_errors([2]) == pytest.approx(1.0986123)
 
+@pytest.mark.parametrize(
+    "config_class, decoder_class",
+    [(tesseract_decoder.simplex.SimplexConfig, tesseract_decoder.simplex.SimplexDecoder)]
+)
+def test_simplex_compile_decoder(config_class, decoder_class):
+    shared_test_compile_decoder(config_class, decoder_class)
+
+
 @pytest.mark.parametrize(
     "decoder_class, config_class",
     [(tesseract_decoder.simplex.SimplexDecoder, tesseract_decoder.simplex.SimplexConfig)]

src/py/tesseract_test.py

@@ -26,6 +26,7 @@
     shared_test_decode_complex_dem,
     shared_test_decode_batch,
     shared_test_decode_from_detection_events,
+    shared_test_compile_decoder,
 )
 
 _DETECTOR_ERROR_MODEL = stim.DetectorErrorModel(
@@ -61,6 +62,13 @@ def test_create_decoder():
     assert decoder.get_observables_from_errors([1]) == []
     assert decoder.cost_from_errors([1]) == pytest.approx(0.5108256237659907)
 
+@pytest.mark.parametrize(
+    "config_class, decoder_class",
+    [(tesseract_decoder.tesseract.TesseractConfig, tesseract_decoder.tesseract.TesseractDecoder)]
+)
+def test_tesseract_compile_decoder(config_class, decoder_class):
+    shared_test_compile_decoder(config_class, decoder_class)
+
 @pytest.mark.parametrize(
     "decoder_class, config_class",
     [(tesseract_decoder.tesseract.TesseractDecoder, tesseract_decoder.tesseract.TesseractConfig)]

src/simplex.pybind.h

@@ -28,6 +28,11 @@
 namespace py = pybind11;
 
 namespace {
+// Helper function to compile the decoder.
+std::unique_ptr<SimplexDecoder> _compile_simplex_decoder_helper(const SimplexConfig& self) {
+  return std::make_unique<SimplexDecoder>(self);
+}
+
 SimplexConfig simplex_config_maker(py::object dem, bool parallelize = false,
                                    size_t window_length = 0, size_t window_slide_length = 0,
                                    bool verbose = false) {
@@ -51,7 +56,17 @@ void add_simplex_module(py::module& root) {
       .def_readwrite("window_slide_length", &SimplexConfig::window_slide_length)
       .def_readwrite("verbose", &SimplexConfig::verbose)
       .def("windowing_enabled", &SimplexConfig::windowing_enabled)
-      .def("__str__", &SimplexConfig::str);
+      .def("__str__", &SimplexConfig::str)
+      .def("compile_decoder", &_compile_simplex_decoder_helper,
+           py::return_value_policy::take_ownership, R"pbdoc(
+          Compiles the configuration into a new SimplexDecoder instance.
+
+          Returns
+          -------
+          SimplexDecoder
+              A new SimplexDecoder instance configured with the current
+              settings.
+      )pbdoc");
 
   py::class_<SimplexDecoder>(m, "SimplexDecoder")
       .def(py::init<SimplexConfig>(), py::arg("config"))

src/tesseract.pybind.h

@@ -27,6 +27,11 @@
 namespace py = pybind11;
 
 namespace {
+// Helper function to compile the decoder.
+std::unique_ptr<TesseractDecoder> _compile_tesseract_decoder_helper(const TesseractConfig& self) {
+  return std::make_unique<TesseractDecoder>(self);
+}
+
 TesseractConfig tesseract_config_maker(
     py::object dem, int det_beam = INF_DET_BEAM, bool beam_climbing = false,
     bool no_revisit_dets = false, bool at_most_two_errors_per_detector = false,
@@ -58,7 +63,18 @@ void add_tesseract_module(py::module& root) {
       .def_readwrite("pqlimit", &TesseractConfig::pqlimit)
       .def_readwrite("det_orders", &TesseractConfig::det_orders)
       .def_readwrite("det_penalty", &TesseractConfig::det_penalty)
-      .def("__str__", &TesseractConfig::str);
+      .def("__str__", &TesseractConfig::str)
+      .def("compile_decoder", &_compile_tesseract_decoder_helper,
+           py::return_value_policy::take_ownership,
+           R"pbdoc(
+          Compiles the configuration into a new `TesseractDecoder` instance.
+
+          Returns
+          -------
+          TesseractDecoder
+              A new `TesseractDecoder` instance configured with the current
+              settings.
+      )pbdoc");
 
   py::class_<Node>(m, "Node")
       .def(py::init<double, size_t, std::vector<size_t>>(), py::arg("cost") = 0.0,
@@ -225,7 +241,9 @@ void add_tesseract_module(py::module& root) {
     )pbdoc")
       .def_readwrite("low_confidence_flag", &TesseractDecoder::low_confidence_flag)
       .def_readwrite("predicted_errors_buffer", &TesseractDecoder::predicted_errors_buffer)
-      .def_readwrite("errors", &TesseractDecoder::errors);
+      .def_readwrite("errors", &TesseractDecoder::errors)
+      .def_readwrite("config", &TesseractDecoder::config)
+      .def_readwrite("num_observables", &TesseractDecoder::num_observables);
 }
 
 #endif