WebUI.rst 8.6 KB
Newer Older
1
2
.. 8ade987770562c6e01f727b9fdbc2c2d

kvartet's avatar
kvartet committed
3
Web 界面
kvartet's avatar
kvartet committed
4
==================
kvartet's avatar
kvartet committed
5

kvartet's avatar
kvartet committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Experiment 管理
-----------------------

点击导航栏上的 ``All experiments`` 标签。

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



* 在 ``All experiments`` 页面,可以看到机器上的所有 Experiment。 

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



* 当您想查看 Experiment 的更多详细信息时,可以单击试验 ID ,如下所示:

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



* 如果在表格上有很多 Experiment ,可以使用 ``filter`` 按钮

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



kvartet's avatar
kvartet committed
41
42
43
查看概要页面
-----------------

kvartet's avatar
kvartet committed
44
点击 ``Overview`` 标签。
kvartet's avatar
kvartet committed
45
46


kvartet's avatar
kvartet committed
47
* 在 Overview 标签上,可看到 Experiment Trial 的概况、搜索空间、以及 ``top trials`` 的结果。
kvartet's avatar
kvartet committed
48
49
50
51


.. image:: ../../img/webui-img/full-oview.png
   :target: ../../img/webui-img/full-oview.png
kvartet's avatar
kvartet committed
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
80
81
   :alt: overview



如果想查看 Experiment 配置和搜索空间,点击右边的 ``Search space`` 和 ``Config`` 按钮。

   1. 搜索空间文件:


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



   2. 配置文件:


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



* 你可以在这里查看和下载 ``nni-manager/dispatcher log files``。


.. image:: ../../img/webui-img/review-log.png
   :target: ../../img/webui-img/review-log.png
   :alt: logfile
kvartet's avatar
kvartet committed
82
83
84
85
86
87
88
89



* 如果 Experiment 包含了较多 Trial,可改变刷新间隔。


.. image:: ../../img/webui-img/refresh-interval.png
   :target: ../../img/webui-img/refresh-interval.png
kvartet's avatar
kvartet committed
90
91
   :alt: refresh

kvartet's avatar
kvartet committed
92
93
94



kvartet's avatar
kvartet committed
95
* 单击按钮 ``Experiment summary`` 时,可以查看和下载实验结果(``实验配置``,``试验消息`` 和 ``中间指标`` )。
kvartet's avatar
kvartet committed
96
97


kvartet's avatar
kvartet committed
98
99
100
.. image:: ../../img/webui-img/summary.png
   :target: ../../img/webui-img/summary.png
   :alt: summary
kvartet's avatar
kvartet committed
101
102
103



kvartet's avatar
kvartet committed
104
* 在这里修改 Experiment 配置(例如 ``maxExecDuration``, ``maxTrialNum`` 和 ``trial concurrency``)
kvartet's avatar
kvartet committed
105
106
107
108


.. image:: ../../img/webui-img/edit-experiment-param.png
   :target: ../../img/webui-img/edit-experiment-param.png
kvartet's avatar
kvartet committed
109
   :alt: editExperimentParams
kvartet's avatar
kvartet committed
110
111
112



kvartet's avatar
kvartet committed
113
* 通过单击 ``Learn about`` ,可以查看特定的错误消息和 ``nni-manager/dispatcher 日志文件``
kvartet's avatar
kvartet committed
114
115


kvartet's avatar
kvartet committed
116
117
118
.. image:: ../../img/webui-img/experimentError.png
   :target: ../../img/webui-img/experimentError.png
   :alt: experimentError
kvartet's avatar
kvartet committed
119
120
121
122




kvartet's avatar
kvartet committed
123
* 可点击 ``About`` 查看版本信息和反馈任何问题。
kvartet's avatar
kvartet committed
124
125

查看任务默认指标
kvartet's avatar
kvartet committed
126
----------------------------------------------
kvartet's avatar
kvartet committed
127
128


kvartet's avatar
kvartet committed
129
* 点击 ``Default Metric`` 来查看所有 Trial 的点图。 悬停鼠标来查看默认指标和搜索空间信息。
kvartet's avatar
kvartet committed
130
131
132
133


.. image:: ../../img/webui-img/default-metric.png
   :target: ../../img/webui-img/default-metric.png
kvartet's avatar
kvartet committed
134
   :alt: defaultMetricGraph
kvartet's avatar
kvartet committed
135
136
137



kvartet's avatar
kvartet committed
138
* 点击开关 ``optimization curve`` 来查看 Experiment 的优化曲线。
kvartet's avatar
kvartet committed
139
140
141
142


.. image:: ../../img/webui-img/best-curve.png
   :target: ../../img/webui-img/best-curve.png
kvartet's avatar
kvartet committed
143
   :alt: bestCurveGraph
kvartet's avatar
kvartet committed
144
145
146
147
148


查看超参
--------------------

kvartet's avatar
kvartet committed
149
单击 ``Intermediate Result`` 标签查看折线图。
kvartet's avatar
kvartet committed
150
151


kvartet's avatar
kvartet committed
152
* 可以 ``添加/删除`` 轴,或者拖动以交换图表上的轴。
kvartet's avatar
kvartet committed
153
154
155
156
157
* 可选择百分比查看最好的 Trial。


.. image:: ../../img/webui-img/hyperPara.png
   :target: ../../img/webui-img/hyperPara.png
kvartet's avatar
kvartet committed
158
159
   :alt: hyperParameterGraph

kvartet's avatar
kvartet committed
160
161
162
163
164


查看 Trial 运行时间
-------------------

kvartet's avatar
kvartet committed
165
点击 ``Trial Duration`` 标签来查看柱状图。
kvartet's avatar
kvartet committed
166
167
168
169


.. image:: ../../img/webui-img/trial_duration.png
   :target: ../../img/webui-img/trial_duration.png
kvartet's avatar
kvartet committed
170
171
   :alt: trialDurationGraph

kvartet's avatar
kvartet committed
172
173
174
175
176


查看 Trial 中间结果
------------------------------------

kvartet's avatar
kvartet committed
177
单击 ``Intermediate Result`` 标签查看折线图。
kvartet's avatar
kvartet committed
178
179
180
181


.. image:: ../../img/webui-img/trials_intermeidate.png
   :target: ../../img/webui-img/trials_intermeidate.png
kvartet's avatar
kvartet committed
182
183
   :alt: trialIntermediateGraph

kvartet's avatar
kvartet committed
184
185
186
187
188
189
190
191
192


Trial 可能在训练过程中有大量中间结果。 为了更清楚的理解一些 Trial 的趋势,可以为中间结果图设置过滤。

这样可以发现 Trial 在某个中间结果上会变得更好或更差。 这表明它是一个重要的并相关的中间结果。 如果要仔细查看这个点,可以在 #Intermediate 中输入其 X 坐标。 并输入这个中间结果的指标范围。 在下图中,选择了 No。 并将指标范围设置为了 0.8 -1。


.. image:: ../../img/webui-img/filter-intermediate.png
   :target: ../../img/webui-img/filter-intermediate.png
kvartet's avatar
kvartet committed
193
194
   :alt: filterIntermediateGraph

kvartet's avatar
kvartet committed
195
196
197
198
199


查看 Trial 状态
------------------

kvartet's avatar
kvartet committed
200
点击 ``Trials Detail`` 标签查看所有 Trial 的状态。 特别是: 特别是:
kvartet's avatar
kvartet committed
201
202
203
204
205
206
207


* Trial 详情:Trial 的 id,持续时间,开始时间,结束时间,状态,精度和搜索空间文件。


.. image:: ../../img/webui-img/detail-local.png
   :target: ../../img/webui-img/detail-local.png
kvartet's avatar
kvartet committed
208
   :alt: detailLocalImage
kvartet's avatar
kvartet committed
209
210
211



kvartet's avatar
kvartet committed
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
* 支持通过 id,状态,Trial 编号, 以及参数来搜索。  

1. Trial id: 

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


2. Trial No.: 

.. image:: ../../img/webui-img/detail/searchNo.png
   :target: ../../img/webui-img/detail/searchNo.png
   :alt: searchTrialNo.


