ready to merge & pull request

Author: KrissiHub

CHANGELOG.md

@@ -6,7 +6,7 @@
 - Updated the Cost over Time documentation accordingly.
 
 ## Bug-Fixes
-- When getting budget, attributes etc from multiple runs in Cost over Time and Pareto Front:
+- When getting budget, objectives etc from multiple runs in Cost over Time and Pareto Front:
     - Instead of taking the first run as comparative value,
     - take the one with the lowest budget, else the index for the budgets could be out of bounds.
 

deepcave/plugins/objective/cost_over_time.py

@@ -25,6 +25,8 @@ class CostOverTime(DynamicPlugin):
     help = "docs/plugins/cost_over_time.rst"
 
     def check_runs_compatibility(self, runs: List[AbstractRun]) -> None:
+        # If the runs are not mergeable, they still should be displayed
+        # but with a corresponding warning message
         try:
             check_equality(runs, objectives=True, budgets=True)
         except NotMergeableError as e:
@@ -41,8 +43,8 @@ def check_runs_compatibility(self, runs: List[AbstractRun]) -> None:
                 notification.update("The objectives of the runs are not equal.", color="warning")
 
         # Set some attributes here
-        # It is necessary to get the run with the smallest budget as
-        # first comparative value, else there is gonna be an index problem
+        # It is necessary to get the run with the smallest budget and objective options
+        # as first comparative value, else there is gonna be an index problem
         objective_options = []
         budget_options = []
         for run in runs:
@@ -56,7 +58,6 @@ def check_runs_compatibility(self, runs: List[AbstractRun]) -> None:
         self.objective_options = min(objective_options, key=len)
         self.budget_options = min(budget_options, key=len)
 
-
     @staticmethod
     def get_input_layout(register):
         return [

deepcave/plugins/objective/pareto_front.py

@@ -25,6 +25,8 @@ class ParetoFront(DynamicPlugin):
     help = "docs/plugins/pareto_front.rst"
 
     def check_runs_compatibility(self, runs):
+        # If the runs are not mergeable, they still should be displayed
+        # but with a corresponding warning message
         try:
             check_equality(runs, objectives=True, budgets=True)
         except NotMergeableError as e:
@@ -41,8 +43,8 @@ def check_runs_compatibility(self, runs):
                 notification.update("The objectives of the runs are not equal.", color="warning")
 
         # Set some attributes here
-        # It is necessary to get the run with the smallest budget as
-        # first comparative value, else there is gonna be an index problem
+        # It is necessary to get the run with the smallest budget and objective options
+        # as first comparative value, else there is gonna be an index problem
         objective_options = []
         budget_options = []
         for run in runs:
@@ -56,7 +58,6 @@ def check_runs_compatibility(self, runs):
         self.objective_options = min(objective_options, key=len)
         self.budget_options = min(budget_options, key=len)
 
-
     @staticmethod
     def get_input_layout(register):
         return [