fix: clarify factory optimizations

zapatacomputing · May 1, 2024 · 433143e · 433143e
1 parent 31f6436
commit 433143e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/benchq/magic_state_distillation/litinski_factories.py b/src/benchq/magic_state_distillation/litinski_factories.py
@@ -71,6 +71,10 @@
 def iter_litinski_factories(
     architecture_model: BasicArchitectureModel,
 ) -> Iterable[MagicStateFactory]:
+    """
+    An iterator which yields magic state factories which are optimized in order
+    to minimize the space time volume.
+    """
     assert architecture_model.physical_qubit_error_rate in _ALLOWED_PHYSICAL_ERROR_RATES
 
     return _ERROR_RATE_FACTORY_MAPPING[architecture_model.physical_qubit_error_rate]
diff --git a/src/benchq/magic_state_distillation/small_footprint_factories.py b/src/benchq/magic_state_distillation/small_footprint_factories.py
@@ -69,6 +69,11 @@
 def iter_small_footprint_factories(
     architecture_model: BasicArchitectureModel,
 ) -> Iterable[MagicStateFactory]:
+    """
+    An iterator which yields magic state factories which are optimized in order
+    to minimize the number of physical qubits.
+    """
+
     assert architecture_model.physical_qubit_error_rate in _ALLOWED_PHYSICAL_ERROR_RATES
 
     return _ERROR_RATE_FACTORY_MAPPING[architecture_model.physical_qubit_error_rate]