3. Trial 状态:

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

4. Trial 参数:

(1) 类型为 choice 的参数:

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

(2) 类型不是 choice 的参数:

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


* ``Add column`` 按钮可选择在表格中显示的列。 如果 Experiment 的最终结果是 dict,则可以在表格中查看其它键。 * ``Add column`` 按钮可选择在表格中显示的列。 如果 Experiment 的最终结果是 dict,则可以在表格中查看其它键。 可选择 ``Intermediate count`` 列来查看 Trial 进度。
kvartet's avatar
kvartet committed
250
251
252
253


.. image:: ../../img/webui-img/addColumn.png
   :target: ../../img/webui-img/addColumn.png
kvartet's avatar
kvartet committed
254
   :alt: addColumnGraph
kvartet's avatar
kvartet committed
255
256
257



kvartet's avatar
kvartet committed
258
* 如果要比较某些 Trial,可选择并点击 ``Compare`` 来查看结果。
kvartet's avatar
kvartet committed
259
260
261
262


.. image:: ../../img/webui-img/select-trial.png
   :target: ../../img/webui-img/select-trial.png
kvartet's avatar
kvartet committed
263
   :alt: selectTrialGraph
kvartet's avatar
kvartet committed
264
265
266
267


.. image:: ../../img/webui-img/compare.png
   :target: ../../img/webui-img/compare.png
kvartet's avatar
kvartet committed
268
   :alt: compareTrialsGraph
kvartet's avatar
kvartet committed
269
270


kvartet's avatar
kvartet committed
271
* ``Tensorboard`` 请参考 `此文档 <Tensorboard.rst>`__。
kvartet's avatar
kvartet committed
272
273
274



kvartet's avatar
kvartet committed
275
* 可使用 ``Copy as python`` 按钮来拷贝 Trial 的参数。
kvartet's avatar
kvartet committed
276
277
278
279


.. image:: ../../img/webui-img/copyParameter.png
   :target: ../../img/webui-img/copyParameter.png
kvartet's avatar
kvartet committed
280
   :alt: copyTrialParameters
kvartet's avatar
kvartet committed
281
282
283



kvartet's avatar
kvartet committed
284
285
286
287
288
289
290
* 您可以在 ``Log`` 选项卡上看到 Trial 日志。 在本地模式下有 ``View trial log``, ``View trial error`` 和 ``View trial stdout`` 三个按钮。 * 如果在 OpenPAI 或 Kubeflow 平台上运行,还可以看到 hdfsLog。

1. 本机模式

.. image:: ../../img/webui-img/detail/log-local.png
   :target: ../../img/webui-img/detail/log-local.png
   :alt: logOnLocal
kvartet's avatar
kvartet committed
291
292


kvartet's avatar
kvartet committed
293
294
2. OpenPAI、Kubeflow 等模式:

kvartet's avatar
kvartet committed
295
296
.. image:: ../../img/webui-img/detail-pai.png
   :target: ../../img/webui-img/detail-pai.png
kvartet's avatar
kvartet committed
297
   :alt: detailPai
kvartet's avatar
kvartet committed
298
299
300
301
302
303
304


* 中间结果图:可在此图中通过点击 intermediate 按钮来查看默认指标。


.. image:: ../../img/webui-img/intermediate.png
   :target: ../../img/webui-img/intermediate.png
kvartet's avatar
kvartet committed
305
   :alt: intermeidateGraph
kvartet's avatar
kvartet committed
306
307
308
309
310
311
312
313



* Kill: 可终止正在运行的任务。


.. image:: ../../img/webui-img/kill-running.png
   :target: ../../img/webui-img/kill-running.png
kvartet's avatar
kvartet committed
314
   :alt: killTrial
kvartet's avatar
kvartet committed
315

kvartet's avatar
kvartet committed
316
317
318
319
320
321
322
323
324
325
326
327
328


* 自定义 Trial:您可以更改此 Trial 参数,然后将其提交给 Experiment。 如果您想重新运行失败的 Trial ,您可以向 Experiment 提交相同的参数。

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



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