Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Describe flat runs view #9644

Merged
merged 2 commits into from
Jul 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/images/webui-runs-compared.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/webui-runs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/tools/webui-if.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <web-ui-user-settings>`.

*************************************
Adding Models to the Model Registry
*************************************
Expand Down Expand Up @@ -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
************************
Expand Down
Loading