Skip to content

Commit 02c1366

Browse files
committed
Add pd plot docs
1 parent d5770f2 commit 02c1366

File tree

3 files changed

+21
-5
lines changed

3 files changed

+21
-5
lines changed

docs/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ to see the dashboard in action:
4040

4141

4242
Displaying the data is done via plugins. You can select the plugins you want to use in the menu on the left.
43-
This is further explained in the :ref:`plugins<Plugins>` section.
43+
This is further explained in the :ref:`plugins<Displaying Data with Plugins>` section.
4444

4545
DeepCAVE uses runs to interprete data. A run is a collection of trials
4646
(a configuration with associated costs). Once valid runs (see :ref:`converter<Converters>`) are

docs/plugins/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Plugins
2-
=======
1+
Displaying Data with Plugins
2+
============================
33

44
.. toctree::
55
:hidden:
Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
11
Partial Dependencies
22
====================
33

4+
The quality of a machine learning algorithm is highly dependent on the choice of hyperparameters. PdP plots aim to visualize how chaning one or two hyperparameters affects the objective function. To reduce comptutational complexity the plugin utilizes a random forest surrogate model.
5+
6+
* In the one hyperparameter case, random samples or the selected hyperparameters are combined with each combination of the othre hyperparameters present in the dataset resulting in a multitude of ice curves. The resulting ice curves are than averaged to a PD plot. The hyperparameter is plotted along the x axis, and the respective objective function value along the y-axis
7+
8+
* The two hyperparameter case works as the one hyperparameter case, but the then two dimensional ice-curves are disregarded in the plot. The resulting plot has one target hyperparameter plotted along the x-axis and the other hyperparameter plotted along the y-axis. The color in the plot indicates the respective objective function value.
9+
10+
411
This plugin is capable of answering following questions:
512

613
* How does the objective change with respect to one or two hyperparameters? For example, does the
714
accuracy increase if the learning rate decreases?
815
* Do multiple trials show similar behavior?
16+
Options
17+
-------
18+
* **Objective**: Here you can select the objective you wish to analyze for. In the one hyperparameter case the objective is plotted on the y-axis, in the two hyperparameter case it is represented by the color.
19+
20+
* **Budget**: Here you can select the budget used to compute ICE. TODO
21+
22+
* **Hyperparameter 1**: Here you can select the first hyperparameter. It is plotted along the x-axis.
23+
24+
* **Hyperparameter 2**: Here you can optionally select the second hyperparameter.
925

26+
* **Show Confidence**: Selection for whether or not to show certainty estimates (based on the difference of ice curves).
1027

11-
.. warning::
12-
This page is under construction.
28+
* **Show ICE Curves**: Selection for whether or not to to show the ICE curves used during computation
1329

1430

1531
.. image:: ../images/plugins/partial_dependencies.png

0 commit comments

Comments
 (0)