- Ablation: Provide an evaluator of the ablation paths.
"""
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
-import copy
-from collections import OrderedDict
+import copy
+from collections import OrderedDict
-import numpy as np
+import numpy as np
-from deepcave.evaluators.epm.random_forest_surrogate import RandomForestSurrogate
-from deepcave.runs import AbstractRun
-from deepcave.runs.objective import Objective
-from deepcave.utils.logs import get_logger
+from deepcave.evaluators.epm.random_forest_surrogate import RandomForestSurrogate
+from deepcave.runs import AbstractRun
+from deepcave.runs.objective import Objective
+from deepcave.utils.logs import get_logger
[docs]
-class Ablation:
+class Ablation:
"""
Provide an evaluator of the ablation paths.
@@ -865,7 +865,7 @@ Source code for deepcave.evaluators.ablation
Gets changed step by step towards the incumbent configuration.
"""
- def __init__(self, run: AbstractRun):
+ def __init__(self, run: AbstractRun):
self.run = run
self.cs = run.configspace
self.hp_names = list(self.cs.keys())
@@ -875,7 +875,7 @@ Source code for deepcave.evaluators.ablation
[docs]
- def calculate(
+ def calculate(
self,
objectives: Optional[Union[Objective, List[Objective]]], # noqa
budget: Optional[Union[int, float]] = None, # noqa
@@ -982,7 +982,7 @@ Source code for deepcave.evaluators.ablation
[docs]
- def get_ablation_performances(self) -> Optional[Dict[Any, Any]]:
+ def get_ablation_performances(self) -> Optional[Dict[Any, Any]]:
"""
Get the ablation performances.
@@ -1003,7 +1003,7 @@ Source code for deepcave.evaluators.ablation
[docs]
- def get_ablation_improvements(self) -> Optional[Dict[Any, Any]]:
+ def get_ablation_improvements(self) -> Optional[Dict[Any, Any]]:
"""
Get the ablation improvements.
@@ -1023,7 +1023,7 @@ Source code for deepcave.evaluators.ablation
return self.improvements
- def _ablation(
+ def _ablation(
self,
objective: Objective,
budget: Optional[Union[int, float]],
@@ -1111,7 +1111,7 @@ Source code for deepcave.evaluators.ablation
- © Copyright Copyright 2024, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
+ © Copyright Copyright 2025, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
diff --git a/main/_modules/deepcave/evaluators/epm/fanova_forest.html b/main/_modules/deepcave/evaluators/epm/fanova_forest.html
index 6a31e4dd..f2122d7f 100644
--- a/main/_modules/deepcave/evaluators/epm/fanova_forest.html
+++ b/main/_modules/deepcave/evaluators/epm/fanova_forest.html
@@ -21,7 +21,7 @@
-
+
@@ -825,22 +825,22 @@ Source code for deepcave.evaluators.epm.fanova_forest
- FanovaForest: A fANOVA forest wrapper for pyrfr.
"""
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
-import itertools as it
+import itertools as it
-import numpy as np
-import pyrfr
-import pyrfr.regression as regression
-import pyrfr.util
-from ConfigSpace import ConfigurationSpace
+import numpy as np
+import pyrfr
+import pyrfr.regression as regression
+import pyrfr.util
+from ConfigSpace import ConfigurationSpace
-from deepcave.evaluators.epm.random_forest import RandomForest
+from deepcave.evaluators.epm.random_forest import RandomForest
[docs]
-class FanovaForest(RandomForest):
+class FanovaForest(RandomForest):
"""
A fANOVA forest wrapper for pyrfr.
@@ -870,7 +870,7 @@ Source code for deepcave.evaluators.epm.fanova_forest
The number of Hyperparameters to sample.
"""
- def __init__(
+ def __init__(
self,
configspace: ConfigurationSpace,
n_trees: int = 10,
@@ -904,7 +904,7 @@ Source code for deepcave.evaluators.epm.fanova_forest
self.cutoffs = cutoffs
- def _get_model(self) -> regression.base_tree:
+ def _get_model(self) -> regression.base_tree:
"""
Return the internal model.
@@ -915,7 +915,7 @@ Source code for deepcave.evaluators.epm.fanova_forest
"""
return regression.fanova_forest()
- def _train(self, X: np.ndarray, Y: np.ndarray) -> None:
+ def _train(self, X: np.ndarray, Y: np.ndarray) -> None:
"""
Train the Random Forest on X and Y.
@@ -979,7 +979,7 @@ Source code for deepcave.evaluators.epm.fanova_forest
[docs]
- def compute_marginals(
+ def compute_marginals(
self, hp_ids: Union[List[int], Tuple[int, ...]], depth: int = 1
) -> Tuple[Dict[Tuple[int, ...], List[Any]], Dict[Tuple[int, ...], List[Any]],]:
"""
@@ -1089,7 +1089,7 @@ Source code for deepcave.evaluators.epm.fanova_forest
- © Copyright Copyright 2024, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
+ © Copyright Copyright 2025, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
diff --git a/main/_modules/deepcave/evaluators/epm/random_forest.html b/main/_modules/deepcave/evaluators/epm/random_forest.html
index 39fbceca..e7640d26 100644
--- a/main/_modules/deepcave/evaluators/epm/random_forest.html
+++ b/main/_modules/deepcave/evaluators/epm/random_forest.html
@@ -21,7 +21,7 @@
-
+
@@ -828,25 +828,25 @@ Source code for deepcave.evaluators.epm.random_forest
PYRFR_MAPPING : Dict[str, str]
"""
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
-import functools
-import warnings
+import functools
+import warnings
-import numpy as np
-import pyrfr.regression as regression
-from ConfigSpace import ConfigurationSpace
-from ConfigSpace.hyperparameters import (
+import numpy as np
+import pyrfr.regression as regression
+from ConfigSpace import ConfigurationSpace
+from ConfigSpace.hyperparameters import (
CategoricalHyperparameter,
Constant,
UniformFloatHyperparameter,
UniformIntegerHyperparameter,
)
-from sklearn.decomposition import PCA
-from sklearn.exceptions import NotFittedError
-from sklearn.preprocessing import MinMaxScaler
+from sklearn.decomposition import PCA
+from sklearn.exceptions import NotFittedError
+from sklearn.preprocessing import MinMaxScaler
-from deepcave.evaluators.epm.utils import get_types
+from deepcave.evaluators.epm.utils import get_types
VERY_SMALL_NUMBER = 1e-10
PYRFR_MAPPING = {
@@ -863,7 +863,7 @@ Source code for deepcave.evaluators.epm.random_forest
[docs]
-class RandomForest:
+class RandomForest:
"""
A random forest wrapper for pyrfr.
@@ -900,7 +900,7 @@ Source code for deepcave.evaluators.epm.random_forest
The instance features.
"""
- def __init__(
+ def __init__(
self,
configspace: ConfigurationSpace,
n_trees: int = 16,
@@ -952,7 +952,7 @@ Source code for deepcave.evaluators.epm.random_forest
bootstrapping=bootstrapping,
)
- def _get_model(self) -> regression.base_tree:
+ def _get_model(self) -> regression.base_tree:
"""
Return the internal model.
@@ -963,7 +963,7 @@ Source code for deepcave.evaluators.epm.random_forest
"""
return regression.binary_rss_forest()
- def _get_model_options(self, **kwargs: Union[int, float, bool]) -> regression.forest_opts:
+ def _get_model_options(self, **kwargs: Union[int, float, bool]) -> regression.forest_opts:
"""
Get model options from kwargs.
@@ -983,14 +983,14 @@ Source code for deepcave.evaluators.epm.random_forest
# Now the options are set
options = regression.forest_opts()
- def rgetattr(obj: object, attr: str, *args: Any) -> Any:
- def _getattr(obj: object, attr: object) -> Any:
+ def rgetattr(obj: object, attr: str, *args: Any) -> Any:
+ def _getattr(obj: object, attr: object) -> Any:
attr = str(attr)
return getattr(obj, attr, *args)
return functools.reduce(_getattr, [obj] + attr.split("."))
- def rsetattr(obj: object, attr: str, val: Any) -> None:
+ def rsetattr(obj: object, attr: str, val: Any) -> None:
pre, _, post = attr.rpartition(".")
return setattr(rgetattr(obj, pre) if pre else obj, post, val)
@@ -1000,7 +1000,7 @@ Source code for deepcave.evaluators.epm.random_forest
return options
- def _impute_inactive(self, X: np.ndarray) -> np.ndarray:
+ def _impute_inactive(self, X: np.ndarray) -> np.ndarray:
"""
Impute inactive values in X.
@@ -1045,7 +1045,7 @@ Source code for deepcave.evaluators.epm.random_forest
return X
- def _check_dimensions(self, X: np.ndarray, Y: Optional[np.ndarray] = None) -> None:
+ def _check_dimensions(self, X: np.ndarray, Y: Optional[np.ndarray] = None) -> None:
"""
Check if the dimensions of X and Y are correct with respect to features.
@@ -1073,7 +1073,7 @@ Source code for deepcave.evaluators.epm.random_forest
if X.shape[0] != Y.shape[0]:
raise ValueError(f"X.shape[0] ({X.shape[0]}) != y.shape[0] ({Y.shape[0]})")
- def _get_data_container(
+ def _get_data_container(
self, X: np.ndarray, y: np.ndarray
) -> regression.default_data_container:
"""
@@ -1109,7 +1109,7 @@ Source code for deepcave.evaluators.epm.random_forest
[docs]
- def train(self, X: np.ndarray, Y: np.ndarray) -> None:
+ def train(self, X: np.ndarray, Y: np.ndarray) -> None:
"""
Train the random forest on X and Y.
@@ -1153,7 +1153,7 @@ Source code for deepcave.evaluators.epm.random_forest
self._train(X, Y)
- def _train(self, X: np.ndarray, Y: np.ndarray) -> None:
+ def _train(self, X: np.ndarray, Y: np.ndarray) -> None:
"""
Train the random forest on X and Y.
@@ -1176,7 +1176,7 @@ Source code for deepcave.evaluators.epm.random_forest
[docs]
- def predict(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
+ def predict(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
"""
Predict means and variances for a given X.
@@ -1218,7 +1218,7 @@ Source code for deepcave.evaluators.epm.random_forest
return mean, var
- def _predict(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
+ def _predict(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
"""
Predict means and variances for a given X.
@@ -1277,7 +1277,7 @@ Source code for deepcave.evaluators.epm.random_forest
[docs]
- def predict_marginalized(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
+ def predict_marginalized(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
"""
Predict mean and variance marginalized over all instances.
@@ -1345,7 +1345,7 @@ Source code for deepcave.evaluators.epm.random_forest
[docs]
- def get_leaf_values(self, x: np.ndarray) -> regression.binary_rss_forest:
+ def get_leaf_values(self, x: np.ndarray) -> regression.binary_rss_forest:
"""
Get the leaf values of the model.
@@ -1383,7 +1383,7 @@ Source code for deepcave.evaluators.epm.random_forest
- © Copyright Copyright 2024, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
+ © Copyright Copyright 2025, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
diff --git a/main/_modules/deepcave/evaluators/epm/random_forest_surrogate.html b/main/_modules/deepcave/evaluators/epm/random_forest_surrogate.html
index 8a2d9d94..2820a84c 100644
--- a/main/_modules/deepcave/evaluators/epm/random_forest_surrogate.html
+++ b/main/_modules/deepcave/evaluators/epm/random_forest_surrogate.html
@@ -21,7 +21,7 @@
-
+
@@ -824,25 +824,25 @@ Source code for deepcave.evaluators.epm.random_forest_surrogate
- RandomForestSurrogate: Random forest surrogate for the pyPDP package.
"""
-from typing import Optional, Tuple
+from typing import Optional, Tuple
-import ConfigSpace as CS
-import numpy as np
-from pyPDP.surrogate_models import SurrogateModel
+import ConfigSpace as CS
+import numpy as np
+from pyPDP.surrogate_models import SurrogateModel
-from deepcave.evaluators.epm.random_forest import RandomForest
+from deepcave.evaluators.epm.random_forest import RandomForest
[docs]
-class RandomForestSurrogate(SurrogateModel):
+class RandomForestSurrogate(SurrogateModel):
"""
Random forest surrogate for the pyPDP package.
Predict deviations and fit the model.
"""
- def __init__(
+ def __init__(
self,
configspace: CS.ConfigurationSpace,
seed: Optional[int] = None,
@@ -853,7 +853,7 @@ Source code for deepcave.evaluators.epm.random_forest_surrogate
[docs]
- def predict(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
+ def predict(self, X: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
"""
Predict the deviations.
@@ -871,7 +871,7 @@ Source code for deepcave.evaluators.epm.random_forest_surrogate
return means[:, 0], stds[:, 0]
- def _fit(self, X: np.ndarray, y: np.ndarray) -> None:
+ def _fit(self, X: np.ndarray, y: np.ndarray) -> None:
"""
Train the surrogate model.
@@ -905,7 +905,7 @@ Source code for deepcave.evaluators.epm.random_forest_surrogate
diff --git a/main/_modules/deepcave/evaluators/epm/utils.html b/main/_modules/deepcave/evaluators/epm/utils.html
index 25da717a..a361a583 100644
--- a/main/_modules/deepcave/evaluators/epm/utils.html
+++ b/main/_modules/deepcave/evaluators/epm/utils.html
@@ -21,7 +21,7 @@
-
+
@@ -820,11 +820,11 @@ Source code for deepcave.evaluators.epm.utils
as well as the bounds of the Hyperparameters.
"""
-from typing import List, Optional, Tuple
+from typing import List, Optional, Tuple
-import numpy as np
-from ConfigSpace import ConfigurationSpace
-from ConfigSpace.hyperparameters import (
+import numpy as np
+from ConfigSpace import ConfigurationSpace
+from ConfigSpace.hyperparameters import (
BetaFloatHyperparameter,
BetaIntegerHyperparameter,
CategoricalHyperparameter,
@@ -839,7 +839,7 @@ Source code for deepcave.evaluators.epm.utils
[docs]
-def get_types(
+def get_types(
config_space: ConfigurationSpace,
instance_features: Optional[np.ndarray] = None,
) -> Tuple[List[int], List[Tuple[float, float]]]:
@@ -983,7 +983,7 @@ Source code for deepcave.evaluators.epm.utils
- © Copyright Copyright 2024, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
+ © Copyright Copyright 2025, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
diff --git a/main/_modules/deepcave/evaluators/fanova.html b/main/_modules/deepcave/evaluators/fanova.html
index 3b391b6d..bb727a48 100644
--- a/main/_modules/deepcave/evaluators/fanova.html
+++ b/main/_modules/deepcave/evaluators/fanova.html
@@ -21,7 +21,7 @@
-
+
@@ -824,22 +824,22 @@ Source code for deepcave.evaluators.fanova
- fANOVA: Calculate and provide midpoints and sizes.
"""
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
-import itertools as it
+import itertools as it
-import numpy as np
+import numpy as np
-from deepcave.constants import COMBINED_COST_NAME
-from deepcave.evaluators.epm.fanova_forest import FanovaForest
-from deepcave.runs import AbstractRun
-from deepcave.runs.objective import Objective
-from deepcave.utils.logs import get_logger
+from deepcave.constants import COMBINED_COST_NAME
+from deepcave.evaluators.epm.fanova_forest import FanovaForest
+from deepcave.runs import AbstractRun
+from deepcave.runs.objective import Objective
+from deepcave.utils.logs import get_logger
[docs]
-class fANOVA:
+class fANOVA:
"""
Calculate and provide midpoints and sizes.
@@ -859,7 +859,7 @@ Source code for deepcave.evaluators.fanova
The number of trees.
"""
- def __init__(self, run: AbstractRun):
+ def __init__(self, run: AbstractRun):
if run.configspace is None:
raise RuntimeError("The run needs to be initialized.")
@@ -871,7 +871,7 @@ Source code for deepcave.evaluators.fanova
[docs]
- def calculate(
+ def calculate(
self,
objectives: Optional[Union[Objective, List[Objective]]] = None,
budget: Optional[Union[int, float]] = None,
@@ -919,7 +919,7 @@ Source code for deepcave.evaluators.fanova
[docs]
- def get_importances(
+ def get_importances(
self, hp_names: Optional[List[str]] = None, depth: int = 1, sort: bool = True
) -> Dict[Union[str, Tuple[str, ...]], Tuple[float, float, float, float]]:
"""
@@ -1168,7 +1168,7 @@ Source code for deepcave.evaluators.fanova
diff --git a/main/_modules/deepcave/evaluators/footprint.html b/main/_modules/deepcave/evaluators/footprint.html
index b31a2151..91bb8e9c 100644
--- a/main/_modules/deepcave/evaluators/footprint.html
+++ b/main/_modules/deepcave/evaluators/footprint.html
@@ -21,7 +21,7 @@
-
+
@@ -825,30 +825,30 @@ Source code for deepcave.evaluators.footprint
- Footprint: Can train and create a footprint of a run.
"""
-from typing import List, Optional, Tuple, Union
+from typing import List, Optional, Tuple, Union
-import numpy as np
-from ConfigSpace.hyperparameters import (
+import numpy as np
+from ConfigSpace.hyperparameters import (
CategoricalHyperparameter,
Constant,
Hyperparameter,
)
-from sklearn.ensemble import RandomForestRegressor
-from sklearn.manifold import MDS
-from tqdm import tqdm
+from sklearn.ensemble import RandomForestRegressor
+from sklearn.manifold import MDS
+from tqdm import tqdm
-from deepcave.constants import BORDER_CONFIG_ID, RANDOM_CONFIG_ID
-from deepcave.runs import AbstractRun, Status
-from deepcave.runs.objective import Objective
-from deepcave.utils.configspace import sample_border_config, sample_random_config
-from deepcave.utils.logs import get_logger
+from deepcave.constants import BORDER_CONFIG_ID, RANDOM_CONFIG_ID
+from deepcave.runs import AbstractRun, Status
+from deepcave.runs.objective import Objective
+from deepcave.utils.configspace import sample_border_config, sample_random_config
+from deepcave.utils.logs import get_logger
logger = get_logger(__name__)
[docs]
-class Footprint:
+class Footprint:
"""
Can train and create a footprint of a run.
@@ -863,7 +863,7 @@ Source code for deepcave.evaluators.footprint
The configuration space of the run.
"""
- def __init__(self, run: AbstractRun):
+ def __init__(self, run: AbstractRun):
if run.configspace is None:
raise RuntimeError("The run needs to be initialized.")
@@ -887,7 +887,7 @@ Source code for deepcave.evaluators.footprint
self._trained = False
self._reset()
- def _reset(self) -> None:
+ def _reset(self) -> None:
"""Reset the footprint."""
self._objective_model: Optional[RandomForestRegressor] = None
self._area_model: Optional[RandomForestRegressor] = None
@@ -901,7 +901,7 @@ Source code for deepcave.evaluators.footprint
[docs]
- def calculate(
+ def calculate(
self,
objective: Objective,
budget: Union[int, float],
@@ -1050,7 +1050,7 @@ Source code for deepcave.evaluators.footprint
[docs]
- def get_surface(
+ def get_surface(
self, details: float = 0.5, performance: bool = True
) -> Tuple[List, List, List]:
"""
@@ -1111,7 +1111,7 @@ Source code for deepcave.evaluators.footprint
[docs]
- def get_points(self, category: str = "configs") -> Tuple[List[float], List[float], List[int]]:
+ def get_points(self, category: str = "configs") -> Tuple[List[float], List[float], List[int]]:
"""
Return the points of the multidimensional scaling (MDS) plot.
@@ -1157,7 +1157,7 @@ Source code for deepcave.evaluators.footprint
return X, Y, config_ids
- def _get_max_distance(self) -> float:
+ def _get_max_distance(self) -> float:
"""
Calculate the maximum distance between all configs.
@@ -1179,7 +1179,7 @@ Source code for deepcave.evaluators.footprint
return max_distance
- def _get_distance(self, x: np.ndarray, y: np.ndarray) -> float:
+ def _get_distance(self, x: np.ndarray, y: np.ndarray) -> float:
"""
Calculate distance between x and y. Both arrays must have the same length.
@@ -1210,7 +1210,7 @@ Source code for deepcave.evaluators.footprint
return d
- def _get_distances(self, X: np.ndarray) -> np.ndarray:
+ def _get_distances(self, X: np.ndarray) -> np.ndarray:
"""
Get the distances between the configurations.
@@ -1237,7 +1237,7 @@ Source code for deepcave.evaluators.footprint
return distances
- def _init_distances(
+ def _init_distances(
self, X: np.ndarray, config_ids: List[int], exclude_configs: bool = False
) -> None:
"""
@@ -1262,7 +1262,7 @@ Source code for deepcave.evaluators.footprint
self._config_ids = []
self._distances = np.zeros((0, 0))
- def _update_distances(
+ def _update_distances(
self,
config: np.ndarray,
config_id: int,
@@ -1332,7 +1332,7 @@ Source code for deepcave.evaluators.footprint
return rejected
- def _get_depth(self, hp: Hyperparameter) -> int:
+ def _get_depth(self, hp: Hyperparameter) -> int:
"""
Get depth (generations above) in configuration space of a given hyperparameter (HP).
@@ -1365,7 +1365,7 @@ Source code for deepcave.evaluators.footprint
return d
- def _get_mds(self) -> np.ndarray:
+ def _get_mds(self) -> np.ndarray:
"""
Perform multidimensional scaling (MDS) on the internal distances.
@@ -1385,7 +1385,7 @@ Source code for deepcave.evaluators.footprint
mds = MDS(n_components=2, dissimilarity="precomputed", random_state=0)
return mds.fit_transform(self._distances)
- def _train_on_objective(self, X: np.ndarray, Y: np.ndarray) -> None:
+ def _train_on_objective(self, X: np.ndarray, Y: np.ndarray) -> None:
"""
Train the random forest on the performance.
@@ -1400,7 +1400,7 @@ Source code for deepcave.evaluators.footprint
self._objective_model = RandomForestRegressor(random_state=0)
self._objective_model.fit(X, Y)
- def _train_on_areas(self) -> None:
+ def _train_on_areas(self) -> None:
"""
Train the random forest on the "valid" areas.
@@ -1466,7 +1466,7 @@ Source code for deepcave.evaluators.footprint
- © Copyright Copyright 2024, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
+ © Copyright Copyright 2025, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
diff --git a/main/_modules/deepcave/evaluators/lpi.html b/main/_modules/deepcave/evaluators/lpi.html
index 7d6a047f..a38c0fd5 100644
--- a/main/_modules/deepcave/evaluators/lpi.html
+++ b/main/_modules/deepcave/evaluators/lpi.html
@@ -21,7 +21,7 @@
-
+
@@ -822,29 +822,29 @@ Source code for deepcave.evaluators.lpi
- LPI: This class calculates the local parameter importance (LPI).
"""
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
-import numpy as np
-from ConfigSpace import Configuration
-from ConfigSpace.c_util import change_hp_value
-from ConfigSpace.exceptions import ForbiddenValueError
-from ConfigSpace.hyperparameters import (
+import numpy as np
+from ConfigSpace import Configuration
+from ConfigSpace.c_util import change_hp_value
+from ConfigSpace.exceptions import ForbiddenValueError
+from ConfigSpace.hyperparameters import (
CategoricalHyperparameter,
NumericalHyperparameter,
)
-from ConfigSpace.types import Array, f64
-from ConfigSpace.util import impute_inactive_values
+from ConfigSpace.types import Array, f64
+from ConfigSpace.util import impute_inactive_values
-from deepcave.constants import COMBINED_COST_NAME
-from deepcave.evaluators.epm.fanova_forest import FanovaForest
-from deepcave.runs import AbstractRun
-from deepcave.runs.objective import Objective
+from deepcave.constants import COMBINED_COST_NAME
+from deepcave.evaluators.epm.fanova_forest import FanovaForest
+from deepcave.runs import AbstractRun
+from deepcave.runs.objective import Objective
# https://github.com/automl/ParameterImportance/blob/f4950593ee627093fc30c0847acc5d8bf63ef84b/pimp/evaluator/local_parameter_importance.py#L27
[docs]
-class LPI:
+class LPI:
"""
Calculate the local parameter importance (LPI).
@@ -874,7 +874,7 @@ Source code for deepcave.evaluators.lpi
A random state with a given seed value.
"""
- def __init__(self, run: AbstractRun):
+ def __init__(self, run: AbstractRun):
self.run = run
self.cs = run.configspace
self.hp_names = list(self.cs.keys())
@@ -883,7 +883,7 @@ Source code for deepcave.evaluators.lpi
[docs]
- def calculate(
+ def calculate(
self,
objectives: Optional[Union[Objective, List[Objective]]] = None,
budget: Optional[Union[int, float]] = None,
@@ -1056,7 +1056,7 @@ Source code for deepcave.evaluators.lpi
[docs]
- def get_importances(self, hp_names: List[str]) -> Dict[str, Tuple[float, float]]:
+ def get_importances(self, hp_names: List[str]) -> Dict[str, Tuple[float, float]]:
"""
Return the importances.
@@ -1101,7 +1101,7 @@ Source code for deepcave.evaluators.lpi
return importances
- def _get_neighborhood(self) -> Dict[str, List[Union[np.ndarray, List[np.ndarray]]]]:
+ def _get_neighborhood(self) -> Dict[str, List[Union[np.ndarray, List[np.ndarray]]]]:
"""
Slight modification of ConfigSpace's get_one_exchange neighborhood.
@@ -1190,7 +1190,7 @@ Source code for deepcave.evaluators.lpi
return neighborhood
- def _predict_mean_var(self, config: Configuration) -> Tuple[np.ndarray, np.ndarray]:
+ def _predict_mean_var(self, config: Configuration) -> Tuple[np.ndarray, np.ndarray]:
"""
Small wrapper to predict marginalized over instances.
@@ -1235,7 +1235,7 @@ Source code for deepcave.evaluators.lpi
diff --git a/main/_modules/deepcave/evaluators/mo_ablation.html b/main/_modules/deepcave/evaluators/mo_ablation.html
index 3fcc7f76..3314681c 100644
--- a/main/_modules/deepcave/evaluators/mo_ablation.html
+++ b/main/_modules/deepcave/evaluators/mo_ablation.html
@@ -21,7 +21,7 @@
-
+
@@ -827,23 +827,23 @@ Source code for deepcave.evaluators.mo_ablation
<
- Ablation: Provide an evaluator of the ablation paths.
"""
-from typing import Any, List, Optional, Tuple, Union
+from typing import Any, List, Optional, Tuple, Union
-import copy
+import copy
-import numpy as np
-import pandas as pd
+import numpy as np
+import pandas as pd
-from deepcave.evaluators.ablation import Ablation
-from deepcave.evaluators.epm.random_forest_surrogate import RandomForestSurrogate
-from deepcave.runs import AbstractRun
-from deepcave.runs.objective import Objective
-from deepcave.utils.multi_objective_importance import get_weightings
+from deepcave.evaluators.ablation import Ablation
+from deepcave.evaluators.epm.random_forest_surrogate import RandomForestSurrogate
+from deepcave.runs import AbstractRun
+from deepcave.runs.objective import Objective
+from deepcave.utils.multi_objective_importance import get_weightings
[docs]
-class MOAblation(Ablation):
+class MOAblation(Ablation):
"""
Provide an evaluator of the ablation paths.
@@ -868,14 +868,14 @@ Source code for deepcave.evaluators.mo_ablation
<
Gets changed step by step towards the incumbent configuration.
"""
- def __init__(self, run: AbstractRun):
+ def __init__(self, run: AbstractRun):
super().__init__(run)
self.models: List = []
self.df_importances = pd.DataFrame([])
[docs]
- def get_importances(self) -> str:
+ def get_importances(self) -> str:
"""
Return the importance scores.
@@ -898,7 +898,7 @@ Source code for deepcave.evaluators.mo_ablation
<
[docs]
- def predict(self, cfg: list[Any], weighting: np.ndarray) -> Tuple[float, float]:
+ def predict(self, cfg: list[Any], weighting: np.ndarray) -> Tuple[float, float]:
"""
Predict the performance of the input configuration.
@@ -928,7 +928,7 @@ Source code for deepcave.evaluators.mo_ablation
<
[docs]
- def calculate(
+ def calculate(
self,
objectives: Optional[Union[Objective, List[Objective]]], # noqa
budget: Optional[Union[int, float]] = None, # noqa
@@ -999,7 +999,7 @@ Source code for deepcave.evaluators.mo_ablation
<
[docs]
- def calculate_ablation_path(
+ def calculate_ablation_path(
self,
df: pd.DataFrame,
objectives_normed: List[str],
@@ -1101,7 +1101,7 @@ Source code for deepcave.evaluators.mo_ablation
<
[docs]
- def ablation(
+ def ablation(
self,
budget: Optional[Union[int, float]],
incumbent_config: Any,
@@ -1187,7 +1187,7 @@ Source code for deepcave.evaluators.mo_ablation
<
diff --git a/main/_modules/deepcave/evaluators/mo_fanova.html b/main/_modules/deepcave/evaluators/mo_fanova.html
index 6b3c90fc..3ca0dd6a 100644
--- a/main/_modules/deepcave/evaluators/mo_fanova.html
+++ b/main/_modules/deepcave/evaluators/mo_fanova.html
@@ -21,7 +21,7 @@
-
+
@@ -824,20 +824,20 @@ Source code for deepcave.evaluators.mo_fanova
- fANOVA: Calculate and provide midpoints and sizes.
"""
-from typing import List, Optional, Union
+from typing import List, Optional, Union
-import pandas as pd
+import pandas as pd
-from deepcave.evaluators.epm.fanova_forest import FanovaForest
-from deepcave.evaluators.fanova import fANOVA
-from deepcave.runs import AbstractRun
-from deepcave.runs.objective import Objective
-from deepcave.utils.multi_objective_importance import get_weightings
+from deepcave.evaluators.epm.fanova_forest import FanovaForest
+from deepcave.evaluators.fanova import fANOVA
+from deepcave.runs import AbstractRun
+from deepcave.runs.objective import Objective
+from deepcave.utils.multi_objective_importance import get_weightings
[docs]
-class MOfANOVA(fANOVA):
+class MOfANOVA(fANOVA):
"""
Multi-Objective fANOVA.
@@ -847,7 +847,7 @@ Source code for deepcave.evaluators.mo_fanova
(multi-objective case).
"""
- def __init__(self, run: AbstractRun):
+ def __init__(self, run: AbstractRun):
if run.configspace is None:
raise RuntimeError("The run needs to be initialized.")
@@ -856,7 +856,7 @@ Source code for deepcave.evaluators.mo_fanova
[docs]
- def calculate(
+ def calculate(
self,
objectives: Optional[Union[Objective, List[Objective]]] = None,
budget: Optional[Union[int, float]] = None,
@@ -932,7 +932,7 @@ Source code for deepcave.evaluators.mo_fanova
[docs]
- def get_importances_(self, hp_names: Optional[List[str]] = None) -> str:
+ def get_importances_(self, hp_names: Optional[List[str]] = None) -> str:
"""
Return the importance scores from the passed Hyperparameter names.
@@ -985,7 +985,7 @@ Source code for deepcave.evaluators.mo_fanova
- © Copyright Copyright 2024, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
+ © Copyright Copyright 2025, S. Segel and H. Graf and E. Bergman and K. Thieme and L. Fehring and A. Tornede and R. Sass and A. Biedenkapp and F. Hutter and M. Lindauer.
diff --git a/main/_modules/deepcave/evaluators/mo_lpi.html b/main/_modules/deepcave/evaluators/mo_lpi.html
index be7ec0a7..5b1c1d4a 100644
--- a/main/_modules/deepcave/evaluators/mo_lpi.html
+++ b/main/_modules/deepcave/evaluators/mo_lpi.html
@@ -21,7 +21,7 @@
-
+
@@ -822,25 +822,25 @@ Source code for deepcave.evaluators.mo_lpi
- LPI: This class calculates the local parameter importance (LPI).
"""
-from typing import Dict, List, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union
-import numpy as np
-import pandas as pd
-from ConfigSpace import Configuration
-from ConfigSpace.c_util import change_hp_value
-from ConfigSpace.util import impute_inactive_values
+import numpy as np
+import pandas as pd
+from ConfigSpace import Configuration
+from ConfigSpace.c_util import change_hp_value
+from ConfigSpace.util import impute_inactive_values
-from deepcave.evaluators.epm.fanova_forest import FanovaForest
-from deepcave.evaluators.lpi import LPI
-from deepcave.runs import AbstractRun
-from deepcave.runs.objective import Objective
-from deepcave.utils.multi_objective_importance import get_weightings
+from deepcave.evaluators.epm.fanova_forest import FanovaForest
+from deepcave.evaluators.lpi import LPI
+from deepcave.runs import AbstractRun
+from deepcave.runs.objective import Objective
+from deepcave.utils.multi_objective_importance import get_weightings
# https://github.com/automl/ParameterImportance/blob/f4950593ee627093fc30c0847acc5d8bf63ef84b/pimp/evaluator/local_parameter_importance.py#L27
[docs]
-class MOLPI(LPI):
+class MOLPI(LPI):
"""
Calculate the multi-objective local parameter importance (LPI).
@@ -873,13 +873,13 @@ Source code for deepcave.evaluators.mo_lpi
A random state with a given seed value.
"""
- def __init__(self, run: AbstractRun):
+ def __init__(self, run: AbstractRun):
super().__init__(run)
self.importances: Optional[pd.DataFrame] = None
[docs]
- def calculate(
+ def calculate(
self,
objectives: Optional[Union[Objective, List[Objective]]] = None,
budget: Optional[Union[int, float]] = None,
@@ -967,7 +967,7 @@ Source code for deepcave.evaluators.mo_lpi
[docs]
- def calc_one_weighting(self) -> Dict[str, Tuple[float, float]]:
+ def calc_one_weighting(self) -> Dict[str, Tuple[float, float]]:
"""
Prepare the data after a model has be trained for one weighting.
@@ -1088,7 +1088,7 @@ Source code for deepcave.evaluators.mo_lpi
[docs]
- def get_importances_(self, hp_names: List[str]) -> str:
+ def get_importances_(self, hp_names: List[str]) -> str:
"""
Return the importance scores from the passed Hyperparameter names.
@@ -1139,7 +1139,7 @@ Source code for deepcave.evaluators.mo_lpi
diff --git a/main/_modules/deepcave/layouts.html b/main/_modules/deepcave/layouts.html
index 044c61a6..ff846b32 100644
--- a/main/_modules/deepcave/layouts.html
+++ b/main/_modules/deepcave/layouts.html
@@ -21,7 +21,7 @@
-
+
@@ -819,18 +819,18 @@ Source code for deepcave.layouts
This module provides a foundation to create layouts.
"""
-from abc import ABC, abstractmethod
-from typing import List, Union
+from abc import ABC, abstractmethod
+from typing import List, Union
-from dash.development.base_component import Component
+from dash.development.base_component import Component
-from deepcave import interactive
-from deepcave.utils.logs import get_logger
+from deepcave import interactive
+from deepcave.utils.logs import get_logger
[docs]
-class Layout(ABC):
+class Layout(ABC):
"""
A foundation for creating layouts.
@@ -840,18 +840,18 @@ Source code for deepcave.layouts
A logger for the class.
"""
- def __init__(self) -> None:
+ def __init__(self) -> None:
self.register_callbacks()
self.logger = get_logger(self.__class__.__name__)
@interactive
- def register_callbacks(self) -> None: # noqa: D102
+ def register_callbacks(self) -> None: # noqa: D102
pass
[docs]
@abstractmethod
- def __call__(self) -> Union[List[Component], Component]: # noqa: D102
+ def __call__(self) -> Union[List[Component], Component]: # noqa: D102
pass
@@ -876,7 +876,7 @@ Source code for deepcave.layouts
diff --git a/main/_modules/deepcave/layouts/header.html b/main/_modules/deepcave/layouts/header.html
index 88481967..2e4a440a 100644
--- a/main/_modules/deepcave/layouts/header.html
+++ b/main/_modules/deepcave/layouts/header.html
@@ -21,7 +21,7 @@
-
+
@@ -824,23 +824,23 @@ Source code for deepcave.layouts.header
- HeaderLayout: This class provides the header and its layout.
"""
-from typing import List, Optional, Tuple
+from typing import List, Optional, Tuple
-import os
-import time
+import os
+import time
-import dash_bootstrap_components as dbc
-import requests
-from dash import dcc, html
-from dash.dependencies import Input, Output
+import dash_bootstrap_components as dbc
+import requests
+from dash import dcc, html
+from dash.dependencies import Input, Output
-from deepcave import app, config, queue
-from deepcave.layouts import Layout
+from deepcave import app, config, queue
+from deepcave.layouts import Layout
[docs]
-class HeaderLayout(Layout):
+class HeaderLayout(Layout):
"""
Provide the header and its layout.
@@ -849,14 +849,14 @@ Source code for deepcave.layouts.header
[docs]
- def register_callbacks(self) -> None:
+ def register_callbacks(self) -> None:
"""Register and handle the callbacks."""
super().register_callbacks()
self._callback_delete_jobs()
self._callback_terminate_deepcave()
- def _callback_delete_jobs(self) -> None:
+ def _callback_delete_jobs(self) -> None:
inputs = [Input("exit-deepcave", "n_clicks")]
outputs = [
Output("exit-deepcave", "color"),
@@ -865,7 +865,7 @@ Source code for deepcave.layouts.header
]
@app.callback(inputs, outputs) # type: ignore
- def callback(n_clicks: Optional[int]) -> Tuple[str, str, bool]:
+ def callback(n_clicks: Optional[int]) -> Tuple[str, str, bool]:
# When clicking the Exit button, first existing jobs are deleted and then the button
# is updated
if n_clicks is not None:
@@ -874,12 +874,12 @@ Source code for deepcave.layouts.header
else:
return "primary", "Exit", False
- def _callback_terminate_deepcave(self) -> None:
+ def _callback_terminate_deepcave(self) -> None:
inputs = [Input("exit-deepcave", "n_clicks")]
outputs: List[Output] = []
@app.callback(inputs, outputs) # type: ignore
- def callback(n_clicks: Optional[int]) -> None:
+ def callback(n_clicks: Optional[int]) -> None:
# Then we want to terminate DeepCAVE
if n_clicks is not None:
time.sleep(1)
@@ -888,7 +888,7 @@ Source code for deepcave.layouts.header
[docs]
- def __call__(self) -> html.Header: # noqa: D102
+ def __call__(self) -> html.Header: # noqa: D102
return html.Header(
className="navbar navbar-dark sticky-top bg-dark flex-md-nowrap p-0 shadow",
children=[
@@ -923,7 +923,7 @@ Source code for deepcave.layouts.header
diff --git a/main/_modules/deepcave/layouts/not_found.html b/main/_modules/deepcave/layouts/not_found.html
index 0fa1d47e..9c5c5bea 100644
--- a/main/_modules/deepcave/layouts/not_found.html
+++ b/main/_modules/deepcave/layouts/not_found.html
@@ -21,7 +21,7 @@
-
+
@@ -821,17 +821,17 @@ Source code for deepcave.layouts.not_found
## Classes
- NotFoundLayout: Define a custom "NotFound" layout.
"""
-from typing import List
+from typing import List
-from dash import html
-from dash.development.base_component import Component
+from dash import html
+from dash.development.base_component import Component
-from deepcave.layouts import Layout
+from deepcave.layouts import Layout
[docs]
-class NotFoundLayout(Layout):
+class NotFoundLayout(Layout):
"""
Define a custom "NotFound" layout.
@@ -841,13 +841,13 @@ Source code for deepcave.layouts.not_found
The url that could not be reached.
"""
- def __init__(self, url: str) -> None:
+ def __init__(self, url: str) -> None:
super().__init__()
self.url = url
[docs]
- def __call__(self) -> List[Component]: # noqa: D102
+ def __call__(self) -> List[Component]: # noqa: D102
return [
html.H2("This page does not exists."),
html.Div(f"Tried to reach {self.url}."),
@@ -875,7 +875,7 @@ Source code for deepcave.layouts.not_found
diff --git a/main/_modules/deepcave/layouts/sidebar.html b/main/_modules/deepcave/layouts/sidebar.html
index 47ac5ea3..ae3df20a 100644
--- a/main/_modules/deepcave/layouts/sidebar.html
+++ b/main/_modules/deepcave/layouts/sidebar.html
@@ -21,7 +21,7 @@
-
+
@@ -824,22 +824,22 @@ Source code for deepcave.layouts.sidebar
- SidebarLayout: Customize the Sidebar Layout.
"""
-from typing import Dict, List, Tuple, Union
+from typing import Dict, List, Tuple, Union
-import dash_bootstrap_components as dbc
-from dash import ALL, html
-from dash.dependencies import Input, Output, State
-from dash.development.base_component import Component
-from dash_extensions.enrich import Trigger
+import dash_bootstrap_components as dbc
+from dash import ALL, html
+from dash.dependencies import Input, Output, State
+from dash.development.base_component import Component
+from dash_extensions.enrich import Trigger
-from deepcave import app, queue
-from deepcave.layouts import Layout
-from deepcave.plugins import Plugin
+from deepcave import app, queue
+from deepcave.layouts import Layout
+from deepcave.plugins import Plugin
[docs]
-class SidebarLayout(Layout):
+class SidebarLayout(Layout):
"""
Customize the Sidebar Layout.
@@ -853,7 +853,7 @@ Source code for deepcave.layouts.sidebar
A dictionary with plugins attributes corresponding to their category.
"""
- def __init__(self, categorized_plugins: Dict[str, List[Plugin]]) -> None:
+ def __init__(self, categorized_plugins: Dict[str, List[Plugin]]) -> None:
super().__init__()
self.plugins = categorized_plugins
@@ -868,14 +868,14 @@ Source code for deepcave.layouts.sidebar
[docs]
- def register_callbacks(self) -> None:
+ def register_callbacks(self) -> None:
"""Register the callbacks for the sidebar layout."""
# Update navigation items
output = Output("navigation-items", "children")
input = Input("on-page-load", "pathname")
@app.callback(output, input) # type: ignore
- def update_navigation_items(pathname: str) -> List[Component]:
+ def update_navigation_items(pathname: str) -> List[Component]:
"""
Update the navigation items.
@@ -940,7 +940,7 @@ Source code for deepcave.layouts.sidebar
Input({"type": "cancel-job", "index": ALL}, "n_clicks"),
State({"type": "cancel-job", "index": ALL}, "name"),
)
- def delete_job(n_clicks, job_ids): # type: ignore
+ def delete_job(n_clicks, job_ids): # type: ignore
"""Delete the job from the queue."""
for n_click, job_id in zip(n_clicks, job_ids):
if n_click is not None:
@@ -950,7 +950,7 @@ Source code for deepcave.layouts.sidebar
output = Output("queue-info", "children")
@app.callback(output, Trigger("global-update", "n_intervals")) # type: ignore
- def update_queue_info() -> List[Component]:
+ def update_queue_info() -> List[Component]:
"""Update the information of the queue."""
try:
all_jobs = [
@@ -1028,7 +1028,7 @@ Source code for deepcave.layouts.sidebar
[docs]
- def __call__(self) -> Union[List[Component], Component]: # noqa: D102
+ def __call__(self) -> Union[List[Component], Component]: # noqa: D102
return html.Nav(
className="col-md-3 col-lg-2 d-md-block sidebar collapse",
id="sidebarMenu",
@@ -1060,7 +1060,7 @@ Source code for deepcave.layouts.sidebar
diff --git a/main/_modules/deepcave/plugins.html b/main/_modules/deepcave/plugins.html
index e4492606..b26c2597 100644
--- a/main/_modules/deepcave/plugins.html
+++ b/main/_modules/deepcave/plugins.html
@@ -21,7 +21,7 @@
-
+
@@ -823,37 +823,37 @@ Source code for deepcave.plugins
- Plugin: Base class for all plugins.
"""
-from abc import ABC
-from typing import Any, Callable, Dict, List, Optional, Tuple, Union
-
-import copy
-import re
-import webbrowser
-from collections import defaultdict
-
-import dash_bootstrap_components as dbc
-from dash import dcc, html
-from dash.dependencies import Input, Output, State
-from dash.development.base_component import Component
-from dash.exceptions import PreventUpdate
-
-from deepcave import ROOT_DIR, interactive
-from deepcave.layouts import Layout
-from deepcave.runs import AbstractRun
-from deepcave.runs.group import Group, NotMergeableError
-from deepcave.utils.data_structures import update_dict
-from deepcave.utils.docs import rst_to_md
-from deepcave.utils.hash import string_to_hash
-from deepcave.utils.layout import get_select_options
-from deepcave.utils.logs import get_logger
-from deepcave.utils.url import parse_url
+from abc import ABC
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+
+import copy
+import re
+import webbrowser
+from collections import defaultdict
+
+import dash_bootstrap_components as dbc
+from dash import dcc, html
+from dash.dependencies import Input, Output, State
+from dash.development.base_component import Component
+from dash.exceptions import PreventUpdate
+
+from deepcave import ROOT_DIR, interactive
+from deepcave.layouts import Layout
+from deepcave.runs import AbstractRun
+from deepcave.runs.group import Group, NotMergeableError
+from deepcave.utils.data_structures import update_dict
+from deepcave.utils.docs import rst_to_md
+from deepcave.utils.hash import string_to_hash
+from deepcave.utils.layout import get_select_options
+from deepcave.utils.logs import get_logger
+from deepcave.utils.url import parse_url
logger = get_logger(__name__)
[docs]
-class Plugin(Layout, ABC):
+class Plugin(Layout, ABC):
"""
Base class for all plugins.
@@ -896,7 +896,7 @@ Source code for deepcave.plugins
button_caption: str = "Process"
activate_run_selection: bool = False
- def __init__(self) -> None:
+ def __init__(self) -> None:
# Registered inputs and outputs
self.inputs: List[Tuple[str, str, bool, Any]] = []
self.outputs: List[Tuple[str, str]] = []
@@ -922,7 +922,7 @@ Source code for deepcave.plugins
[docs]
@classmethod
@interactive
- def get_base_url(cls) -> str:
+ def get_base_url(cls) -> str:
"""
Generate the url for the plugin.
@@ -931,7 +931,7 @@ Source code for deepcave.plugins
str
Url for the plugin as string.
"""
- from deepcave import config
+ from deepcave import config
return f"http://{config.DASH_ADDRESS}:{config.DASH_PORT}/plugins/{cls.id}"
@@ -939,7 +939,7 @@ Source code for deepcave.plugins
[docs]
@staticmethod
- def check_run_compatibility(run: AbstractRun) -> bool:
+ def check_run_compatibility(run: AbstractRun) -> bool:
"""
Check if a run is compatible with this plugin.
@@ -964,7 +964,7 @@ Source code for deepcave.plugins
[docs]
- def check_runs_compatibility(self, runs: List[AbstractRun]) -> None:
+ def check_runs_compatibility(self, runs: List[AbstractRun]) -> None:
"""
Needed if all selected runs need something in common.
@@ -986,7 +986,7 @@ Source code for deepcave.plugins
[docs]
- def register_input(
+ def register_input(
self,
id: str,
attributes: Union[str, List[str]] = "value",
@@ -1039,7 +1039,7 @@ Source code for deepcave.plugins
[docs]
- def register_output(self, id: str, attributes: Union[str, List[str]] = "value") -> str:
+ def register_output(self, id: str, attributes: Union[str, List[str]] = "value") -> str:
"""
Register an output variable for the plugin.
@@ -1068,21 +1068,21 @@ Source code for deepcave.plugins
[docs]
- def get_internal_id(self, id: str) -> str:
+ def get_internal_id(self, id: str) -> str:
"""Get the internal id."""
return f"{self.id}-{id}"
[docs]
- def get_internal_input_id(self, id: str) -> str:
+ def get_internal_input_id(self, id: str) -> str:
"""Get the internal input id."""
return f"{self.id}-{id}-input"
[docs]
- def get_internal_output_id(self, id: str) -> str:
+ def get_internal_output_id(self, id: str) -> str:
"""Get the internal output id."""
return f"{self.id}-{id}-output"
@@ -1090,7 +1090,7 @@ Source code for deepcave.plugins
[docs]
@interactive
- def register_callbacks(self) -> None:
+ def register_callbacks(self) -> None:
"""
Register basic callbacks for the plugin.
@@ -1105,7 +1105,7 @@ Source code for deepcave.plugins
RuntimeError
If no run id is found.
"""
- from deepcave import app, c, run_handler
+ from deepcave import app, c, run_handler
# Handles the initial and the cashed input values
outputs = []
@@ -1121,7 +1121,7 @@ Source code for deepcave.plugins
if len(outputs) > 0:
@app.callback(outputs, inputs) # type: ignore
- def plugin_input_update(pathname: str, *inputs_list: str) -> List[Optional[str]]:
+ def plugin_input_update(pathname: str, *inputs_list: str) -> List[Optional[str]]:
"""Update the input of the plugin."""
# Simple check if page was loaded for the first time
init = all(input is None for input in inputs_list)
@@ -1269,7 +1269,7 @@ Source code for deepcave.plugins
Input(self.get_internal_id("show_raw_data"), "n_clicks"),
State(self.get_internal_id("raw_data"), "is_open"),
)
- def toggle_raw_data_modal(n: Optional[int], is_open: bool) -> Tuple[bool, str]:
+ def toggle_raw_data_modal(n: Optional[int], is_open: bool) -> Tuple[bool, str]:
"""Toggle the raw data modal."""
code = ""
if n:
@@ -1289,7 +1289,7 @@ Source code for deepcave.plugins
Input(self.get_internal_id("show_help"), "n_clicks"),
State(self.get_internal_id("help"), "is_open"),
)
- def toggle_help_modal(n: Optional[int], is_open: bool) -> bool:
+ def toggle_help_modal(n: Optional[int], is_open: bool) -> bool:
"""Toggle the help modal."""
if n:
return not is_open
@@ -1303,7 +1303,7 @@ Source code for deepcave.plugins
Output(internal_id, "clickData"),
Input(internal_id, "clickData"),
) # type: ignore
- def go_to_configuration(click_data: Any):
+ def go_to_configuration(click_data: Any):
"""Open link from hovertext."""
if click_data is not None:
# Get hovertext
@@ -1322,7 +1322,7 @@ Source code for deepcave.plugins
@interactive
- def _inputs_changed(
+ def _inputs_changed(
self, inputs: Dict[str, Dict[str, str]], last_inputs: Dict[str, Dict[str, str]]
) -> Tuple[bool, bool]:
"""
@@ -1361,7 +1361,7 @@ Source code for deepcave.plugins
return inputs_changed, filters_changed
@interactive
- def _process_raw_outputs(
+ def _process_raw_outputs(
self, inputs: Dict[str, Dict[str, str]], raw_outputs: Dict[str, Any]
) -> Any:
"""
@@ -1379,7 +1379,7 @@ Source code for deepcave.plugins
Any
The processed outputs.
"""
- from deepcave import run_handler
+ from deepcave import run_handler
# Use raw outputs to update our layout
passed_runs: Union[List[AbstractRun], AbstractRun]
@@ -1417,7 +1417,7 @@ Source code for deepcave.plugins
return outputs
@interactive
- def _list_to_dict(self, values: List[str], input: bool = True) -> Dict[str, Dict[str, str]]:
+ def _list_to_dict(self, values: List[str], input: bool = True) -> Dict[str, Dict[str, str]]:
"""
Map the given values to a dict.
@@ -1453,7 +1453,7 @@ Source code for deepcave.plugins
return mapping
@interactive
- def _dict_to_list(
+ def _dict_to_list(
self, d: Dict[str, Dict[str, str]], input: bool = False
) -> List[Optional[str]]:
"""
@@ -1495,7 +1495,7 @@ Source code for deepcave.plugins
return result
@interactive
- def _dict_as_key(self, d: Dict[str, Any], remove_filters: bool = False) -> str:
+ def _dict_as_key(self, d: Dict[str, Any], remove_filters: bool = False) -> str:
"""
Convert a dictionary to a key. Only ids from self.inputs are considered.
@@ -1528,7 +1528,7 @@ Source code for deepcave.plugins
return string_to_hash(str(new_d))
- def _cast_inputs(self, inputs: Dict[str, Dict[str, str]]) -> Dict[str, Dict[str, str]]:
+ def _cast_inputs(self, inputs: Dict[str, Dict[str, str]]) -> Dict[str, Dict[str, str]]:
"""
Cast the inputs based on `self.inputs`.
@@ -1563,7 +1563,7 @@ Source code for deepcave.plugins
return casted_inputs
- def _clean_inputs(self, inputs: Dict[str, Any]) -> Dict[str, Any]:
+ def _clean_inputs(self, inputs: Dict[str, Any]) -> Dict[str, Any]:
"""
Clean the given inputs s.t. only the first value is used.
@@ -1610,7 +1610,7 @@ Source code for deepcave.plugins
@property
@interactive
- def runs(self) -> List[AbstractRun]:
+ def runs(self) -> List[AbstractRun]:
"""
Get the runs as a list.
@@ -1619,13 +1619,13 @@ Source code for deepcave.plugins
List[AbstractRun]
The list with the runs.
"""
- from deepcave import run_handler
+ from deepcave import run_handler
return run_handler.get_runs()
@property
@interactive
- def groups(self) -> List[Group]:
+ def groups(self) -> List[Group]:
"""
Get the groups as a list.
@@ -1634,13 +1634,13 @@ Source code for deepcave.plugins
List[Group]
The list with the groups.
"""
- from deepcave import run_handler
+ from deepcave import run_handler
return run_handler.get_groups()
@property
@interactive
- def all_runs(self) -> List[AbstractRun]:
+ def all_runs(self) -> List[AbstractRun]:
"""
Get all runs and include the groups as a list.
@@ -1649,14 +1649,14 @@ Source code for deepcave.plugins
List[AbstractRun]
The list with all runs and included groups.
"""
- from deepcave import run_handler
+ from deepcave import run_handler
return run_handler.get_runs(include_groups=True)
[docs]
@interactive
- def __call__(self, render_button: bool = False) -> List[Component]:
+ def __call__(self, render_button: bool = False) -> List[Component]:
"""
Return the components for the plugin.
@@ -1679,7 +1679,7 @@ Source code for deepcave.plugins
FileNotFoundError
If the help file can not be found.
"""
- from deepcave import notification
+ from deepcave import notification
# Reset runtime variables
self.previous_inputs = {}
@@ -1774,7 +1774,7 @@ Source code for deepcave.plugins
)
]
- def register_in(a: str, b: Union[List[str], str]) -> str:
+ def register_in(a: str, b: Union[List[str], str]) -> str:
"""
Register the given input.
@@ -1868,7 +1868,7 @@ Source code for deepcave.plugins
[docs]
@staticmethod
@interactive
- def get_run_input_layout(register: Callable) -> Component:
+ def get_run_input_layout(register: Callable) -> Component:
"""
Generate the run selection input.
@@ -1899,7 +1899,7 @@ Source code for deepcave.plugins
[docs]
@staticmethod
@interactive
- def load_run_inputs(
+ def load_run_inputs(
runs: List[AbstractRun],
groups: List[Group],
check_run_compatibility: Callable[[AbstractRun], bool],
@@ -1964,7 +1964,7 @@ Source code for deepcave.plugins
[docs]
@interactive
- def get_selected_runs(self, inputs: Dict[str, Any]) -> List[AbstractRun]:
+ def get_selected_runs(self, inputs: Dict[str, Any]) -> List[AbstractRun]:
"""
Parse selected runs from inputs.
@@ -1986,7 +1986,7 @@ Source code for deepcave.plugins
PreventUpdate
If `activate_run_selection` is set but `run` is not available.
"""
- from deepcave import run_handler
+ from deepcave import run_handler
# Special case: If run selection is active
# Don't update anything if the inputs haven't changed
@@ -2010,7 +2010,7 @@ Source code for deepcave.plugins
[docs]
- def load_inputs(self) -> Dict[str, Any]:
+ def load_inputs(self) -> Dict[str, Any]:
"""
Load the content for the defined inputs in `get_input_layout` and `get_filter_layout`.
@@ -2028,7 +2028,7 @@ Source code for deepcave.plugins
[docs]
- def load_dependency_inputs(
+ def load_dependency_inputs(
self,
run: Optional[Union[AbstractRun, List[AbstractRun]]],
previous_inputs: Dict[str, Any],
@@ -2065,7 +2065,7 @@ Source code for deepcave.plugins