Skip to content

Commit 1e19cde

Browse files
committed
Adapt documentation of the Budget
1 parent 02c1366 commit 1e19cde

File tree

5 files changed

+8
-2
lines changed

5 files changed

+8
-2
lines changed

deepcave/plugins/hyperparameter/pdp.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ def get_input_layout(register: Callable) -> List[dbc.Row]:
8585
[
8686
dbc.Label("Budget"),
8787
help_button(
88+
"Budget refers to the Multi-Fidelity budget."
8889
"Combined budget means that the trial on the highest"
8990
" evaluated budget is used.\n\n"
9091
"Note: Selecting combined budget might be misleading if"

deepcave/plugins/hyperparameter/symbolic_explanations.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ def get_input_layout(register: Callable) -> List[Union[dbc.Row, html.Details]]:
8989
[
9090
dbc.Label("Budget"),
9191
help_button(
92+
"Budget refers to the Multi-Fidelity budget."
9293
"Combined budget means that the trial on the highest"
9394
" evaluated budget is used.\n\n"
9495
"Note: Selecting combined budget might be misleading if"

deepcave/plugins/objective/configuration_cube.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ def get_input_layout(register: Callable) -> List[dbc.Row]:
8181
[
8282
dbc.Label("Budget"),
8383
help_button(
84+
"Budget refers to the Multi-Fidelity budget."
8485
"Combined budget means that the trial on the highest"
8586
" evaluated budget is used.\n\n"
8687
"Note: Selecting combined budget might be misleading if"

deepcave/plugins/summary/footprint.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ def get_input_layout(register: Callable) -> List[Any]:
7474
[
7575
dbc.Label("Budget"),
7676
help_button(
77+
"Budget refers to the Multi-Fidelity budget."
7778
"Combined budget means that the trial on the highest"
7879
" evaluated budget is used.\n\n"
7980
"Note: Selecting combined budget might be misleading if"

docs/plugins/overview.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This plugin is capable of answering following questions:
2323
* Is the configuration space as expected?
2424
* How many trials have been successful/unsuccessful?
2525
* Why did certain trials crash?
26-
* On which budgets were the configurations evaluated?
26+
* On which Multi Fidelity budgets were the configurations evaluated?
2727

2828

2929
Quick Information
@@ -36,7 +36,9 @@ the runs were last updated and a handy quick link to the best **Configuration**.
3636
Meta
3737
----
3838
Next we show some meta information regarding your runs. Notably, you can see information such as the
39-
possible **budget** allocations that were considered during the run.
39+
possible **budget** allocations that were considered during the run. The **budget** is the amount of
40+
resources that were allocated to a configuration as it was beeing evaluated using a Multi-Fidelity
41+
Approach.
4042

4143

4244
Objectives

0 commit comments

Comments
 (0)