API change - create_run_table() removed

This change will make it easier for plugins to modify
the base behavior. The `create_run_table` function has been
replaced with `create_run_table_model`

examples/hello-world/RunnerConfig.py

@@ -50,8 +50,8 @@ def __init__(self):
 
         output.console_log("Custom config loaded")
 
-    def create_run_table(self) -> List[Dict]:
-        """Create and return the run_table here. A run_table is a List (rows) of tuples (columns), 
+    def create_run_table_model(self) -> RunTableModel:
+        """Create and return the run_table model here. A run_table is a List (rows) of tuples (columns),
         representing each run performed"""
         factor1 = FactorModel("example_factor1", ['example_treatment1', 'example_treatment2', 'example_treatment3'])
         factor2 = FactorModel("example_factor2", [True, False])
@@ -63,7 +63,7 @@ def create_run_table(self) -> List[Dict]:
             ],
             data_columns=['avg_cpu', 'avg_mem']
         )
-        return self.run_table_model.generate_experiment_run_table()
+        return self.run_table_model
 
     def before_experiment(self) -> None:
         """Perform any activity required before starting the experiment here

examples/linux-ps-profiling/RunnerConfig.py

@@ -54,8 +54,8 @@ def __init__(self):
         self.run_table_model = None  # Initialized later
         output.console_log("Custom config loaded")
 
-    def create_run_table(self) -> List[Dict]:
-        """Create and return the run_table here. A run_table is a List (rows) of tuples (columns), 
+    def create_run_table_model(self) -> RunTableModel:
+        """Create and return the run_table model here. A run_table is a List (rows) of tuples (columns),
         representing each run performed"""
         cpu_limit_factor = FactorModel("cpu_limit", [20, 50, 70 ])
         pin_core_factor  = FactorModel("pin_core" , [True, False])
@@ -66,7 +66,7 @@ def create_run_table(self) -> List[Dict]:
             ],
             data_columns=['avg_cpu']
         )
-        return self.run_table_model.generate_experiment_run_table()
+        return self.run_table_model
 
     def before_experiment(self) -> None:
         """Perform any activity required before starting the experiment here

experiment-runner/ConfigValidator/Config/RunnerConfig.py

@@ -51,8 +51,8 @@ def __init__(self):
 
         output.console_log("Custom config loaded")
 
-    def create_run_table(self) -> List[Dict]:
-        """Create and return the run_table here. A run_table is a List (rows) of tuples (columns), 
+    def create_run_table_model(self) -> RunTableModel:
+        """Create and return the run_table model here. A run_table is a List (rows) of tuples (columns),
         representing each run performed"""
         factor1 = FactorModel("example_factor1", ['example_treatment1', 'example_treatment2', 'example_treatment3'])
         factor2 = FactorModel("example_factor2", [True, False])
@@ -64,7 +64,7 @@ def create_run_table(self) -> List[Dict]:
             ],
             data_columns=['avg_cpu', 'avg_mem']
         )
-        return self.run_table_model.generate_experiment_run_table()
+        return self.run_table_model
 
     def before_experiment(self) -> None:
         """Perform any activity required before starting the experiment here

experiment-runner/ExperimentOrchestrator/Experiment/ExperimentController.py

@@ -36,7 +36,7 @@ def __init__(self, config: RunnerConfig, metadata: Metadata):
 
         self.csv_data_manager = CSVOutputManager(self.config.experiment_path)
         self.json_data_manager = JSONOutputManager(self.config.experiment_path)
-        self.run_table = self.config.create_run_table()
+        self.run_table = self.config.create_run_table_model().generate_experiment_run_table()
 
         # Create experiment output folder, and in case that it exists, check if we can resume
         self.restarted = False

experiment-runner/Plugins/CodecarbonWrapper.py

@@ -32,10 +32,10 @@ def emission_tracker(online=False, *decargs, **deckwargs):
     def emission_tracker_decorator(cls: RunnerConfig.__class__):
         data_columns =  deckwargs.pop('data_columns', [DataColumns.EMISSIONS])
 
-        cls.create_run_table  = add_data_columns(data_columns)(cls.create_run_table)
-        cls.start_measurement = start_emission_tracker(online=online, *decargs, **deckwargs)(cls.start_measurement)
-        cls.stop_measurement  = stop_emission_tracker(cls.stop_measurement)
-        cls.populate_run_data = populate_data_columns(cls.populate_run_data)
+        cls.create_run_table_model  = add_data_columns(data_columns)(cls.create_run_table_model)
+        cls.start_measurement       = start_emission_tracker(online=online, *decargs, **deckwargs)(cls.start_measurement)
+        cls.stop_measurement        = stop_emission_tracker(cls.stop_measurement)
+        cls.populate_run_data       = populate_data_columns(cls.populate_run_data)
 
         return cls
     return emission_tracker_decorator
@@ -72,10 +72,10 @@ def add_data_columns_decorator(func):
         def wrapper(*args, **kwargs):
             self: RunnerConfig = args[0]
 
-            func(*args, **kwargs)  # will set self.run_table_model. Discard result
+            func(*args, **kwargs)  # will set self.run_table_model
             for dc in data_cols:
                 self.run_table_model.get_data_columns().append(dc.name)
