Merge pull request #103 from automl/bugfix/api-examples

Bugfix/Fix api examples
automl · Jan 17, 2024 · 9b3df78 · 9b3df78
2 parents a10ef27 + e6f85de
commit 9b3df78
Show file tree

Hide file tree

Showing 18 changed files with 128 additions and 45 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,8 @@
 
 ## Bug-Fixes
 - Don't convert BOHB runs with status 'running' (consistent with SMAC).
-- Reset inputs to fix error when subsequently selecting runs with different configspaces, objectives or budgets (#106)
+- Fix api examples (#68).
+- Reset inputs to fix error when subsequently selecting runs with different configspaces, objectives or budgets (#106).
 
 # Version 1.1.3
 

diff --git a/deepcave/plugins/__init__.py b/deepcave/plugins/__init__.py
@@ -93,9 +93,9 @@ def get_base_url(cls) -> str:
         str
             Url for the plugin as string.
         """
-        from deepcave import config
+        from deepcave.config import Config
 
-        return f"http://{config.DASH_ADDRESS}:{config.DASH_PORT}/plugins/{cls.id}"
+        return f"http://{Config.DASH_ADDRESS}:{Config.DASH_PORT}/plugins/{cls.id}"
 
     @staticmethod
     def check_run_compatibility(run: AbstractRun) -> bool:

diff --git a/deepcave/plugins/budget/budget_correlation.py b/deepcave/plugins/budget/budget_correlation.py
@@ -7,7 +7,8 @@
 from dash import dcc, html
 from scipy import stats
 
-from deepcave import config, notification
+from deepcave import notification
+from deepcave.config import Config
 from deepcave.plugins.dynamic import DynamicPlugin
 from deepcave.runs import Status
 from deepcave.utils.layout import create_table, get_select_options
@@ -114,7 +115,7 @@ def get_output_layout(register):
                 [
                     dbc.Tab(
                         dcc.Graph(
-                            id=register("graph", "figure"), style={"height": config.FIGURE_HEIGHT}
+                            id=register("graph", "figure"), style={"height": Config.FIGURE_HEIGHT}
                         ),
                         label="Graph",
                     ),
@@ -171,7 +172,7 @@ def load_outputs(run, _, outputs):
         layout = go.Layout(
             xaxis=dict(title="Budget"),
             yaxis=dict(title="Correlation"),
-            margin=config.FIGURE_MARGIN,
+            margin=Config.FIGURE_MARGIN,
             legend=dict(title="Budgets"),
         )
 

diff --git a/deepcave/plugins/hyperparameter/importances.py b/deepcave/plugins/hyperparameter/importances.py
@@ -4,7 +4,7 @@
 from dash import dcc, html
 from dash.exceptions import PreventUpdate
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.evaluators.fanova import fANOVA as GlobalEvaluator
 from deepcave.evaluators.lpi import LPI as LocalEvaluator
 from deepcave.plugins.static import StaticPlugin
@@ -201,7 +201,7 @@ def process(run, inputs):
 
     @staticmethod
     def get_output_layout(register):
-        return dcc.Graph(register("graph", "figure"), style={"height": config.FIGURE_HEIGHT})
+        return dcc.Graph(register("graph", "figure"), style={"height": Config.FIGURE_HEIGHT})
 
     @staticmethod
     def load_outputs(run, inputs, outputs):
@@ -273,7 +273,7 @@ def load_outputs(run, inputs, outputs):
             barmode="group",
             yaxis_title="Importance",
             legend={"title": "Budget"},
-            margin=config.FIGURE_MARGIN,
+            margin=Config.FIGURE_MARGIN,
             xaxis=dict(tickangle=-45),
         )
         save_image(figure, "importances.pdf")

diff --git a/deepcave/plugins/hyperparameter/pdp.py b/deepcave/plugins/hyperparameter/pdp.py
@@ -4,7 +4,7 @@
 from dash import dcc, html
 from pyPDP.algorithms.pdp import PDP
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.evaluators.epm.random_forest_surrogate import RandomForestSurrogate
 from deepcave.plugins.static import StaticPlugin
 from deepcave.runs import Status
@@ -234,7 +234,7 @@ def process(run, inputs):
 
     @staticmethod
     def get_output_layout(register):
-        return dcc.Graph(register("graph", "figure"), style={"height": config.FIGURE_HEIGHT})
+        return dcc.Graph(register("graph", "figure"), style={"height": Config.FIGURE_HEIGHT})
 
     @staticmethod
     def load_outputs(run, inputs, outputs):
@@ -348,7 +348,7 @@ def load_outputs(run, inputs, outputs):
                 dict(
                     xaxis=dict(tickvals=x_tickvals, ticktext=x_ticktext, title=hp1_name),
                     yaxis=dict(tickvals=y_tickvals, ticktext=y_ticktext, title=hp2_name),
-                    margin=config.FIGURE_MARGIN,
+                    margin=Config.FIGURE_MARGIN,
                 )
             )
 

diff --git a/deepcave/plugins/objective/configuration_cube.py b/deepcave/plugins/objective/configuration_cube.py
@@ -7,7 +7,7 @@
 from dash import dcc, html
 from dash.exceptions import PreventUpdate
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.plugins.dynamic import DynamicPlugin
 from deepcave.runs import Status
 from deepcave.utils.compression import deserialize, serialize
@@ -178,7 +178,7 @@ def process(run, inputs):
 
     @staticmethod
     def get_output_layout(register):
-        return (dcc.Graph(register("graph", "figure"), style={"height": config.FIGURE_HEIGHT}),)
+        return (dcc.Graph(register("graph", "figure"), style={"height": Config.FIGURE_HEIGHT}),)
 
     @staticmethod
     def load_outputs(run, inputs, outputs):
@@ -278,7 +278,7 @@ def load_outputs(run, inputs, outputs):
             layout = go.Layout(**layout_kwargs)
 
         figure = go.Figure(data=trace, layout=layout)
-        figure.update_layout(dict(margin=config.FIGURE_MARGIN))
+        figure.update_layout(dict(margin=Config.FIGURE_MARGIN))
         save_image(figure, "configuration_cube.pdf")
 
         return figure
diff --git a/deepcave/plugins/objective/cost_over_time.py b/deepcave/plugins/objective/cost_over_time.py
@@ -6,7 +6,7 @@
 from dash import dcc, html
 from dash.exceptions import PreventUpdate
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.plugins.dynamic import DynamicPlugin
 from deepcave.runs import AbstractRun, check_equality
 from deepcave.utils.layout import get_select_options, help_button
@@ -150,7 +150,7 @@ def process(run, inputs):
 
     @staticmethod
     def get_output_layout(register):
-        return dcc.Graph(register("graph", "figure"), style={"height": config.FIGURE_HEIGHT})
+        return dcc.Graph(register("graph", "figure"), style={"height": Config.FIGURE_HEIGHT})
 
     @staticmethod
     def load_outputs(runs, inputs, outputs):
@@ -245,7 +245,7 @@ def load_outputs(runs, inputs, outputs):
         layout = go.Layout(
             xaxis=dict(title=xaxis_label, type=type),
             yaxis=dict(title=objective.name),
-            margin=config.FIGURE_MARGIN,
+            margin=Config.FIGURE_MARGIN,
         )
 
         figure = go.Figure(data=traces, layout=layout)

diff --git a/deepcave/plugins/objective/parallel_coordinates.py b/deepcave/plugins/objective/parallel_coordinates.py
@@ -7,7 +7,7 @@
 from dash import dcc, html
 from dash.exceptions import PreventUpdate
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.constants import VALUE_RANGE
 from deepcave.evaluators.fanova import fANOVA
 from deepcave.plugins.static import StaticPlugin
@@ -88,7 +88,7 @@ def get_filter_layout(register):
                             dbc.Label("Limit Hyperparameters"),
                             help_button(
                                 "Shows either the n most important hyperparameters (if show "
-                                "importance hyperparameters is true) or the first n selected "
+                                "important hyperparameters is true) or the first n selected "
                                 "hyperparameters."
                             ),
                             dbc.Input(id=register("n_hps", "value"), type="number"),
@@ -206,7 +206,7 @@ def process(run, inputs):
 
     @staticmethod
     def get_output_layout(register):
-        return dcc.Graph(register("graph", "figure"), style={"height": config.FIGURE_HEIGHT})
+        return dcc.Graph(register("graph", "figure"), style={"height": Config.FIGURE_HEIGHT})
 
     @staticmethod
     def load_outputs(run, inputs, outputs):

diff --git a/deepcave/plugins/objective/pareto_front.py b/deepcave/plugins/objective/pareto_front.py
@@ -5,7 +5,7 @@
 import plotly.graph_objs as go
 from dash import dcc, html
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.plugins.dynamic import DynamicPlugin
 from deepcave.runs import Status, check_equality
 from deepcave.utils.layout import get_select_options, help_button
@@ -206,7 +206,7 @@ def process(run, inputs):
 
     @staticmethod
     def get_output_layout(register):
-        return dcc.Graph(register("graph", "figure"), style={"height": config.FIGURE_HEIGHT})
+        return dcc.Graph(register("graph", "figure"), style={"height": Config.FIGURE_HEIGHT})
 
     @staticmethod
     def load_outputs(runs, inputs, outputs):
@@ -291,7 +291,7 @@ def load_outputs(runs, inputs, outputs):
             layout = go.Layout(
                 xaxis=dict(title=objective_1.name),
                 yaxis=dict(title=objective_2.name),
-                margin=config.FIGURE_MARGIN,
+                margin=Config.FIGURE_MARGIN,
             )
         else:
             layout = None

diff --git a/deepcave/plugins/static.py b/deepcave/plugins/static.py
@@ -295,12 +295,12 @@ def _get_job_id(self, run_name: str, inputs_key: str) -> str:
 
     @interactive
     def __call__(self) -> List[Component]:  # type: ignore
-        from deepcave import config
+        from deepcave.config import Config
 
         self._setup()
 
         components = [
-            dcc.Interval(id=self.get_internal_id("update-interval"), interval=config.REFRESH_RATE),
+            dcc.Interval(id=self.get_internal_id("update-interval"), interval=Config.REFRESH_RATE),
             dcc.Store(id=self.get_internal_id("update-interval-output"), data=0),
         ]
         components += super().__call__(True)

diff --git a/deepcave/plugins/summary/configurations.py b/deepcave/plugins/summary/configurations.py
@@ -5,7 +5,7 @@
 import plotly.graph_objs as go
 from dash import dcc, html
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.constants import VALUE_RANGE
 from deepcave.plugins.dynamic import DynamicPlugin
 from deepcave.runs import AbstractRun, Status
@@ -178,7 +178,7 @@ def get_output_layout(register):
                     dbc.Tab(
                         dcc.Graph(
                             id=register("performance_graph", "figure"),
-                            style={"height": config.FIGURE_HEIGHT},
+                            style={"height": Config.FIGURE_HEIGHT},
                         ),
                         label="Graph",
                     ),
@@ -192,7 +192,7 @@ def get_output_layout(register):
                     dbc.Tab(
                         dcc.Graph(
                             id=register("configspace_graph", "figure"),
-                            style={"height": config.FIGURE_HEIGHT},
+                            style={"height": Config.FIGURE_HEIGHT},
                         ),
                         label="Graph",
                     ),
@@ -231,7 +231,7 @@ def _get_objective_figure(_, outputs, run):
             objective_data.append(trace)
 
         layout_kwargs = {
-            "margin": config.FIGURE_MARGIN,
+            "margin": Config.FIGURE_MARGIN,
             "xaxis": {"title": "Budget", "domain": [0.05 * len(run.get_objectives()), 1]},
         }
 

diff --git a/deepcave/plugins/summary/footprint.py b/deepcave/plugins/summary/footprint.py
@@ -2,7 +2,7 @@
 import plotly.graph_objs as go
 from dash import dcc, html
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.evaluators.footprint import Footprint as Evaluator
 from deepcave.plugins.static import StaticPlugin
 from deepcave.utils.layout import get_select_options, help_button
@@ -173,13 +173,13 @@ def get_output_layout(register):
             [
                 dbc.Tab(
                     dcc.Graph(
-                        id=register("performance", "figure"), style={"height": config.FIGURE_HEIGHT}
+                        id=register("performance", "figure"), style={"height": Config.FIGURE_HEIGHT}
                     ),
                     label="Performance",
                 ),
                 dbc.Tab(
                     dcc.Graph(
-                        id=register("area", "figure"), style={"height": config.FIGURE_HEIGHT}
+                        id=register("area", "figure"), style={"height": Config.FIGURE_HEIGHT}
                     ),
                     label="Coverage",
                 ),
@@ -264,7 +264,7 @@ def load_outputs(run, inputs, outputs):
         layout = go.Layout(
             xaxis=dict(title=None, tickvals=[]),
             yaxis=dict(title=None, tickvals=[]),
-            margin=config.FIGURE_MARGIN,
+            margin=Config.FIGURE_MARGIN,
         )
 
         performance = go.Figure(data=[performance_data] + traces, layout=layout)

diff --git a/deepcave/plugins/summary/overview.py b/deepcave/plugins/summary/overview.py
@@ -12,7 +12,7 @@
 )
 from dash import dcc, html
 
-from deepcave import config
+from deepcave.config import Config
 from deepcave.plugins.dynamic import DynamicPlugin
 from deepcave.plugins.summary.configurations import Configurations
 from deepcave.runs.group import Group
@@ -51,14 +51,14 @@ def get_output_layout(register):
                     dbc.Tab(
                         dcc.Graph(
                             id=register("status_statistics", "figure"),
-                            style={"height": config.FIGURE_HEIGHT},
+                            style={"height": Config.FIGURE_HEIGHT},
                         ),
                         label="Barplot",
                     ),
                     dbc.Tab(
                         dcc.Graph(
                             id=register("config_statistics", "figure"),
-                            style={"height": config.FIGURE_HEIGHT},
+                            style={"height": Config.FIGURE_HEIGHT},
                         ),
                         label="Heatmap",
                     ),
@@ -328,7 +328,7 @@ def load_outputs(run, *_):
             barmode="group",
             xaxis=dict(title="Status"),
             yaxis=dict(title="Number of configurations"),
-            margin=config.FIGURE_MARGIN,
+            margin=Config.FIGURE_MARGIN,
         )
         stats_figure = go.Figure(data=stats_data, layout=stats_layout)
         save_image(stats_figure, "status_bar.pdf")
@@ -337,7 +337,7 @@ def load_outputs(run, *_):
             legend={"title": "Status"},
             xaxis=dict(title="Budget"),
             yaxis=dict(title="Configuration ID"),
-            margin=config.FIGURE_MARGIN,
+            margin=Config.FIGURE_MARGIN,
         )
         config_figure = go.Figure(
             data=get_discrete_heatmap(

diff --git a/deepcave/utils/styled_plotty.py b/deepcave/utils/styled_plotty.py
@@ -34,15 +34,15 @@ def save_image(figure: go.Figure, name: str) -> None:
     name : str
         Name of the image with extension. Will be automatically saved to the cache.
     """
-    from deepcave import config
+    from deepcave.config import Config
 
-    if not config.SAVE_IMAGES:
+    if not Config.SAVE_IMAGES:
         return
 
     ratio = 16 / 9
     width = 500
     height = int(width / ratio)
-    path = config.CACHE_DIR / "figures" / name
+    path = Config.CACHE_DIR / "figures" / name
 
     figure.write_image(path, width=width, height=height)
     logger.info(f"Saved figure {name} to {path}.")

diff --git a/examples/api/importances.py b/examples/api/importances.py
@@ -0,0 +1,38 @@
+"""
+Importances
+^^^^^^^^^^^^^^^^^^^^
+
+This example shows how to use the plugin Importances.
+Note that other plugins use the same interfaces and can be used in the same fashion.
+"""
+
+from deepcave.plugins.hyperparameter.importances import Importances
+from deepcave.runs.converters.deepcave import DeepCAVERun
+from pathlib import Path
+
+
+if __name__ == "__main__":
+    # Instantiate the run
+    run = DeepCAVERun.from_path(Path("logs/DeepCAVE/minimal/run_2"))
+
+    objective_id = run.get_objective_ids()[0]
+    budget_ids = run.get_budget_ids()
+
+    # Instantiate the plugin
+    plugin = Importances()
+    inputs = plugin.generate_inputs(
+        hyperparameter_names=run.configspace.get_hyperparameter_names(),
+        objective_id=objective_id,
+        budget_ids=budget_ids,
+        method="global",
+        n_hps=3,
+        n_trees=10
+    )
+    # Note: Filter variables are not considered.
+    outputs = plugin.generate_outputs(run, inputs)
+
+    # Finally, you can load the figure. Here, the filter variables play a role.
+    # Alternatively: Use the matplotlib output (`load_mpl_outputs`) if available.
+    figure = plugin.load_outputs(run, inputs, outputs)  # plotly.go figure
+    figure.write_image("examples/api/importances.png", scale=2.)
+    # figure.show()