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

## View summary page

Click the tab "Overview".

v-liguo's avatar
update  
v-liguo committed
7
* See the experiment trial profile/search space and performanced good trials.
fishyds's avatar
fishyds committed
8

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

![](../../img/webui-img/refresh-interval.png)
* Support to review and download the experiment result and nni-manager/dispatcher log file from the download.
v-liguo's avatar
v-liguo committed
15
16

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

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

v-liguo's avatar
update  
v-liguo committed
22
* You can click "Feedback" to report it if you have 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
49
50
## View Trial Intermediate Result Graph

Click the tab "Intermediate Result" to see the lines graph.

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

We set a filter function for the intermediate result graph because that the trials may have many intermediate results in the training progress. You need to provide data if you want to use the filter button to see the trend of some trial.
v-liguo's avatar
v-liguo committed
54

v-liguo's avatar
v-liguo committed
55
What data should be written in the first input? Maybe you find an intermediate count those trials became better or worse. In other word, it's an important and concerned intermediate count. Just input it into the first input.
v-liguo's avatar
v-liguo committed
56

v-liguo's avatar
v-liguo committed
57
After selecting the intermeidate count, you should input your focus metric's range on this intermediate count. Yes, it's the min and max value. Like this picture, I choose the intermeidate count is 9 and the metric's range is 60-80.
v-liguo's avatar
v-liguo committed
58

v-liguo's avatar
update  
v-liguo committed
59
As a result, I filter these trials that the metric's range is 20-60 on the 13 intermediate count.
Lijiao's avatar
Lijiao committed
60

xuehui's avatar
xuehui committed
61
![](../../img/webui-img/filter_intermediate.png)
62
## View trials status
Lijiao's avatar
Lijiao committed
63
64

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

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

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

xuehui's avatar
xuehui committed
71
![](../../img/webui-img/addColumn.png)
72
73
* 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
74
![](../../img/webui-img/select-trial.png)
xuehui's avatar
xuehui committed
75
![](../../img/webui-img/compare.png)
v-liguo's avatar
update  
v-liguo committed
76
77
78
* Support to search for a specific trial by it's id, status, Trial No. and parameters.

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

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

xuehui's avatar
xuehui committed
84
![](../../img/webui-img/detail-pai.png)
v-liguo's avatar
v-liguo committed
85
* Intermediate Result Graph: you can see default and other keys in this graph by click the operation column button.
fishyds's avatar
fishyds committed
86

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

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