Unverified Commit e0995574 authored by Lijiaoa's avatar Lijiaoa Committed by GitHub
Browse files

[doc-v1.9] update webui document (#2985)

parent b5e4d15d
......@@ -294,8 +294,8 @@ You can use these commands to get more information about the experiment
* Open the `Web UI url` in your browser, you can view detail information of the experiment and all the submitted trial jobs as shown below. [Here](docs/en_US/Tutorial/WebUI.md) are more Web UI pages.
<table style="border: none">
<th><img src="./docs/img/webui_overview_page.png" alt="drawing" width="395"/></th>
<th><img src="./docs/img/webui_trialdetail_page.png" alt="drawing" width="410"/></th>
<th><img src="./docs/img/webui-img/full-oview.png" alt="drawing" width="395" height="300"/></th>
<th><img src="./docs/img/webui-img/full-detail.png" alt="drawing" width="410" height="300"/></th>
</table>
## **Documentation**
......
......@@ -4,22 +4,26 @@
Click the tab "Overview".
* On the overview tab, you can see the experiment trial profile/search space and the performance of top trials.
* 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".
![](../../img/webui-img/over1.png)
![](../../img/webui-img/over2.png)
![](../../img/webui-img/full-oview.png)
* If your experiment has many trials, you can change the refresh interval here.
![](../../img/webui-img/refresh-interval.png)
* You can review and download the experiment results and nni-manager/dispatcher log files from the "View" button.
* You can review and download the experiment results and nni-manager/dispatcher log files from the "Download" button.
![](../../img/webui-img/download.png)
* You can change some experiment configurations such as maxExecDuration, maxTrialNum and trial concurrency on here.
![](../../img/webui-img/edit-experiment-param.png)
* You can click the exclamation point in the error box to see a log message if the experiment's status is an error.
![](../../img/webui-img/log-error.png)
![](../../img/webui-img/review-log.png)
* You can click "Feedback" to report any questions.
* You can click "About" to see the version and report any questions.
## View job default metric
......@@ -35,15 +39,15 @@ Click the tab "Overview".
Click the tab "Hyper Parameter" to see the parallel graph.
* You can add/remove axes and drag to swap axes on the chart.
* You can select the percentage to see top trials.
* Choose two axis to swap its positions
![](../../img/hyperPara.png)
![](../../img/webui-img/hyperPara.png)
## View Trial Duration
Click the tab "Trial Duration" to see the bar graph.
![](../../img/trial_duration.png)
![](../../img/webui-img/trial_duration.png)
## View Trial Intermediate Result Graph
Click the tab "Intermediate Result" to see the line graph.
......@@ -75,14 +79,12 @@ Click the tab "Trials Detail" to see the status of all trials. Specifically:
* You can use the button named "Copy as python" to copy the trial's parameters.
![](../../img/webui-img/copyParameter.png)
* If you run on the OpenPAI or Kubeflow platform, you can also see the hdfsLog.
* If you run on the OpenPAI or Kubeflow platform, you can also see the nfs log.
![](../../img/webui-img/detail-pai.png)
* Intermediate Result Graph: you can see the default and other keys in this graph by clicking the operation column button.
* Intermediate Result Graph: you can see the default metric in this graph by clicking the intermediate button.
![](../../img/webui-img/intermediate-btn.png)
![](../../img/webui-img/intermediate.png)
* Kill: you can kill a job that status is running.
![](../../img/webui-img/kill-running.png)
![](../../img/webui-img/canceled.png)
![](../../img/webui-img/kill-running.png)
\ No newline at end of file
docs/img/webui-img/addColumn.png

36.6 KB | W: | H:

docs/img/webui-img/addColumn.png

15 KB | W: | H:

docs/img/webui-img/addColumn.png
docs/img/webui-img/addColumn.png
docs/img/webui-img/addColumn.png
docs/img/webui-img/addColumn.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/best-curve.png

32.7 KB | W: | H:

docs/img/webui-img/best-curve.png

37.3 KB | W: | H:

docs/img/webui-img/best-curve.png
docs/img/webui-img/best-curve.png
docs/img/webui-img/best-curve.png
docs/img/webui-img/best-curve.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/compare.png

43 KB | W: | H:

docs/img/webui-img/compare.png

31.7 KB | W: | H:

docs/img/webui-img/compare.png
docs/img/webui-img/compare.png
docs/img/webui-img/compare.png
docs/img/webui-img/compare.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/copyParameter.png

24.4 KB | W: | H:

docs/img/webui-img/copyParameter.png

13.1 KB | W: | H:

docs/img/webui-img/copyParameter.png
docs/img/webui-img/copyParameter.png
docs/img/webui-img/copyParameter.png
docs/img/webui-img/copyParameter.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/default-metric.png

25.8 KB | W: | H:

docs/img/webui-img/default-metric.png

27.6 KB | W: | H:

docs/img/webui-img/default-metric.png
docs/img/webui-img/default-metric.png
docs/img/webui-img/default-metric.png
docs/img/webui-img/default-metric.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/detail-local.png

20.5 KB | W: | H:

docs/img/webui-img/detail-local.png

22.8 KB | W: | H:

docs/img/webui-img/detail-local.png
docs/img/webui-img/detail-local.png
docs/img/webui-img/detail-local.png
docs/img/webui-img/detail-local.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/detail-pai.png

12.7 KB | W: | H:

docs/img/webui-img/detail-pai.png

13.8 KB | W: | H:

docs/img/webui-img/detail-pai.png
docs/img/webui-img/detail-pai.png
docs/img/webui-img/detail-pai.png
docs/img/webui-img/detail-pai.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/download.png

23.3 KB | W: | H:

docs/img/webui-img/download.png

24.1 KB | W: | H:

docs/img/webui-img/download.png
docs/img/webui-img/download.png
docs/img/webui-img/download.png
docs/img/webui-img/download.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/intermediate.png

18.9 KB | W: | H:

docs/img/webui-img/intermediate.png

55 KB | W: | H:

docs/img/webui-img/intermediate.png
docs/img/webui-img/intermediate.png
docs/img/webui-img/intermediate.png
docs/img/webui-img/intermediate.png
  • 2-up
  • Swipe
  • Onion skin
docs/img/webui-img/kill-running.png

19.1 KB | W: | H:

docs/img/webui-img/kill-running.png

24.3 KB | W: | H:

docs/img/webui-img/kill-running.png
docs/img/webui-img/kill-running.png
docs/img/webui-img/kill-running.png
docs/img/webui-img/kill-running.png
  • 2-up
  • Swipe
  • Onion skin
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment