Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
nni
Commits
c9ddce99
Unverified
Commit
c9ddce99
authored
Dec 08, 2021
by
Lijiaoa
Committed by
GitHub
Dec 08, 2021
Browse files
update webui doc (#4358)
parent
91d9a797
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
31 additions
and
29 deletions
+31
-29
docs/en_US/Tutorial/WebUI.rst
docs/en_US/Tutorial/WebUI.rst
+5
-4
docs/zh_CN/Tutorial/WebUI.rst
docs/zh_CN/Tutorial/WebUI.rst
+26
-25
No files found.
docs/en_US/Tutorial/WebUI.rst
View file @
c9ddce99
...
...
@@ -124,7 +124,7 @@ View job default metric
-----------------------
* Click the tab ``Default
M
etric`` to see the point graph of all trials. Hover to see its specific default metric and search space message.
* Click the tab ``Default
m
etric`` to see the point graph of all trials. Hover to see its specific default metric and search space message.
.. image:: ../../img/webui-img/default-metric.png
...
...
@@ -133,7 +133,7 @@ View job default metric
*
Click
the switch named ``
o
ptimization curve`` to see the experiment's optimization curve.
*
Turn on
the switch named ``
O
ptimization curve`` to see the experiment's optimization curve.
.. image:: ../../img/webui-img/best-curve.png
...
...
@@ -144,10 +144,11 @@ View job default metric
View hyper parameter
--------------------
Click the tab ``Hyper
P
arameter`` to see the parallel graph.
Click the tab ``Hyper
-p
arameter`` to see the parallel graph.
* You can ``add/remove`` axes and drag to swap axes on the chart.
* You can click the ``add/remove`` button to add or remove axes.
* Drag the axes to swap axes on the chart.
* You can select the percentage to see top trials.
...
...
docs/zh_CN/Tutorial/WebUI.rst
View file @
c9ddce99
...
...
@@ -3,7 +3,7 @@
Web 界面
==================
Experiment 管理
Experiment
s
管理
-----------------------
点击导航栏上的 ``All experiments`` 标签。
...
...
@@ -22,7 +22,7 @@ Experiment 管理
*
当您想
查看 Experiment
的
更多详细信息时,可以单击
试验 ID
,如下所示:
* 查看 Experiment 更多详细信息时,可以单击
trial ID 跳转至该 Experiment 详情页
,如下所示:
.. image:: ../../img/webui-img/managerExperimentList/toAnotherExp.png
:target: ../../img/webui-img/managerExperimentList/toAnotherExp.png
...
...
@@ -30,7 +30,7 @@ Experiment 管理
* 如果
在
表格
上
有很多 Experiment
,可以使用 ``filter`` 按钮
* 如果表格
里
有很多 Experiment,可以使用 ``filter`` 按钮
。
.. image:: ../../img/webui-img/managerExperimentList/expFilter.png
:target: ../../img/webui-img/managerExperimentList/expFilter.png
...
...
@@ -44,7 +44,7 @@ Experiment 管理
点击 ``Overview`` 标签。
* 在 Overview 标签上,可看到 Experiment
T
rial 的概况、搜索空间
、
以及 ``top trials`` 的结果。
* 在 Overview 标签上,可看到 Experiment
t
rial 的概况、搜索空间以及 ``top trials`` 的结果。
.. image:: ../../img/webui-img/full-oview.png
...
...
@@ -73,7 +73,7 @@ Experiment 管理
* 你可以在这里查看和下载 ``nni-manager/dispatcher
log files
``。
* 你可以在这里查看和下载 ``nni-manager/dispatcher
日志文件
``。
.. image:: ../../img/webui-img/review-log.png
...
...
@@ -92,7 +92,7 @@ Experiment 管理
* 单击按钮 ``Experiment summary``
时
,可以查看和下载
实验结果(``实验配置``,``试验消
息`` 和 ``中间
指标
`` )。
* 单击按钮 ``Experiment summary`` ,可以查看和下载
Experiment 结果(``Experiment 配置``,``trial 信
息`` 和 ``中间
结果
`` )。
.. image:: ../../img/webui-img/summary.png
...
...
@@ -101,7 +101,7 @@ Experiment 管理
* 在这里修改 Experiment 配置(例如 ``maxExecDuration``, ``maxTrialNum`` 和 ``trial concurrency``)
* 在这里修改 Experiment 配置(例如 ``maxExecDuration``, ``maxTrialNum`` 和 ``trial concurrency``)
。
.. image:: ../../img/webui-img/edit-experiment-param.png
...
...
@@ -110,7 +110,7 @@ Experiment 管理
* 通过单击 ``Learn about`` ,可以查看
特定的
错误消息和 ``nni-manager/dispatcher 日志文件``
* 通过单击 ``Learn about`` ,可以查看错误消息和 ``nni-manager/dispatcher 日志文件``
.. image:: ../../img/webui-img/experimentError.png
...
...
@@ -120,13 +120,13 @@ Experiment 管理
*
可点击
``About``
查看版本信息和反馈任何问题
。
* ``About``
菜单内含有版本信息以及问题反馈渠道
。
查看
任务默认指标
查看
trial 最终结果
----------------------------------------------
*
点击
``Default
M
etric``
来查看
所有
T
rial 的
点图。 悬停鼠标来查看默认指标和搜索空间信息
。
* ``Default
m
etric``
是
所有
t
rial 的
最终结果图。 在每一个结果上悬停鼠标可以看到 trial 信息,比如 trial id、No.、超参等
。
.. image:: ../../img/webui-img/default-metric.png
...
...
@@ -135,7 +135,7 @@ Experiment 管理
*
点击开关
``
o
ptimization curve`` 来查看 Experiment 的优化曲线。
*
打开
``
O
ptimization curve`` 来查看 Experiment 的优化曲线。
.. image:: ../../img/webui-img/best-curve.png
...
...
@@ -146,11 +146,12 @@ Experiment 管理
查看超参
--------------------
单击 ``
Intermediate Result
`` 标签查看
折线
图。
单击 ``
Hyper-parameter
`` 标签查看
平行坐标系
图。
* 可以 ``添加/删除`` 轴,或者拖动以交换图表上的轴。
* 可选择百分比查看最好的 Trial。
* 可以点击 ``添加/删除`` 按钮来添加或删减纵坐标轴。
* 直接在图上拖动轴线来交换轴线位置。
* 通过调节百分比来查看 top trial。
.. image:: ../../img/webui-img/hyperPara.png
...
...
@@ -183,9 +184,9 @@ Experiment 管理
Trial
可能
在训练过程中有大量中间结果。 为了更清楚的理解一些 Trial 的趋势,可以为中间结果图设置过滤。
Trial 在训练过程中
可能
有大量中间结果。 为了更清楚的理解一些 Trial 的趋势,可以为中间结果图设置过滤
功能
。
这样可以发现 Trial 在某个中间结果上会变得更好或更差。 这表明它是一个重要的并相关的中间结果。 如果要仔细查看这个点,可以在 #Intermediate 中输入其 X 坐标。 并输入这个中间结果的指标范围。 在下图中,选择了
No。
并将指标范围设置为了 0.8 -1。
这样可以发现 Trial 在某个中间结果上会变得更好或更差。 这表明它是一个重要的并相关的中间结果。 如果要仔细查看这个点,可以在 #Intermediate 中输入其 X 坐标。 并输入这个中间结果的指标范围。 在下图中,选择了
第四个中间结果
并将指标范围设置为了 0.8 -1。
.. image:: ../../img/webui-img/filter-intermediate.png
...
...
@@ -197,10 +198,10 @@ Trial 可能在训练过程中有大量中间结果。 为了更清楚的理解
查看 Trial 状态
------------------
点击 ``Trials Detail`` 标签查看所有 Trial 的状态。
特别是: 特别是
:
点击 ``Trials Detail`` 标签查看所有 Trial 的状态。
具体如下
:
* Trial 详情:Trial
的
id,持续时间,开始时间,结束时间,状态,精度和
搜索空间
文件。
* Trial 详情:Trial id,持续时间,开始时间,结束时间,状态,精度和
search space
文件。
.. image:: ../../img/webui-img/detail-local.png
...
...
@@ -209,13 +210,13 @@ Trial 可能在训练过程中有大量中间结果。 为了更清楚的理解
* 支持通过 id,状态,Trial 编号
,
以及参数来搜索。
* 支持通过 id,状态,Trial 编号以及参数来搜索。
1. Trial id:
.. image:: ../../img/webui-img/
search-trial
.png
:target: ../../img/webui-img/
search-trial
.png
:alt: searchTrial
.. image:: ../../img/webui-img/
detail/searchId
.png
:target: ../../img/webui-img/
detail/searchId
.png
:alt: searchTrial
Id
2. Trial No.:
...
...
@@ -246,7 +247,7 @@ Trial 可能在训练过程中有大量中间结果。 为了更清楚的理解
:alt: searchParameterRange
* ``Add column`` 按钮可选择在表格中显示的列。 如果 Experiment 的最终结果是 dict,则可以在表格中查看其它键。
* ``Add column`` 按钮可选择在表格中显示的列。 如果 Experiment 的最终结果是 dict,则可以在表格中查看其它键。
可选择 ``Intermediate count`` 列来查看 Trial 进度。
* ``Add column`` 按钮可选择在表格中显示的列。 如果 Experiment 的最终结果是 dict,则可以在表格中查看其它键。可选择 ``Intermediate count`` 列来查看 Trial 进度。
.. image:: ../../img/webui-img/addColumn.png
...
...
@@ -315,7 +316,7 @@ Trial 可能在训练过程中有大量中间结果。 为了更清楚的理解
* 自定义 Trial:您可以更改此 Trial 参数,然后将其提交给 Experiment。
如果您想重新运行失败的 Trial ,您可以向 Experiment 提交相同的参数。
* 自定义 Trial:您可以更改此 Trial 参数,然后将其提交给 Experiment。如果您想重新运行失败的 Trial ,您可以向 Experiment 提交相同的参数。
.. image:: ../../img/webui-img/detail/customizedTrialButton.png
:target: ../../img/webui-img/detail/customizedTrialButton.png
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment