Better default arguments for Tesseract config

Author: draganaurosgrbic

src/py/tesseract_test.py

@@ -49,7 +49,7 @@ def test_create_node():
 def test_create_tesseract_config():
     assert (
         str(tesseract_decoder.tesseract.TesseractConfig(_DETECTOR_ERROR_MODEL))
-        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=65535, no_revisit_dets=0, at_most_two_errors_per_detector=0, verbose=0, merge_errors=1, pqlimit=18446744073709551615, det_orders=[], det_penalty=0, create_visualization=0)"
+        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=5, no_revisit_dets=1, at_most_two_errors_per_detector=0, verbose=0, merge_errors=1, pqlimit=200000, det_orders=[[1, 0], [0, 1], [1, 0], [0, 1], [1, 0], [0, 1], [1, 0], [1, 0], [0, 1], [1, 0], [1, 0], [1, 0], [0, 1], [0, 1], [0, 1], [1, 0], [0, 1], [0, 1], [1, 0], [1, 0]], det_penalty=0, create_visualization=0)"
     )
     assert (
         tesseract_decoder.tesseract.TesseractConfig(_DETECTOR_ERROR_MODEL).dem
@@ -66,7 +66,7 @@ def test_create_tesseract_config_with_dem():
     # Assert the string representation matches the expected format.
     assert (
         str(config)
-        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=65535, no_revisit_dets=0, at_most_two_errors_per_detector=0, verbose=0, merge_errors=1, pqlimit=18446744073709551615, det_orders=[], det_penalty=0, create_visualization=0)"
+        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=5, no_revisit_dets=1, at_most_two_errors_per_detector=0, verbose=0, merge_errors=1, pqlimit=200000, det_orders=[[1, 0], [0, 1], [1, 0], [0, 1], [1, 0], [0, 1], [1, 0], [1, 0], [0, 1], [1, 0], [1, 0], [1, 0], [0, 1], [0, 1], [0, 1], [1, 0], [0, 1], [0, 1], [1, 0], [1, 0]], det_penalty=0, create_visualization=0)"
     )
 
     # Assert that the `dem` attribute is correctly set.
@@ -93,7 +93,7 @@ def test_create_tesseract_config_with_dem_and_custom_args():
     # Assert the string representation is as expected.
     assert (
         str(config)
-        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=100, no_revisit_dets=0, at_most_two_errors_per_detector=0, verbose=0, merge_errors=0, pqlimit=18446744073709551615, det_orders=[], det_penalty=0.5, create_visualization=0)"
+        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=100, no_revisit_dets=1, at_most_two_errors_per_detector=0, verbose=0, merge_errors=0, pqlimit=200000, det_orders=[[1, 0], [0, 1], [1, 0], [0, 1], [1, 0], [0, 1], [1, 0], [1, 0], [0, 1], [1, 0], [1, 0], [1, 0], [0, 1], [0, 1], [0, 1], [1, 0], [0, 1], [0, 1], [1, 0], [1, 0]], det_penalty=0.5, create_visualization=0)"
     )
 
 def test_compile_decoder_for_dem_basic_functionality():
@@ -164,7 +164,7 @@ def test_create_tesseract_config_no_dem():
     # Assert that the string representation shows the default values.
     assert (
         str(config_default)
-        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=65535, no_revisit_dets=0, at_most_two_errors_per_detector=0, verbose=0, merge_errors=1, pqlimit=18446744073709551615, det_orders=[], det_penalty=0, create_visualization=0)"
+        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=5, no_revisit_dets=1, at_most_two_errors_per_detector=0, verbose=0, merge_errors=1, pqlimit=200000, det_orders=[], det_penalty=0, create_visualization=0)"
     )
 
 def test_create_tesseract_config_no_dem_with_custom_args():
@@ -184,7 +184,7 @@ def test_create_tesseract_config_no_dem_with_custom_args():
     # Assert that the string representation reflects the custom values.
     assert (
         str(config_custom)
-        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=15, no_revisit_dets=0, at_most_two_errors_per_detector=0, verbose=1, merge_errors=1, pqlimit=18446744073709551615, det_orders=[], det_penalty=0, create_visualization=0)"
+        == "TesseractConfig(dem=DetectorErrorModel_Object, det_beam=15, no_revisit_dets=1, at_most_two_errors_per_detector=0, verbose=1, merge_errors=1, pqlimit=200000, det_orders=[[], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], []], det_penalty=0, create_visualization=0)"
     )
 
 

src/tesseract.h

@@ -28,16 +28,18 @@
 #include "visualization.h"
 
 constexpr size_t INF_DET_BEAM = std::numeric_limits<uint16_t>::max();
+constexpr int DEFAULT_DET_BEAM = 5;
+constexpr size_t DEFAULT_PQLIMIT = 200000;
 
 struct TesseractConfig {
   stim::DetectorErrorModel dem;
-  int det_beam = INF_DET_BEAM;
+  int det_beam = DEFAULT_DET_BEAM;
   bool beam_climbing = false;
-  bool no_revisit_dets = false;
+  bool no_revisit_dets = true;
   bool at_most_two_errors_per_detector = false;
   bool verbose = false;
   bool merge_errors = true;
-  size_t pqlimit = std::numeric_limits<size_t>::max();
+  size_t pqlimit = DEFAULT_PQLIMIT;
   std::vector<std::vector<size_t>> det_orders;
   double det_penalty = 0;
   bool create_visualization = false;

src/tesseract.pybind.h

@@ -23,6 +23,7 @@
 
 #include "stim_utils.pybind.h"
 #include "tesseract.h"
+#include "utils.h"
 
 namespace py = pybind11;
 
@@ -32,30 +33,35 @@ std::unique_ptr<TesseractDecoder> _compile_tesseract_decoder_helper(const Tesser
   return std::make_unique<TesseractDecoder>(self);
 }
 
-TesseractConfig tesseract_config_maker_no_dem(
-    int det_beam = INF_DET_BEAM, bool beam_climbing = false, bool no_revisit_dets = false,
-    bool at_most_two_errors_per_detector = false, bool verbose = false, bool merge_errors = true,
-    size_t pqlimit = std::numeric_limits<size_t>::max(),
-    std::vector<std::vector<size_t>> det_orders = std::vector<std::vector<size_t>>(),
-    double det_penalty = 0.0, bool create_visualization = false) {
+TesseractConfig tesseract_config_maker_no_dem(int det_beam, bool beam_climbing,
+                                              bool no_revisit_dets,
+                                              bool at_most_two_errors_per_detector, bool verbose,
+                                              bool merge_errors, size_t pqlimit,
+                                              std::vector<std::vector<size_t>> det_orders,
+                                              double det_penalty, bool create_visualization) {
   stim::DetectorErrorModel empty_dem;
+  if (det_orders.empty()) {
+    det_orders = build_det_orders(empty_dem, 20, true, 2384753);
+  }
   return TesseractConfig({empty_dem, det_beam, beam_climbing, no_revisit_dets,
                           at_most_two_errors_per_detector, verbose, merge_errors, pqlimit,
                           det_orders, det_penalty, create_visualization});
 }
 
-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,
-    bool verbose = false, bool merge_errors = true,
-    size_t pqlimit = std::numeric_limits<size_t>::max(),
-    std::vector<std::vector<size_t>> det_orders = std::vector<std::vector<size_t>>(),
-    double det_penalty = 0.0, bool create_visualization = false) {
-  stim::DetectorErrorModel input_dem = parse_py_object<stim::DetectorErrorModel>(dem);
+TesseractConfig tesseract_config_maker(py::object dem_obj, int det_beam, bool beam_climbing,
+                                       bool no_revisit_dets, bool at_most_two_errors_per_detector,
+                                       bool verbose, bool merge_errors, size_t pqlimit,
+                                       std::vector<std::vector<size_t>> det_orders,
+                                       double det_penalty, bool create_visualization) {
+  stim::DetectorErrorModel input_dem = parse_py_object<stim::DetectorErrorModel>(dem_obj);
+  if (det_orders.empty()) {
+    det_orders = build_det_orders(input_dem, 20, true, 2384753);
+  }
   return TesseractConfig({input_dem, det_beam, beam_climbing, no_revisit_dets,
                           at_most_two_errors_per_detector, verbose, merge_errors, pqlimit,
                           det_orders, det_penalty, create_visualization});
 }
+
 };  // namespace
 void add_tesseract_module(py::module& root) {
   auto m = root.def_submodule("tesseract", "Module containing the tesseract algorithm");
@@ -73,10 +79,10 @@ void add_tesseract_module(py::module& root) {
         Default constructor for TesseractConfig.
         Creates a new instance with default parameter values.
     )pbdoc")
-      .def(py::init(&tesseract_config_maker_no_dem), py::arg("det_beam") = INF_DET_BEAM,
-           py::arg("beam_climbing") = false, py::arg("no_revisit_dets") = false,
+      .def(py::init(&tesseract_config_maker_no_dem), py::arg("det_beam") = 5,
+           py::arg("beam_climbing") = false, py::arg("no_revisit_dets") = true,
            py::arg("at_most_two_errors_per_detector") = false, py::arg("verbose") = false,
-           py::arg("merge_errors") = true, py::arg("pqlimit") = std::numeric_limits<size_t>::max(),
+           py::arg("merge_errors") = true, py::arg("pqlimit") = 200000,
            py::arg("det_orders") = std::vector<std::vector<size_t>>(), py::arg("det_penalty") = 0.0,
            py::arg("create_visualization") = false,
            R"pbdoc(
@@ -108,10 +114,10 @@ void add_tesseract_module(py::module& root) {
               create_visualization: bool, defualt=False
                  Whether to record the information needed to create a visualization or not.
              )pbdoc")
-      .def(py::init(&tesseract_config_maker), py::arg("dem"), py::arg("det_beam") = INF_DET_BEAM,
-           py::arg("beam_climbing") = false, py::arg("no_revisit_dets") = false,
+      .def(py::init(&tesseract_config_maker), py::arg("dem"), py::arg("det_beam") = 5,
+           py::arg("beam_climbing") = false, py::arg("no_revisit_dets") = true,
            py::arg("at_most_two_errors_per_detector") = false, py::arg("verbose") = false,
-           py::arg("merge_errors") = true, py::arg("pqlimit") = std::numeric_limits<size_t>::max(),
+           py::arg("merge_errors") = true, py::arg("pqlimit") = 200000,
            py::arg("det_orders") = std::vector<std::vector<size_t>>(), py::arg("det_penalty") = 0.0,
            py::arg("create_visualization") = false,
            R"pbdoc(