reformatted docstrings for pydocstyle again

deepcave/custom_queue.py

@@ -83,7 +83,7 @@ def get_worker(self, worker_name: str) -> Worker:
     def get_workers(self) -> List[Worker]:
         """
         Get the workers in the queue.
-        
+
         Returns
         -------
         List[Worker]
@@ -254,7 +254,7 @@ def get_jobs(self, registry: str = "running") -> List[Job]:
     def get_running_jobs(self) -> List[Job]:
         """
         Get the running jobs in the registry.
-        
+
         Returns
         -------
         List[Job]
@@ -265,7 +265,7 @@ def get_running_jobs(self) -> List[Job]:
     def get_pending_jobs(self) -> List[Job]:
         """
         Get the pending jobs in the registry.
-        
+
         Returns
         -------
         List[Job]
@@ -276,7 +276,7 @@ def get_pending_jobs(self) -> List[Job]:
     def get_finished_jobs(self) -> List[Job]:
         """
         Get the finished jobs in the registry.
-        
+
         Returns
         -------
         List[Job]

deepcave/evaluators/epm/__init__.py

@@ -11,6 +11,6 @@
 random_forest_surrogate
     This module provides a RandomForest Surrogate model.
 utils
-    This module provides a utility to get the types 
+    This module provides a utility to get the types
     as well as the bounds of the Hyperparameters.
 """

deepcave/evaluators/epm/fanova_forest.py

@@ -170,7 +170,7 @@ def compute_marginals(
         Parameters
         ----------
         hp_ids: Union[List[int], Tuple[int, ...]]
-            Contains the indices of the configspace for the selected Hyperparameters 
+            Contains the indices of the configspace for the selected Hyperparameters
             (starts with 0).
         depth: int
             The depth of the marginalization.

deepcave/evaluators/epm/random_forest.py

@@ -402,7 +402,7 @@ def _predict(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
 
         Parameters
         ----------
-        X : np.ndarray 
+        X : np.ndarray
             [n_samples, n_features (config + instance features)]
 
         Returns

deepcave/evaluators/epm/utils.py

@@ -2,7 +2,7 @@
 """
 # Utils
 
-This module provides a utility to get the types 
+This module provides a utility to get the types
 as well as the bounds of the Hyperparameters.
 """
 

deepcave/plugins/__init__.py

@@ -796,7 +796,7 @@ def _clean_inputs(self, inputs: Dict[str, Any]) -> Dict[str, Any]:
     def runs(self) -> List[AbstractRun]:
         """
         Get the runs as a list.
-        
+
         Returns
         -------
         List[AbstractRun]
@@ -811,7 +811,7 @@ def runs(self) -> List[AbstractRun]:
     def groups(self) -> List[Group]:
         """
         Get the groups as a list.
-        
+
         Returns
         -------
         List[Group]
@@ -826,7 +826,7 @@ def groups(self) -> List[Group]:
     def all_runs(self) -> List[AbstractRun]:
         """
         Get all runs and include the groups as a list.
-        
+
         Returns
         -------
         List[AbstractRun]
@@ -963,18 +963,19 @@ def register_in(a: str, b: Union[List[str], str]) -> str:
             Note
             ----
             For more information, see 'register_input'.
-            
+
             Parameters
             ----------
             a : str
                 Specifies the id of the input.
             b : Union[List[str], str]
                 Attributes which should be passed to the (dash) component, by default ("value",).
-            
+
             Returns
             -------
             str
-                Unique id for the input and plugin. This is necessary because ids are defined globally. 
+                Unique id for the input and plugin.
+                This is necessary because ids are defined globally.
             """
             return self.register_input(a, b, filter=True)
 
@@ -1002,7 +1003,7 @@ def register_in(a: str, b: Union[List[str], str]) -> str:
         def register_out(a: str, b: Union[List[str], str]) -> str:
             """
             Register the output.
-            
+
             Note
             ----
             For more information, see 'register_output'
@@ -1013,11 +1014,12 @@ def register_out(a: str, b: Union[List[str], str]) -> str:
                 Specifies the id of the output.
             b : Union[List[str], str]
                 Attribute.
-            
+
             Returns
             -------
             str
-                Unique id for the output and plugin. This is necessary because ids are defined globally.
+                Unique id for the output and plugin.
+                This is necessary because ids are defined globally.
             """
             return self.register_output(a, b, mpl=True)
 

deepcave/plugins/budget/budget_correlation.py

@@ -95,7 +95,7 @@ def get_input_layout(register: Callable) -> List[html.Div]:
     # Types dont match superclass
     def load_dependency_inputs(self, run, _, inputs) -> Dict[str, Dict[str, Any]]:
         """
-        Same as 'load_inputs' but called after inputs have changed.
+        Work like 'load_inputs' but called after inputs have changed.
 
         Note
         ----
@@ -139,7 +139,7 @@ def process(run: AbstractRun, inputs: Dict[str, int]) -> Dict[str, Any]:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differ 
+        The passed inputs are cleaned and therefore differ
         compared to 'load_inputs' or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
@@ -153,7 +153,7 @@ def process(run: AbstractRun, inputs: Dict[str, int]) -> Dict[str, Any]:
         Returns
         -------
         Dict[str, Any]
-            Serialized dictionary with the correlations 
+            Serialized dictionary with the correlations
             as well as the correlations symmetric.
         """
         objective_id = inputs["objective_id"]
@@ -238,7 +238,7 @@ def load_outputs(run, _, outputs) -> List[Any]:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differ 
+        The passed inputs are cleaned and therefore differ
         compared to 'load_inputs' or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 

deepcave/plugins/dynamic.py

@@ -50,10 +50,12 @@ def __init__(self) -> None:
     @interactive
     def register_callbacks(self) -> None:
         """
-        Register basic callbacks for the plugin. 
-        Following callbacks are registered: 
-        - If inputs changes, the changes are pasted back. This is in particular interest if input dependencies are used. 
-        - Raw data dialog to display raw data. 
+        Register basic callbacks for the plugin.
+
+        Following callbacks are registered:
+        - If inputs changes, the changes are pasted back.
+          This is in particular interest if input dependencies are used.
+        - Raw data dialog to display raw data.
         - Callback to be redirected to the config if clicked on it.
         """
         super().register_callbacks()
@@ -119,8 +121,8 @@ def plugin_output_update(_: Any, *inputs_list: str) -> Any:
     # Return type does not match the superclass
     def __call__(self) -> List[Component]:
         """
-        Return the components for the plugin. 
-        
+        Return the components for the plugin.
+
         Basically, all blocks and elements of the plugin are stacked-up here.
 
         Returns

deepcave/plugins/hyperparameter/importances.py

@@ -154,8 +154,9 @@ def get_filter_layout(register: Callable) -> List[html.Div]:
 
     def load_inputs(self) -> Dict[str, Dict[str, Any]]:
         """
-        Load the content for the defined inputs in 'get_input_layout'
-        and 'get_filter_layout'. This method is necessary to pre-load contents for the inputs.
+        Load the content for the defined inputs in 'get_input_layout' and 'get_filter_layout'.
+
+        This method is necessary to pre-load contents for the inputs.
         If the plugin is called for the first time, or there are no results in the cache,
         the plugin gets its content from this method.
 
@@ -181,7 +182,7 @@ def load_inputs(self) -> Dict[str, Dict[str, Any]]:
     # Types dont match superclass
     def load_dependency_inputs(self, run, _: Any, inputs: Dict[str, Any]) -> Dict[str, Any]:
         """
-        Same as 'load_inputs' but called after inputs have changed.
+        Work like 'load_inputs' but called after inputs have changed.
 
         Note
         ----
@@ -264,7 +265,7 @@ def process(run: AbstractRun, inputs: Dict[str, Any]) -> Dict[str, Any]:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differ 
+        The passed inputs are cleaned and therefore differ
         compared to 'load_inputs' or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
@@ -342,7 +343,7 @@ def load_outputs(run, inputs, outputs) -> go.Figure:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differ 
+        The passed inputs are cleaned and therefore differ
         compared to 'load_inputs' or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
@@ -461,7 +462,7 @@ def get_mpl_output_layout(register: Callable) -> html.Img:
     def load_mpl_outputs(run, inputs: Dict[str, Any], outputs):
         """
         Read the raw data and prepare it for the layout.
-        
+
         Parameters
         ----------
         run

deepcave/plugins/hyperparameter/pdp.py

@@ -182,8 +182,9 @@ def get_filter_layout(register: Callable) -> List[Any]:
 
     def load_inputs(self) -> Dict[str, Dict[str, Any]]:
         """
-        Load the content for the defined inputs in 'get_input_layout'
-        and 'get_filter_layout'. This method is necessary to pre-load contents for the inputs.
+        Load the content for the defined inputs in 'get_input_layout' and 'get_filter_layout'.
+
+        This method is necessary to pre-load contents for the inputs.
         If the plugin is called for the first time, or there are no results in the cache,
         the plugin gets its content from this method.
 
