User interface manual

Page transition flow:

../_images/page_flow.png

Global settings

../_images/global_setting.png

Results polling rate

Results polling rate is intervals between updates of results on project pages. When you feel your browser is slow, try choosing a longer value.

Chart size

Chart size is the size of the main plot on project pages.

Max log count

Max log count is the maximum number of logs per result that the ChainerUI server sends to the browser on each request. When you feel your browser is slow, try choosing a smaller value.

Result name alignment

Result name alignment controls which side of a result name to be truncated when it is too long to be displayed.

Home: Project list

../_images/home_project_list.png

From the list of registered projects, select a project to transition to the project page. When registering a project within running server, refresh the page and it will show the project on the list. See Customize training loop.

  • Edit: edit the project name.
  • Delete: delete the project from list.

Project: Show training chart and jobs

../_images/project_main.png

Show training logs and experimental conditions.

  • Select X-axis value by xAxis pane.

    • epoch, iteration, episode, step and elapsed_time are assumed as x-axis.
    • Drop-down list shows only keys existed in log files.

  • Select values by yLeftAxis and yRightAxis panes.

    • Line color is selected automatically. To change color, click a job name or a key name, see Edit a line.

  • Select training job to show on a chart.

  • Reset setting button

    • Along with axis settings and selected checkboxes, log keys like main/loss are also cached on browser storage. The reset button restores cached key, too.

Highlighting

../_images/project_highlight_animation.gif

This animation is captured on v0.7.0

Result table and a log chart are linked each other. A selected result is highlighting for emphasis.

Save log chart

../_images/chart_save.png
  • PNG: Save log chart as PNG
  • Code: Download Python script. Run the downloaded script then get a chart image using Matplotlib. Lines plotted or not are followed by configuration on Web UI. The script has all log data as JSON.

Edit a line

../_images/chart_edit_line.png

Show detail information about the line, and enable to change the line color. To show this modal, click a job name or a key name on yLeftAxis (yRightAxis).

Training job table

../_images/result_table_condition_sample1.png
../_images/result_table_expand_row.png

expanded the first row to show sub components.

The training job table shows brief log information and experimental conditions. Job names are set to the directory name by default. The name can be edit directly on the table. To unregister a result, click Unregister button in the expanded row. Expanded row has some operation buttons. These buttons operate similarly to buttons in Commands pane.

Note

[Known problem] Once a result is unregistered, a result with the same name cannot be restored on the result table. This will be fixed in future.

Result: Show detailed information of the results

../_images/result_detail.png

Show detailed information of the training job and support operation of the training loop.

Commands pane

Operation buttons in Commands pane allow users to operate the training job. To enable these buttons, the trining job is required to set CommandsExtension and click them within running the job. For more detail of how to set the extension, see Operate training loop.

Take snapshot

Save a training model to the file in NPZ format with using save_napz By default, snapshot_iter_{.updater.iteration} file is saved to the result path.

Stop

Stop the trining loop.

Adjust

Adjust the hyperparameters of an optimizer. This function supports only MomentumSGD optimizer.

Command history

The command history is shown on the down of the pane.