-            return self.run_table_model.generate_experiment_run_table()  # FIXME: this is bad
+            return self.run_table_model
         return wrapper
     return add_data_columns_decorator
 

experiment-runner/Plugins/README.md

@@ -44,7 +44,7 @@ from Plugins.CodecarbonWrapper import DataColumns as CCDataCols
 class RunnerConfig:
 
     @CodecarbonWrapper.add_data_columns([CCDataCols.EMISSIONS, CCDataCols.ENERGY_CONSUMED])
-    def create_run_table(self):
+    def create_run_table_model(self):
         ...
 
     @CodecarbonWrapper.start_emission_tracker(

test-standalone/core/arbitrary-objects/RunnerConfig.py

@@ -15,7 +15,7 @@
 Test Description:
 
 Test functionality for arbitrary objects as factor levels
-  * When recovering from a crash, the generated objects from `create_run_table()` should be used
+  * When recovering from a crash, the generated objects from `create_run_table_model()` should be used
     instead of the `str` values found in the stored csv.
 '''
 
@@ -59,7 +59,7 @@ def __init__(self):
 
         output.console_log("Custom config loaded")
 
-    def create_run_table(self) -> List[Dict]:
+    def create_run_table_model(self) -> RunTableModel:
         x1, x2, x3 = CustomObject(1), CustomObject(2), CustomObject(3)
 
         factor1 = FactorModel("example_factor1", [x1, x2, x3])
@@ -72,7 +72,7 @@ def create_run_table(self) -> List[Dict]:
             ],
             data_columns=['avg_cpu', 'avg_mem']
         )
-        return self.run_table_model.generate_experiment_run_table()
+        return self.run_table_model
 
     def before_experiment(self) -> None:
         output.console_log("Config.before_experiment() called!")

test-standalone/plugins/CodecarbonWrapper/combined/RunnerConfig.py

@@ -49,7 +49,7 @@ def __init__(self):
         ])
         self.run_table_model = None  # Initialized later
 
-    def create_run_table(self) -> List[Dict]:
+    def create_run_table_model(self) -> RunTableModel:
         factor1 = FactorModel("example_factor1", ['example_treatment1', 'example_treatment2', 'example_treatment3'])
         factor2 = FactorModel("example_factor2", [True, False])
         self.run_table_model = RunTableModel(
@@ -60,7 +60,7 @@ def create_run_table(self) -> List[Dict]:
             ],
             data_columns=['avg_cpu', 'avg_mem']
         )
-        return self.run_table_model.generate_experiment_run_table()
+        return self.run_table_model
 
     def before_experiment(self) -> None:
         output.console_log("Config.before_experiment() called!")

test-standalone/plugins/CodecarbonWrapper/individual/RunnerConfig.py

@@ -46,7 +46,7 @@ def __init__(self):
         self.run_table_model = None  # Initialized later
 
     @CodecarbonWrapper.add_data_columns([CCDataCols.EMISSIONS, CCDataCols.ENERGY_CONSUMED])
-    def create_run_table(self) -> List[Dict]:
+    def create_run_table_model(self) -> RunTableModel:
         factor1 = FactorModel("example_factor1", ['example_treatment1', 'example_treatment2', 'example_treatment3'])
         factor2 = FactorModel("example_factor2", [True, False])
         self.run_table_model = RunTableModel(
@@ -57,7 +57,7 @@ def create_run_table(self) -> List[Dict]:
             ],
             data_columns=['avg_cpu', 'avg_mem']
         )
-        return self.run_table_model.generate_experiment_run_table()
+        return self.run_table_model
 
     def before_experiment(self) -> None:
         output.console_log("Config.before_experiment() called!")

test/Plugins/test_CodecarbonWrapper.py

@@ -24,8 +24,8 @@ def clear(self):
             shutil.rmtree(self.__class__.tmpdir)
 
         @CodecarbonWrapper.add_data_columns([CCDataCols.EMISSIONS, CCDataCols.ENERGY_CONSUMED])
-        def create_run_table(self):
-            super().create_run_table()
+        def create_run_table_model(self):
+            return super().create_run_table_model()
 
         @CodecarbonWrapper.start_emission_tracker(
             country_iso_code="NLD",
@@ -52,7 +52,7 @@ def populate_run_data(self, context: RunnerContext):
 
     def setUp(self) -> None:
         self.runner_config = self.__class__.EmissionTrackerConfig()
-        self.run_table = self.runner_config.create_run_table()
+        self.run_table = self.runner_config.create_run_table_model().generate_experiment_run_table()
 
     def tearDown(self) -> None:
         self.runner_config.clear()
@@ -97,7 +97,7 @@ def populate_run_data(self, context: RunnerContext):
 
     def setUp(self) -> None:
         self.runner_config = self.__class__.EmissionTrackerConfig()
-        self.run_table = self.runner_config.create_run_table()
+        self.run_table = self.runner_config.create_run_table_model().generate_experiment_run_table()
 
     def tearDown(self) -> None:
         self.runner_config.clear()