WebUI.rst 5.33 KB
Newer Older
1
2
WebUI
=====
fishyds's avatar
fishyds committed
3

4
5
View summary page
-----------------
fishyds's avatar
fishyds committed
6
7
8

Click the tab "Overview".

9

10
* On the overview tab, you can see the experiment information and status and the performance of top trials. If you want to see config and search space, please click the right button "Config" and "Search space".
fishyds's avatar
fishyds committed
11

12
13
14
15
16
17
18

.. image:: ../../img/webui-img/full-oview.png
   :target: ../../img/webui-img/full-oview.png
   :alt: 



19
* If your experiment has many trials, you can change the refresh interval here.
v-liguo's avatar
update  
v-liguo committed
20

21
22
23
24
25
26
27

.. image:: ../../img/webui-img/refresh-interval.png
   :target: ../../img/webui-img/refresh-interval.png
   :alt: 



28
* You can review and download the experiment results and nni-manager/dispatcher log files from the "Download" button.
v-liguo's avatar
v-liguo committed
29

30
31
32
33
34
35

.. image:: ../../img/webui-img/download.png
   :target: ../../img/webui-img/download.png
   :alt: 


36
37
38

* You can change some experiment configurations such as maxExecDuration, maxTrialNum and trial concurrency on here.

39
40
41
42
43
44

.. image:: ../../img/webui-img/edit-experiment-param.png
   :target: ../../img/webui-img/edit-experiment-param.png
   :alt: 


45

46
* 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
47

48
49
50
51
52
53
54
55
56
57
58

.. image:: ../../img/webui-img/log-error.png
   :target: ../../img/webui-img/log-error.png
   :alt: 


.. image:: ../../img/webui-img/review-log.png
   :target: ../../img/webui-img/review-log.png
   :alt: 


v-liguo's avatar
v-liguo committed
59

60
* You can click "About" to see the version and report any questions.
fishyds's avatar
fishyds committed
61

62
63
64
View job default metric
-----------------------

fishyds's avatar
fishyds committed
65

v-liguo's avatar
update  
v-liguo committed
66
* 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
67

68
69
70
71
72
73

.. image:: ../../img/webui-img/default-metric.png
   :target: ../../img/webui-img/default-metric.png
   :alt: 


v-liguo's avatar
update  
v-liguo committed
74
75

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

fishyds's avatar
fishyds committed
77

78
79
80
81
82
83
84
.. image:: ../../img/webui-img/best-curve.png
   :target: ../../img/webui-img/best-curve.png
   :alt: 


View hyper parameter
--------------------
fishyds's avatar
fishyds committed
85
86
87

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

88

89
* You can add/remove axes and drag to swap axes on the chart.
fishyds's avatar
fishyds committed
90
91
* You can select the percentage to see top trials.

92
93
94
95
96
97
98
99

.. image:: ../../img/webui-img/hyperPara.png
   :target: ../../img/webui-img/hyperPara.png
   :alt: 


View Trial Duration
-------------------
Lijiao's avatar
Lijiao committed
100
101

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

103
104
105
106
107
108
109
110

.. image:: ../../img/webui-img/trial_duration.png
   :target: ../../img/webui-img/trial_duration.png
   :alt: 


View Trial Intermediate Result Graph
------------------------------------
Lijiao's avatar
Lijiao committed
111

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

114
115
116
117
118

.. image:: ../../img/webui-img/trials_intermeidate.png
   :target: ../../img/webui-img/trials_intermeidate.png
   :alt: 

v-liguo's avatar
update  
v-liguo committed
119

120
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
121

122
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
123

124
125
126
127
128
129
130
131

.. image:: ../../img/webui-img/filter-intermediate.png
   :target: ../../img/webui-img/filter-intermediate.png
   :alt: 


View trials status
------------------
Lijiao's avatar
Lijiao committed
132

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

135

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

138
139
140
141
142
143
144

.. image:: ../../img/webui-img/detail-local.png
   :target: ../../img/webui-img/detail-local.png
   :alt: 



145
* 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.
146

147
148
149
150
151
152
153

.. image:: ../../img/webui-img/addColumn.png
   :target: ../../img/webui-img/addColumn.png
   :alt: 



154
155
* If you want to compare some trials, you can select them and then click "Compare" to see the results.

156
157
158
159
160
161
162
163
164
165
166
167

.. image:: ../../img/webui-img/select-trial.png
   :target: ../../img/webui-img/select-trial.png
   :alt: 


.. image:: ../../img/webui-img/compare.png
   :target: ../../img/webui-img/compare.png
   :alt: 



v-liguo's avatar
update  
v-liguo committed
168
169
* Support to search for a specific trial by it's id, status, Trial No. and parameters.

170
171
172
173
174
175
176

.. image:: ../../img/webui-img/search-trial.png
   :target: ../../img/webui-img/search-trial.png
   :alt: 



177
* You can use the button named "Copy as python" to copy the trial's parameters.
178

179
180
181
182
183
184
185

.. image:: ../../img/webui-img/copyParameter.png
   :target: ../../img/webui-img/copyParameter.png
   :alt: 



186
* If you run on the OpenPAI or Kubeflow platform, you can also see the nfs log.
Lijiao's avatar
Lijiao committed
187

188
189
190
191
192
193
194

.. image:: ../../img/webui-img/detail-pai.png
   :target: ../../img/webui-img/detail-pai.png
   :alt: 



195
* Intermediate Result Graph: you can see the default metric in this graph by clicking the intermediate button.
fishyds's avatar
fishyds committed
196

197
198
199
200
201
202
203

.. image:: ../../img/webui-img/intermediate.png
   :target: ../../img/webui-img/intermediate.png
   :alt: 



v-liguo's avatar
update  
v-liguo committed
204
205
* Kill: you can kill a job that status is running.

206
207
208
209
210

.. image:: ../../img/webui-img/kill-running.png
   :target: ../../img/webui-img/kill-running.png
   :alt: