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

4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Experiments managerment
-----------------------

Click the tab ``All experiments`` on the nav bar.

.. image:: ../../img/webui-img/managerExperimentList/experimentListNav.png
   :target: ../../img/webui-img/managerExperimentList/experimentListNav.png
   :alt: ExperimentList nav



* On the ``All experiments`` page, you can see all the experiments on your machine. 

.. image:: ../../img/webui-img/managerExperimentList/expList.png
   :target: ../../img/webui-img/managerExperimentList/expList.png
   :alt: Experiments list



23
* When you want to see more details about an experiment you could click the trial id, look that:
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

.. image:: ../../img/webui-img/managerExperimentList/toAnotherExp.png
   :target: ../../img/webui-img/managerExperimentList/toAnotherExp.png
   :alt: See this experiment detail



* If has many experiments on the table, you can use the ``filter`` button.

.. image:: ../../img/webui-img/managerExperimentList/expFilter.png
   :target: ../../img/webui-img/managerExperimentList/expFilter.png
   :alt: filter button



39
40
View summary page
-----------------
fishyds's avatar
fishyds committed
41

42
Click the tab ``Overview``.
fishyds's avatar
fishyds committed
43

44

45
* On the overview tab, you can see the experiment information and status and the performance of ``top trials``.
fishyds's avatar
fishyds committed
46

47
48
49

.. image:: ../../img/webui-img/full-oview.png
   :target: ../../img/webui-img/full-oview.png
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
   :alt: overview



* If you want to see experiment search space and config, please click the right button ``Search space`` and ``Config`` (when you hover on this button).

   1. Search space file:


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



   2. Config file:


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



* You can view and download ``nni-manager/dispatcher log files`` on here.


.. image:: ../../img/webui-img/review-log.png
   :target: ../../img/webui-img/review-log.png
   :alt: logfile
80
81
82



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

85
86
87

.. image:: ../../img/webui-img/refresh-interval.png
   :target: ../../img/webui-img/refresh-interval.png
88
   :alt: refresh
89
90
91



v-liguo's avatar
v-liguo committed
92

93
* You can review and download the experiment results(``experiment config``, ``trial message`` and ``intermeidate metrics``) when you click the button ``Experiment summary``.
94
95


96
97
98
.. image:: ../../img/webui-img/summary.png
   :target: ../../img/webui-img/summary.png
   :alt: summary
99

100

101
102

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

104
105
106

.. image:: ../../img/webui-img/edit-experiment-param.png
   :target: ../../img/webui-img/edit-experiment-param.png
107
   :alt: editExperimentParams
108
109


110

111
* You can click the icon to see specific error message and ``nni-manager/dispatcher log files`` by clicking ``Learn about`` link.
v-liguo's avatar
v-liguo committed
112

113

114
115
116
.. image:: ../../img/webui-img/experimentError.png
   :target: ../../img/webui-img/experimentError.png
   :alt: experimentError
117
118
119



v-liguo's avatar
v-liguo committed
120

121
* You can click ``About`` to see the version and report any questions.
fishyds's avatar
fishyds committed
122

123
124
125
View job default metric
-----------------------

fishyds's avatar
fishyds committed
126

127
* 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
128

129
130
131

.. image:: ../../img/webui-img/default-metric.png
   :target: ../../img/webui-img/default-metric.png
132
   :alt: defaultMetricGraph
133
134


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

136
* Click the switch named ``optimization curve`` to see the experiment's optimization curve.
v-liguo's avatar
v-liguo committed
137

fishyds's avatar
fishyds committed
138

139
140
.. image:: ../../img/webui-img/best-curve.png
   :target: ../../img/webui-img/best-curve.png
141
   :alt: bestCurveGraph
142
143
144
145


View hyper parameter
--------------------
fishyds's avatar
fishyds committed
146

147
Click the tab ``Hyper Parameter`` to see the parallel graph.
fishyds's avatar
fishyds committed
148

149

150
* You can ``add/remove`` axes and drag to swap axes on the chart.
fishyds's avatar
fishyds committed
151
152
* You can select the percentage to see top trials.

153
154
155

.. image:: ../../img/webui-img/hyperPara.png
   :target: ../../img/webui-img/hyperPara.png
156
157
   :alt: hyperParameterGraph

158
159
160
161


View Trial Duration
-------------------
Lijiao's avatar
Lijiao committed
162

163
Click the tab ``Trial Duration`` to see the bar graph.
fishyds's avatar
fishyds committed
164

165
166
167

.. image:: ../../img/webui-img/trial_duration.png
   :target: ../../img/webui-img/trial_duration.png
168
169
   :alt: trialDurationGraph

170
171
172
173


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

175
Click the tab ``Intermediate Result`` to see the line graph.
Lijiao's avatar
Lijiao committed
176

177
178
179

.. image:: ../../img/webui-img/trials_intermeidate.png
   :target: ../../img/webui-img/trials_intermeidate.png
180
181
   :alt: trialIntermediateGraph

182

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

184
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
185

186
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
187

188
189
190

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

193
194
195
196


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

198
Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
fishyds's avatar
fishyds committed
199

200

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

203
204
205

.. image:: ../../img/webui-img/detail-local.png
   :target: ../../img/webui-img/detail-local.png
206
   :alt: detailLocalImage
207
208
209



210
* 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.
211

212
213
214

.. image:: ../../img/webui-img/addColumn.png
   :target: ../../img/webui-img/addColumn.png
215
   :alt: addColumnGraph
216
217
218



219
* If you want to compare some trials, you can select them and then click ``Compare`` to see the results.
220

221
222
223

.. image:: ../../img/webui-img/select-trial.png
   :target: ../../img/webui-img/select-trial.png
224
   :alt: selectTrialGraph
225
226
227
228


.. image:: ../../img/webui-img/compare.png
   :target: ../../img/webui-img/compare.png
229
   :alt: compareTrialsGraph
230
231
232



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

235
236
237

.. image:: ../../img/webui-img/search-trial.png
   :target: ../../img/webui-img/search-trial.png
238
   :alt: searchTrial
239
240
241



242
* You can use the button named ``Copy as python`` to copy the trial's parameters.
243

244
245
246

.. image:: ../../img/webui-img/copyParameter.png
   :target: ../../img/webui-img/copyParameter.png
247
   :alt: copyTrialParameters
248
249
250



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

253
254
255

.. image:: ../../img/webui-img/detail-pai.png
   :target: ../../img/webui-img/detail-pai.png
256
   :alt: detailPai
257
258
259



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

262
263
264

.. image:: ../../img/webui-img/intermediate.png
   :target: ../../img/webui-img/intermediate.png
265
   :alt: intermeidateGraph
266
267
268



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

271
272
273

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