Merge pull request #228 from automl/development

Merge version 1.4

Author: mwever

CHANGELOG.md

@@ -1,21 +1,23 @@
-# Version 1.3.9
+# Version 1.4
+
+## Converter Documentation
+- Added documentation to make it visible which converters cant handle instances
+- Added documentation to give some information about limitations (and capabilities) of the converters
+
+## Documentation
+- Added the hint that for the api example the example records need to be run first to create the run.
+- Added links to GitHub pages in the web-based UI for help and more details on the method.
 
 ## Parallel Coordinates
 - Set the margin of the graph so it gets dynamically computed depending on the length of the labels.
 
-# Version 1.3.6
-
 ## New SMAC version compatibility
 - The smac3v2 converter can now also handle the output of the new smac version
 
-# Version 1.3.5
-
 ## Converter
 - Added a new converter to handle RayTune runs
 - Added example RayTune runs to logs
 
-# Version 1.3.5
-
 ## Access Specifier
 - Changed access specifier from '_fit' to 'fit' in the RF surrogate
 

Makefile

@@ -2,7 +2,7 @@
 # are usually completed in github actions.
 
 SHELL := /bin/bash
-VERSION := 1.3.4
+VERSION := 1.4
 
 NAME := DeepCAVE
 PACKAGE_NAME := deepcave

deepcave/__init__.py

@@ -44,12 +44,13 @@
     "Source Code": "https://github.com/automl/deepcave",
 }
 copyright = f"Copyright {datetime.date.today().strftime('%Y')}, {author}"
-version = "1.3.4"
+version = "1.4"
 
 _exec_file = sys.argv[0]
 _exec_files = ["server.py", "worker.py", "sphinx-build"]
 
 ROOT_DIR = Path(__file__).parent
+DOC_ROOT = "https://automl.github.io/DeepCAVE/main/"
 
 
 def get_app(title: str) -> Any:

deepcave/plugins/__init__.py

@@ -37,7 +37,7 @@
 from dash.development.base_component import Component
 from dash.exceptions import PreventUpdate
 
-from deepcave import ROOT_DIR, interactive
+from deepcave import ROOT_DIR, DOC_ROOT, interactive
 from deepcave.layouts import Layout
 from deepcave.runs import AbstractRun
 from deepcave.runs.group import Group, NotMergeableError
@@ -856,45 +856,23 @@ def __call__(self, render_button: bool = False) -> List[Component]:
         components = []
 
         if self.help is not None:
-            doc_path = ROOT_DIR / self.help
-            if not doc_path.exists():
-                raise FileNotFoundError(doc_path)
-
-            if doc_path.name.endswith(".rst"):
-                data = rst_to_md(doc_path)
-            else:
-                with doc_path.open("r") as file:
-                    data = file.read()
-
-            modal = html.Div(
-                [
-                    dbc.Modal(
-                        [
-                            dbc.ModalBody([dcc.Markdown(data)]),
-                        ],
-                        id=self.get_internal_id("help"),
-                        size="xl",
-                        scrollable=True,
-                        is_open=False,
-                    ),
-                ]
-            )
-
+            doc_path = DOC_ROOT + self.help
             components += [
                 html.H1(
                     [
                         html.Span(self.name),
                         dbc.Button(
                             [html.I(className="far fa-question-circle")],
                             id=self.get_internal_id("show_help"),
+                            href=doc_path,
+                            target="_blank",
                             style={"float": "right"},
                             color="primary",
                             outline=True,
                             n_clicks=0,
                         ),
                     ]
                 ),
-                modal,
             ]
         else:
             components += [html.H1(self.name)]

deepcave/plugins/budget/budget_correlation.py

@@ -54,7 +54,7 @@ class BudgetCorrelation(DynamicPlugin):
     id = "budget_correlation"
     name = "Budget Correlation"
     icon = "fas fa-coins"
-    help = "docs/plugins/budget_correlation.rst"
+    help = "plugins/budget_correlation.html"
     activate_run_selection = True
 
     @staticmethod

deepcave/plugins/hyperparameter/ablation_paths.py

@@ -59,7 +59,7 @@ class AblationPaths(StaticPlugin):
     id = "ablation_paths"
     name = "Ablation Paths"
     icon = "fas fa-sort-amount-up"
-    help = "docs/plugins/ablation_paths.rst"
+    help = "plugins/ablation_paths.html"
     activate_run_selection = True
 
     @staticmethod

deepcave/plugins/hyperparameter/configuration_cube.py

@@ -60,7 +60,7 @@ class ConfigurationCube(DynamicPlugin):
     name = "Configuration Cube"
     icon = "fas fa-cube"
     activate_run_selection = True
-    help = "docs/plugins/configuration_cube.rst"
+    help = "plugins/configuration_cube.html"
 
     @staticmethod
     def get_input_layout(register: Callable) -> List[dbc.Row]:

deepcave/plugins/hyperparameter/importances.py

@@ -66,7 +66,7 @@ class Importances(StaticPlugin):
     id = "importances"
     name = "Importances"
     icon = "far fa-star"
-    help = "docs/plugins/importances.rst"
+    help = "plugins/importances.html"
     activate_run_selection = True
 
     @staticmethod

deepcave/plugins/hyperparameter/parallel_coordinates.py

@@ -53,7 +53,7 @@ class ParallelCoordinates(StaticPlugin):
     name = "Parallel Coordinates"
     icon = "far fa-map"
     activate_run_selection = True
-    help = "docs/plugins/parallel_coordinates.rst"
+    help = "plugins/parallel_coordinates.html"
 
     @staticmethod
     def get_input_layout(register: Callable) -> List[Any]:

deepcave/plugins/hyperparameter/pdp.py

@@ -63,7 +63,7 @@ class PartialDependencies(StaticPlugin):
     id = "pdp"
     name = "Partial Dependencies"
     icon = "fas fa-grip-lines"
-    help = "docs/plugins/partial_dependencies.rst"
+    help = "plugins/partial_dependencies.html"
     activate_run_selection = True
 
     @staticmethod