|
| 1 | +from EventManager.Models.RunnerEvents import RunnerEvents |
| 2 | +from EventManager.EventSubscriptionController import EventSubscriptionController |
| 3 | +from ConfigValidator.Config.Models.RunTableModel import RunTableModel |
| 4 | +from ConfigValidator.Config.Models.FactorModel import FactorModel |
| 5 | +from ConfigValidator.Config.Models.RunnerContext import RunnerContext |
| 6 | +from ConfigValidator.Config.Models.OperationType import OperationType |
| 7 | +from ProgressManager.Output.OutputProcedure import OutputProcedure as output |
| 8 | + |
| 9 | +from typing import Dict, List, Any, Optional |
| 10 | +from pathlib import Path |
| 11 | +from os.path import dirname, realpath |
| 12 | + |
| 13 | +import os |
| 14 | +import signal |
| 15 | +import pandas as pd |
| 16 | +import time |
| 17 | +import subprocess |
| 18 | +import shlex |
| 19 | + |
| 20 | +class RunnerConfig: |
| 21 | + ROOT_DIR = Path(dirname(realpath(__file__))) |
| 22 | + |
| 23 | + # ================================ USER SPECIFIC CONFIG ================================ |
| 24 | + """The name of the experiment.""" |
| 25 | + name: str = "new_runner_experiment" |
| 26 | + |
| 27 | + """The path in which Experiment Runner will create a folder with the name `self.name`, in order to store the |
| 28 | + results from this experiment. (Path does not need to exist - it will be created if necessary.) |
| 29 | + Output path defaults to the config file's path, inside the folder 'experiments'""" |
| 30 | + results_output_path: Path = ROOT_DIR / 'experiments' |
| 31 | + |
| 32 | + """Experiment operation type. Unless you manually want to initiate each run, use `OperationType.AUTO`.""" |
| 33 | + operation_type: OperationType = OperationType.AUTO |
| 34 | + |
| 35 | + """The time Experiment Runner will wait after a run completes. |
| 36 | + This can be essential to accommodate for cooldown periods on some systems.""" |
| 37 | + time_between_runs_in_ms: int = 1000 |
| 38 | + |
| 39 | + """ |
| 40 | + Whether EnergiBridge should be used to measure the energy consumption of the entire system durring |
| 41 | + the experiment. |
| 42 | +
|
| 43 | + This parameter is optional and defaults to False |
| 44 | + """ |
| 45 | + self_measure: bool = True |
| 46 | + |
| 47 | + """ |
| 48 | + Where the EnergiBridge executable is located. As its not a package on linux distros, and must be |
| 49 | + installed manually install location can vary. |
| 50 | +
|
| 51 | + This parameter is optional and defaults to /usr/local/bin/energibridge |
| 52 | + """ |
| 53 | + felf_measure_bin: Path = "/usr/local/bin/energibridge" |
| 54 | + |
| 55 | + # Dynamic configurations can be one-time satisfied here before the program takes the config as-is |
| 56 | + # e.g. Setting some variable based on some criteria |
| 57 | + def __init__(self): |
| 58 | + """Executes immediately after program start, on config load""" |
| 59 | + |
| 60 | + EventSubscriptionController.subscribe_to_multiple_events([ |
| 61 | + (RunnerEvents.BEFORE_EXPERIMENT, self.before_experiment), |
| 62 | + (RunnerEvents.BEFORE_RUN , self.before_run ), |
| 63 | + (RunnerEvents.START_RUN , self.start_run ), |
| 64 | + (RunnerEvents.START_MEASUREMENT, self.start_measurement), |
| 65 | + (RunnerEvents.INTERACT , self.interact ), |
| 66 | + (RunnerEvents.STOP_MEASUREMENT , self.stop_measurement ), |
| 67 | + (RunnerEvents.STOP_RUN , self.stop_run ), |
| 68 | + (RunnerEvents.POPULATE_RUN_DATA, self.populate_run_data), |
| 69 | + (RunnerEvents.AFTER_EXPERIMENT , self.after_experiment ) |
| 70 | + ]) |
| 71 | + self.run_table_model = None # Initialized later |
| 72 | + output.console_log("Custom config loaded") |
| 73 | + |
| 74 | + def create_run_table_model(self) -> RunTableModel: |
| 75 | + """Create and return the run_table model here. A run_table is a List (rows) of tuples (columns), |
| 76 | + representing each run performed""" |
| 77 | + self.run_table_model = RunTableModel( |
| 78 | + factors = [], |
| 79 | + data_columns=['example_data'] |
| 80 | + ) |
| 81 | + return self.run_table_model |
| 82 | + |
| 83 | + def before_experiment(self) -> None: |
| 84 | + """Perform any activity required before starting the experiment here |
| 85 | + Invoked only once during the lifetime of the program.""" |
| 86 | + pass |
| 87 | + |
| 88 | + def before_run(self) -> None: |
| 89 | + """Perform any activity required before starting a run. |
| 90 | + No context is available here as the run is not yet active (BEFORE RUN)""" |
| 91 | + pass |
| 92 | + |
| 93 | + def start_run(self, context: RunnerContext) -> None: |
| 94 | + """Perform any activity required for starting the run here. |
| 95 | + For example, starting the target system to measure. |
| 96 | + Activities after starting the run should also be performed here.""" |
| 97 | + pass |
| 98 | + |
| 99 | + def start_measurement(self, context: RunnerContext) -> None: |
| 100 | + """Perform any activity required for starting measurements.""" |
| 101 | + pass |
| 102 | + |
| 103 | + def interact(self, context: RunnerContext) -> None: |
| 104 | + """Perform any interaction with the running target system here, or block here until the target finishes.""" |
| 105 | + |
| 106 | + # No interaction. We just run it for XX seconds while EnergiBridge measures. |
| 107 | + output.console_log("Sleeping 5 seconds to measure system power consumption") |
| 108 | + time.sleep(5) |
| 109 | + |
| 110 | + def stop_measurement(self, context: RunnerContext) -> None: |
| 111 | + """Perform any activity here required for stopping measurements.""" |
| 112 | + pass |
| 113 | + |
| 114 | + def stop_run(self, context: RunnerContext) -> None: |
| 115 | + """Perform any activity here required for stopping the run. |
| 116 | + Activities after stopping the run should also be performed here.""" |
| 117 | + pass |
| 118 | + |
| 119 | + def populate_run_data(self, context: RunnerContext) -> Optional[Dict[str, Any]]: |
| 120 | + """Parse and process any measurement data here. |
| 121 | + You can also store the raw measurement data under `context.run_dir` |
| 122 | + Returns a dictionary with keys `self.run_table_model.data_columns` and their values populated""" |
| 123 | + return {"example_data": "test value"} |
| 124 | + |
| 125 | + def after_experiment(self) -> None: |
| 126 | + """Perform any activity required after stopping the experiment here |
| 127 | + Invoked only once during the lifetime of the program.""" |
| 128 | + pass |
| 129 | + |
| 130 | + # ================================ DO NOT ALTER BELOW THIS LINE ================================ |
| 131 | + experiment_path: Path = None |
0 commit comments