@@ -200,7 +201,7 @@ def load_inputs(self) -> Dict[str, Dict[str, Any]]:
     # Types dont match superclass
     def load_dependency_inputs(self, run, previous_inputs, inputs) -> Dict[str, Any]:
         """
-        Same as 'load_inputs' but called after inputs have changed.
+        Work like 'load_inputs' but called after inputs have changed.
 
         Note
         ----
@@ -263,7 +264,7 @@ def process(run, inputs) -> Dict[str, Any]:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differ 
+        The passed inputs are cleaned and therefore differ
         compared to 'load_inputs' or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
@@ -369,7 +370,7 @@ def get_output_layout(register: Callable) -> dcc.Graph:
     # Types dont match superclass
     def load_outputs(run, inputs, outputs) -> go.Figure:
         """
-        Read the raw data and prepare it for the layout. 
+        Read the raw data and prepare it for the layout.
 
         Note
         ----

deepcave/plugins/objective/configuration_cube.py

@@ -142,9 +142,10 @@ def get_filter_layout(register: Callable) -> List[html.Div]:
 
     def load_inputs(self) -> Dict[str, Any]:
         """
-        Load the content for the defined inputs in 'get_input_layout' and 'get_filter_layout'. 
+        Load the content for the defined inputs in 'get_input_layout' and 'get_filter_layout'.
+
         This method is necessary to pre-load contents for the inputs.
-        So, if the plugin is called for the first time or there are no results in the cache, 
+        So, if the plugin is called for the first time or there are no results in the cache,
         the plugin gets its content from this method.
 
         Returns
@@ -160,13 +161,13 @@ def load_inputs(self) -> Dict[str, Any]:
     # Types dont match superclass
     def load_dependency_inputs(self, run, _, inputs) -> Dict[str, Any]:
         """
-        Same as 'load_inputs' but called after inputs have changed.
+        Work like 'load_inputs' but called after inputs have changed.
 
         It is restricted to three Hyperparameters.
 
         Note
         ----
-        Only the changes have to be returned. 
+        Only the changes have to be returned.
         The returned dictionary will be merged with the inputs.
 
         Parameters
@@ -252,7 +253,8 @@ def process(run: AbstractRun, inputs: Dict[str, Any]) -> Dict[str, str]:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differs compared to 'load_inputs' or 'load_dependency_inputs'. 
+        The passed inputs are cleaned and therefore differs compared to 'load_inputs'
+        or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
         Parameters
@@ -301,7 +303,8 @@ def load_outputs(run, inputs, outputs) -> go.Figure:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differs compared to 'load_inputs' or 'load_dependency_inputs'. 
+        The passed inputs are cleaned and therefore differs compared to 'load_inputs'
+        or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
         Parameters

deepcave/plugins/objective/cost_over_time.py

@@ -51,8 +51,9 @@ def check_runs_compatibility(self, runs: List[AbstractRun]) -> None:
         """
         Check if the runs are compatible.
 
-        This function is needed if all selected runs need something in common (e.g. budget or objective). 
-        Since this function is called before the layout is created, 
+        This function is needed if all selected runs need something in common
+        (e.g. budget or objective).
+        Since this function is called before the layout is created,
         it can be also used to set common values for the plugin.
 
         Parameters
@@ -183,9 +184,10 @@ def get_filter_layout(register: Callable) -> List[Any]:
 
     def load_inputs(self) -> Dict[str, Any]:
         """
-        Load the content for the defined inputs in 'get_input_layout' and 'get_filter_layout'. 
-        This method is necessary to pre-load contents for the inputs. 
-        So, if the plugin is called for the first time or there are no results in the cache, 
+        Load the content for the defined inputs in 'get_input_layout' and 'get_filter_layout'.
+
+        This method is necessary to pre-load contents for the inputs.
+        So, if the plugin is called for the first time or there are no results in the cache,
         the plugin gets its content from this method.
 
         Returns
@@ -226,7 +228,8 @@ def process(run, inputs) -> Dict[str, Any]:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differs compared to 'load_inputs' or 'load_dependency_inputs'. 
+        The passed inputs are cleaned and therefore differs compared to 'load_inputs'
+        or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
         Parameters
@@ -282,7 +285,8 @@ def load_outputs(runs, inputs, outputs) -> go.Figure:
 
         Note
         ----
-        The passed inputs are cleaned and therefore differs compared to 'load_inputs' or 'load_dependency_inputs'. 
+        The passed inputs are cleaned and therefore differs compared to 'load_inputs'
+        or 'load_dependency_inputs'.
         Please see '_clean_inputs' for more information.
 
         Parameters