#613: Replace Tempered criterion with TemperedWithUpdates implementation and deprecate the latter

README.md

@@ -26,7 +26,7 @@ _Please refer to our [documentation](https://darma-tasking.github.io/lbaf_docs/i
 
 ## Getting Started
 
-LBAF currently supports Python 3.8 - 3.11. You can download Python [here](https://www.python.org/downloads/).
+LBAF currently supports Python 3.9 - 3.11. You can download Python [here](https://www.python.org/downloads/).
 
 ### Optional: Create a virtual environment *(recommended in development)*
 
@@ -37,7 +37,7 @@ source venv/bin/activate
 ```
 
 > [!NOTE]
-> You can create separate virtual environments for different development branches. For example, a Python 3.8 environment for branch 125 could be named `venv38-branch-125`. Within this environment, you can install `lbaf` as an editable package (see below).
+> You can create separate virtual environments for different development branches. For example, a Python 3.9 environment for branch 125 could be named `venv38-branch-125`. Within this environment, you can install `lbaf` as an editable package (see below).
 
 ## Installation
 

config/synthetic-blocks.yaml

@@ -27,7 +27,7 @@ algorithm:
     order_strategy: arbitrary
     transfer_strategy: Clustering
     max_subclusters: 4
-    criterion: TemperedWithUpdates
+    criterion: Tempered
     max_objects_per_transfer: 8
     deterministic_transfer: true
 

src/lbaf/Execution/lbsCriterionBase.py

@@ -89,11 +89,8 @@ def factory(criterion_name: str, work_model: WorkModelBase, logger: Logger):
         """Produce the necessary concrete criterion."""
 
         # Load up available criteria
-        # pylint:disable=W0641:possibly-unused-variable,C0415:import-outside-toplevel
         from .lbsTemperedCriterion import TemperedCriterion
-        from .lbsTemperedWithUpdatesCriterion import TemperedWithUpdatesCriterion
         from .lbsStrictLocalizingCriterion import StrictLocalizingCriterion
-        # pylint:enable=W0641:possibly-unused-variable,C0415:import-outside-toplevel
 
         # Ensure that criterion name is valid
         try:

src/lbaf/Execution/lbsTemperedCriterion.py

@@ -48,7 +48,7 @@
 
 
 class TemperedCriterion(CriterionBase):
-    """A concrete class for the Grapevine criterion modified in line 6."""
+    """A concrete class for the Grapevine criterion with update formulae."""
 
     def __init__(self, work_model, lgr: Logger):
         """Class constructor."""
@@ -57,7 +57,7 @@ def __init__(self, work_model, lgr: Logger):
         self._logger.info(f"Instantiated {type(self).__name__} concrete criterion")
 
     def compute(self, r_src: Rank, o_src: list, r_dst: Rank, o_dst: Optional[list]=None) -> float:
-        """Tempered work criterion based on L1 norm of works."""
+        """Tempered work criterion based on L1 norm of works using update formulae."""
         if o_dst is None:
             o_dst = []
 
@@ -66,16 +66,10 @@ def compute(self, r_src: Rank, o_src: list, r_dst: Rank, o_dst: Optional[list]=N
             self._work_model.compute(r_src),
             self._work_model.compute(r_dst))
 
-        # Move objects into proposed new arrangement
-        self._phase.transfer_objects(r_src, o_src, r_dst, o_dst)
-
-        # Compute maximum work of proposed new arrangement
+        # Compute update formulae
         w_max_new = max(
-            self._work_model.compute(r_src),
-            self._work_model.compute(r_dst))
-
-        # Move objects back into original arrangement
-        self._phase.transfer_objects(r_dst, o_src, r_src, o_dst)
+            self._work_model.update(r_src, o_src, o_dst),
+            self._work_model.update(r_dst, o_dst, o_src))
 
         # Return criterion value
         return w_max_0 - w_max_new

src/lbaf/IO/lbsConfigurationValidator.py

@@ -67,7 +67,7 @@
     "CentralizedPrefixOptimizer",
     "PrescribedPermutation",
     "PhaseStepper")
-ALLOWED_CRITERIA = ("Tempered", "TemperedWithUpdates", "StrictLocalizing")
+ALLOWED_CRITERIA = ("Tempered", "StrictLocalizing")
 ALLOWED_LOGGING_LEVELS = ("info", "debug", "warning", "error")
 ALLOWED_LOAD_VOLUME_SAMPLER = ("uniform", "lognormal")
 

src/lbaf/Model/lbsAffineCombinationWorkModel.py

@@ -231,9 +231,9 @@ def __update_homing(self, rank: Rank, o_snd: list, o_rcv: list):
             # Remove object from rank
             r_obj.discard(o)
 
-            # Skip locally homed blocks
+            # Retrieve shared block and skip if none or not locally homed
             b = o.get_shared_block()
-            if b.get_home_id() == r_id:
+            if b is None or b.get_home_id() == r_id:
                 continue
 
             # Determine set of removed non-homed blocks
@@ -249,9 +249,9 @@ def __update_homing(self, rank: Rank, o_snd: list, o_rcv: list):
 
         # Iterate over all received objects
         for o in o_rcv:
-            # Skip locally homed blocks
+            # Retrieve shared block and skip if none or not locally homed
             b = o.get_shared_block()
-            if b.get_home_id() == r_id:
+            if b is None or b.get_home_id() == r_id:
                 continue
 
             # Determine set of added non-homed blocks