Allow multiple seeds (adapt DeepCAVE runs)

Author: Sarah Krebs

deepcave/runs/__init__.py

@@ -396,7 +396,7 @@ def get_configs(
         Get configurations of the run.
 
         Optionally, only configurations which were evaluated on the passed budget, seed,
-        and statuses are considered.
+        and stati are considered.
 
         Parameters
         ----------
@@ -696,9 +696,11 @@ def get_avg_costs(
         """
         Get average costs over all seeds for a config.
 
-        Optionally, only configurations which were evaluated on the passed budget and statuses
+        Optionally, only configurations which were evaluated on the passed budget and stati
         are considered.
 
+        In case of multi-objective, multiple costs are returned in the form of a list.
+
         Parameters
         ----------
         config_id : int
@@ -739,7 +741,10 @@ def get_costs(
         """
         Return the costs of a configuration.
 
-        In case of multi-objective, multiple costs are returned.
+        Optionally, only configurations which were evaluated on the passed budget, seed, and stati
+        are considered.
+
+        In case of multi-objective, multiple costs are returned in the form of a list.
 
         Parameters
         ----------
@@ -792,8 +797,10 @@ def get_all_costs(
         """
         Get all costs in the history with their config ids and seeds.
 
-        If set, only configs from the given budget, seed,
-        and statuses are returned.
+        Optionally, only configurations which were evaluated on the passed budget, seed, and stati
+        are considered.
+
+        In case of multi-objective, multiple costs are returned in the form of a list.
 
         Parameters
         ----------
@@ -863,7 +870,7 @@ def get_status(
         budget: Optional[Union[int, float]] = None,
     ) -> Status:
         """
-        Return the status of a configuration.
+        Return the status of a trial (i.e. configuration, budget and seed).
 
         Parameters
         ----------
@@ -913,7 +920,12 @@ def get_incumbent(
         selected_ids: Optional[List[int]] = None,
     ) -> Tuple[Configuration, float]:
         """
-        Return the incumbent with its normalized cost.
+        Return the incumbent with its normalized objective value.
+
+        The incumbent is the configuration with the lowest normalized objective value.
+
+        Optionally, only configurations which were evaluated on the passed budget, seed,
+        and stati are considered.
 
         Parameters
         ----------
@@ -924,9 +936,9 @@ def get_incumbent(
         seed : Optional[int], optional
             Considered seed. If no seed is given, all seeds are considered. By default None.
         statuses : Optional[Union[Status, List[Status]]], optional
-            Considered statuses. If None, all stati are considered. By default None.
+            Considered stati. If None, all stati are considered. By default None.
         selected_ids: Optional[List[int]], optional
-            If set, only history ids in the list will be considered. This can for example be
+            If set, only ids in selected_ids will be considered. This can for example be
             useful if only ids up to a certain end-time shall be considered. By default None.
 
         Returns
@@ -953,8 +965,8 @@ def get_incumbent(
 
         for config_id, costs in results.items():
             # If there are multiple seeds, only configurations evaluated on all seeds are
-            # considered. From these configurations, the one with the highest average cost
-            # over the seeds is considered as the incumbent.
+            # considered. From these configurations, the one with the highest average objective
+            # value over the seeds is considered as the incumbent.
             if max_seed_count > 1:
                 if len(costs) < max_seed_count:
                     continue
@@ -1288,7 +1300,7 @@ def get_encoded_data(
             Which seed should be considered. If None, all seeds are considered.
             By default None.
         statuses : Optional[Union[Status, List[Status]]]
-            Which statuses should be considered. If None, all statuses are considered.
+            Which stati should be considered. If None, all stati are considered.
             By default None.
         specific : bool
             Whether a specific encoding should be used. This encoding is compatible with pyrfr.

deepcave/runs/trial.py

@@ -29,6 +29,8 @@ class Trial:
         The identificator of the configuration.
     budget : Union[int, float]
         The budget for the trial.
+    seed: int
+        The seed for the trial.
     costs : List[float]
         A list of the costs of the trial.
     start_time : float