diff --git a/docs/assets/images/webui-runs-compared.png b/docs/assets/images/webui-runs-compared.png new file mode 100644 index 00000000000..62bbc04bf98 Binary files /dev/null and b/docs/assets/images/webui-runs-compared.png differ diff --git a/docs/assets/images/webui-runs.png b/docs/assets/images/webui-runs.png new file mode 100644 index 00000000000..106771d3922 Binary files /dev/null and b/docs/assets/images/webui-runs.png differ diff --git a/docs/tools/webui-if.rst b/docs/tools/webui-if.rst index a0b981a5361..b30952a4754 100644 --- a/docs/tools/webui-if.rst +++ b/docs/tools/webui-if.rst @@ -53,6 +53,30 @@ configuring an experiment via a YAML file, visit :ref:`experiment-config-referen You can access training and validation performance information via the WebUI. To see model evaluation in action, follow the steps described in the :ref:`pytorch-mnist-tutorial`. +****************************************** + Evaluating and Comparing Experiment Runs +****************************************** + +You can compare single trials with various datasets, parameters and settings so that you can choose +the best model. This simplified flat trials view lets you perform a quick metric evaluation by +selecting two or more runs to compare. To do this, select two or more runs and then select +**Compare**: + +.. image:: /assets/images/webui-runs.png + :alt: WebUI showing list of runs for comparison + +| + +In the compare view, choose a tab for comparing metrics, hyperparameters and other details of the +runs you selected. + +.. image:: /assets/images/webui-runs-compared.png + :alt: WebUI showing selected runs with hyperparameters compared + +| + +This feature can be toggled on or off in :ref:`user settings `. + ************************************* Adding Models to the Model Registry ************************************* @@ -101,6 +125,8 @@ visit :ref:`users`. With the Determined Enterprise Edition, you can also create and manage user groups. To learn more, visit :ref:`rbac`. +.. _web-ui-user-settings: + ************************ Managing User Settings ************************