WebUI.md 3.6 KB
Newer Older
fishyds's avatar
fishyds committed
1
2
3
4
5
6
# WebUI

## View summary page

Click the tab "Overview".

7
* On the overview tab, you can see the experiment trial profile/search space and the performance of top trials.
fishyds's avatar
fishyds committed
8

xuehui's avatar
xuehui committed
9
10
![](../../img/webui-img/over1.png)
![](../../img/webui-img/over2.png)
11
* If your experiment has many trials, you can change the refresh interval here.
v-liguo's avatar
update  
v-liguo committed
12
13

![](../../img/webui-img/refresh-interval.png)
14
* You can review and download the experiment results and nni-manager/dispatcher log files from the "View" button.
v-liguo's avatar
v-liguo committed
15
16

![](../../img/webui-img/download.png)
17
* You can click the exclamation point in the error box to see a log message if the experiment's status is an error.
v-liguo's avatar
v-liguo committed
18
19
20
21

![](../../img/webui-img/log-error.png)
![](../../img/webui-img/review-log.png)

22
* You can click "Feedback" to report any questions.
fishyds's avatar
fishyds committed
23

Lijiao's avatar
Lijiao committed
24
## View job default metric
fishyds's avatar
fishyds committed
25

v-liguo's avatar
update  
v-liguo committed
26
* Click the tab "Default Metric" to see the point graph of all trials. Hover to see its specific default metric and search space message.
fishyds's avatar
fishyds committed
27

v-liguo's avatar
v-liguo committed
28
![](../../img/webui-img/default-metric.png)
v-liguo's avatar
update  
v-liguo committed
29
30

* Click the switch named "optimization curve" to see the experiment's optimization curve.
v-liguo's avatar
v-liguo committed
31
32

![](../../img/webui-img/best-curve.png)
fishyds's avatar
fishyds committed
33
34
35
36
37
38
39
40

## View hyper parameter

Click the tab "Hyper Parameter" to see the parallel graph.

* You can select the percentage to see top trials.
* Choose two axis to swap its positions

xuehui's avatar
xuehui committed
41
![](../../img/hyperPara.png)
Lijiao's avatar
Lijiao committed
42
43
44
## View Trial Duration

Click the tab "Trial Duration" to see the bar graph.
fishyds's avatar
fishyds committed
45

xuehui's avatar
xuehui committed
46
![](../../img/trial_duration.png)
Lijiao's avatar
Lijiao committed
47
48
## View Trial Intermediate Result Graph

49
Click the tab "Intermediate Result" to see the line graph.
Lijiao's avatar
Lijiao committed
50

xuehui's avatar
xuehui committed
51
![](../../img/webui-img/trials_intermeidate.png)
v-liguo's avatar
update  
v-liguo committed
52

53
The trial may have many intermediate results in the training process. In order to see the trend of some trials more clearly, we set a filtering function for the intermediate result graph.
v-liguo's avatar
v-liguo committed
54

55
You may find that these trials will get better or worse at an intermediate result. This indicates that it is an important and relevant intermediate result. To take a closer look at the point here, you need to enter its corresponding X-value at #Intermediate. Then input the range of metrics on this intermedia result. In the picture below, we choose the No. 4 intermediate result and set the range of metrics to 0.8-1.
Lijiao's avatar
Lijiao committed
56

v-liguo's avatar
rename  
v-liguo committed
57
![](../../img/webui-img/filter-intermediate.png)
58
## View trials status
Lijiao's avatar
Lijiao committed
59

60
Click the tab "Trials Detail" to see the status of all trials. Specifically:
fishyds's avatar
fishyds committed
61

62
* Trial detail: trial's id, trial's duration, start time, end time, status, accuracy, and search space file.
fishyds's avatar
fishyds committed
63

xuehui's avatar
xuehui committed
64
![](../../img/webui-img/detail-local.png)
65
* The button named "Add column" can select which column to show on the table. If you run an experiment whose final result is a dict, you can see other keys in the table. You can choose the column "Intermediate count" to watch the trial's progress.
66

xuehui's avatar
xuehui committed
67
![](../../img/webui-img/addColumn.png)
68
69
* If you want to compare some trials, you can select them and then click "Compare" to see the results.

v-liguo's avatar
v-liguo committed
70
![](../../img/webui-img/select-trial.png)
xuehui's avatar
xuehui committed
71
![](../../img/webui-img/compare.png)
v-liguo's avatar
update  
v-liguo committed
72
73
74
* Support to search for a specific trial by it's id, status, Trial No. and parameters.

![](../../img/webui-img/search-trial.png)
75
* You can use the button named "Copy as python" to copy the trial's parameters.
76

xuehui's avatar
xuehui committed
77
![](../../img/webui-img/copyParameter.png)
78
* If you run on the OpenPAI or Kubeflow platform, you can also see the hdfsLog.
Lijiao's avatar
Lijiao committed
79

xuehui's avatar
xuehui committed
80
![](../../img/webui-img/detail-pai.png)
81
* Intermediate Result Graph: you can see the default and other keys in this graph by clicking the operation column button.
fishyds's avatar
fishyds committed
82

v-liguo's avatar
v-liguo committed
83
![](../../img/webui-img/intermediate-btn.png)
xuehui's avatar
xuehui committed
84
![](../../img/webui-img/intermediate.png)
v-liguo's avatar
update  
v-liguo committed
85
86
87
88
* Kill: you can kill a job that status is running.

![](../../img/webui-img/kill-running.png)
![](../../img/webui-img/canceled.png)