Small refactorings to fix (sometimes) failing test

Author: david-chapela

poetry.lock

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "simod"
-version = "3.5.13"
+version = "3.5.14"
 authors = ["Manuel Camargo", "Ihar Suvorau", "David Chapela"]
 description = "Simod is a Python tool for automated discovery of business process simulation models from event logs."
 

pyproject.toml

@@ -8,14 +8,16 @@
 )
 from extraneous_activity_delays.enhance_with_delays import HyperOptEnhancer, DirectEnhancer
 from lxml import etree
+from pix_framework.filesystem.file_manager import remove_asset
 
+from simod.cli_formatter import print_step
 from simod.event_log.event_log import EventLog
 from simod.extraneous_delays.types import ExtraneousDelay
 from simod.settings.extraneous_delays_settings import ExtraneousDelaysSettings
 from simod.simulation.parameters.BPS_model import BPSModel
 
 
-class ExtraneousDelayTimersOptimizer:
+class ExtraneousDelaysOptimizer:
     def __init__(
         self,
         event_log: EventLog,
@@ -42,6 +44,7 @@ def run(self) -> List[ExtraneousDelay]:
             timer_placement=TimerPlacement.BEFORE,
             simulation_engine=SimulationEngine.PROSIMOS,
         )
+        configuration.PATH_OUTPUTS = self.base_directory
         # Discover extraneous delays
         simulation_model = _bps_model_to_simulation_model(self.bps_model)
         if self.settings.num_iterations > 1:
@@ -60,6 +63,10 @@ def run(self) -> List[ExtraneousDelay]:
             ) for activity in best_timers
         ]
 
+    def cleanup(self):
+        print_step(f"Removing {self.base_directory}")
+        remove_asset(self.base_directory)
+
 
 def _bps_model_to_simulation_model(bps_model: BPSModel) -> SimulationModel:
     parser = etree.XMLParser(remove_blank_text=True)

src/simod/extraneous_delays/optimizer.py

@@ -80,7 +80,7 @@ def default() -> "CommonSettings":
                 Metric.CIRCADIAN_EMD,
                 Metric.CYCLE_TIME_EMD,
             ],
-            clean_intermediate_files=False,
+            clean_intermediate_files=True,
         )
 
     @staticmethod

src/simod/settings/common_settings.py

@@ -26,7 +26,7 @@
     HyperoptIterationParams as ControlFlowHyperoptIterationParams,
 )
 from simod.event_log.event_log import EventLog
-from simod.extraneous_delays.optimizer import ExtraneousDelayTimersOptimizer
+from simod.extraneous_delays.optimizer import ExtraneousDelaysOptimizer
 from simod.extraneous_delays.types import ExtraneousDelay
 from simod.extraneous_delays.utilities import add_timers_to_bpmn_model
 from simod.prioritization.discovery import discover_prioritization_rules
@@ -61,7 +61,7 @@ class Simod:
     # Optimizer for the Resource Model
     _resource_model_optimizer: Optional[ResourceModelOptimizer]
     # Optimizer for the Extraneous Delay Timers
-    _extraneous_delay_timers_optimizer: Optional[ExtraneousDelayTimersOptimizer]
+    _extraneous_delays_optimizer: Optional[ExtraneousDelaysOptimizer]
 
     def __init__(
         self,
@@ -234,13 +234,13 @@ def _optimize_resource_model(self) -> ResourceModelHyperoptIterationParams:
 
     def optimize_extraneous_activity_delays(self) -> List[ExtraneousDelay]:
         settings = self._settings.extraneous_activity_delays
-        self._extraneous_delay_timers_optimizer = ExtraneousDelayTimersOptimizer(
+        self._extraneous_delays_optimizer = ExtraneousDelaysOptimizer(
             event_log=self._event_log,
             bps_model=self._best_bps_model,
             settings=settings,
             base_directory=self._extraneous_delays_dir,
         )
-        timers = self._extraneous_delay_timers_optimizer.run()
+        timers = self._extraneous_delays_optimizer.run()
         return timers
 
     def _evaluate_model(self, bps_model: BPSModel, output_dir: Path):
@@ -292,6 +292,8 @@ def _clean_up(self):
         print_section("Removing intermediate files")
         self._control_flow_optimizer.cleanup()
         self._resource_model_optimizer.cleanup()
+        if self._settings.extraneous_activity_delays is not None:
+            self._extraneous_delays_optimizer.cleanup()
 
 
 def _export_canonical_model(

src/simod/simod.py

@@ -189,9 +189,3 @@ def to_json(self, output_dir: Path, process_name: str) -> Path:
             json.dump(self.to_dict(), f)
 
         return json_parameters_path
-
-# TODO
-#  Implement default method to discover a complete BPS model from scratch.
-#  It receives the training+validation log and it discovers a first direct
-#  attempt, this would be the Prosimos CRISP method, and then SIMOD iterates
-#  overriding each parameter.

src/simod/simulation/parameters/BPS_model.py

@@ -41,4 +41,4 @@ resource_model:
     participation: 0.4
 extraneous_activity_delays:
   optimization_metric: relative_emd
-  num_iterations: 3
+  num_iterations: 1 # Direct discovery, no optimization

tests/assets/configuration_simod_with_extraneous.yml

@@ -29,4 +29,4 @@ resource_model:
     participation: 0.4
 extraneous_activity_delays:
   optimization_metric: relative_emd
-  num_iterations: 3
+  num_iterations: 1 # Direct discovery, no optimization

tests/assets/configuration_simod_with_model_and_extraneous.yml

@@ -22,14 +22,14 @@
         "expect_prioritization_rules": False,
     },
     {
-        "name": "Simod extraneous",
+        "name": "Simod with model",
         "config_file": "configuration_simod_with_model.yml",
         "expect_extraneous": False,
         "expect_batching_rules": False,
         "expect_prioritization_rules": False,
     },
     {
-        "name": "Simod extraneous",
+        "name": "Simod with model & extraneous",
         "config_file": "configuration_simod_with_model_and_extraneous.yml",
         "expect_extraneous": True,
         "expect_batching_rules": False,