WebUI.md

# WebUI

## View summary page

Click the tab "Overview".

* See the experiment trial profile and search space message.
* Support to download the experiment result.
* Support to export nni-manager and dispatcher log file.
* If you have any question, you can click "Feedback" to report it.
* If your experiment have more than 1000 trials, you can change the refresh interval on here.

![](../../img/webui-img/over1.png)
* See good performance trials.

![](../../img/webui-img/over2.png)

## View job default metric

Click the tab "Default Metric" to see the point graph of all trials. Hover to see its specific default metric and search space message.

![](../../img/accuracy.png)

## View hyper parameter

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

* You can select the percentage to see top trials.
* Choose two axis to swap its positions

![](../../img/hyperPara.png)

## View Trial Duration

Click the tab "Trial Duration" to see the bar graph.

![](../../img/trial_duration.png)

## View Trial Intermediate Result Graph

Click the tab "Intermediate Result" to see the lines graph.

![](../../img/webui-img/trials_intermeidate.png)

We set a filter function for the intermediate result graph because that the trials may have many intermediate results in the training progress. You need to provide three data if you want to use the filter button to see the trend of some trial.

What data should be written in the first input? Maybe you find an epoch those trials became better or worse. In other word, it's an important and concerned epoch. Just input it into the first input.

After selecting the epoch, you should input your focus metric's range on this epoch. Yes, it's the min and max value. Like this picture, I choose the epoch is 13 and the metric's range is 20-60.

As a result, I filter these trials the metric's range is 20-60 on the 13 epoch.

![](../../img/webui-img/filter_intermediate.png)

## View trials status

Click the tab "Trials Detail" to see the status of the all trials. Specifically:

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

![](../../img/webui-img/detail-local.png)

* The button named "Add column" can select which column to show in the table. If you run an experiment that final result is dict, you can see other keys in the table.

![](../../img/webui-img/addColumn.png)

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

![](../../img/webui-img/compare.png)

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

![](../../img/webui-img/copyParameter.png)

* If you run on OpenPAI or Kubeflow platform, you can also see the hdfsLog.

![](../../img/webui-img/detail-pai.png)


* Kill: you can kill a job that status is running.
* Support to search for a specific trial.
* Intermediate Result Graph: you can see default and other keys in this graph.

![](../../img/webui-img/intermediate.png)