diff --git a/docs/guides/ui/building_leader_board.md b/docs/guides/ui/building_leader_board.md index 86740fc5..3e13653e 100644 --- a/docs/guides/ui/building_leader_board.md +++ b/docs/guides/ui/building_leader_board.md @@ -26,7 +26,7 @@ For this tutorial, use one of the following as a project: The leaderboard will track experiments in one or all projects. Begin by opening the **ClearML Web UI** and selecting a project, by doing one of the following: -* On the Home page, click a project card or **VIEW ALL**. +* On the Dashboard, click a project card or **VIEW ALL**. * On the Projects page, click a project card or the **All projects** card. ## Step 2: Filter the Experiments diff --git a/docs/img/webapp_module_icons.png b/docs/img/webapp_module_icons.png new file mode 100644 index 00000000..617b0ebb Binary files /dev/null and b/docs/img/webapp_module_icons.png differ diff --git a/docs/webapp/webapp_exp_reproducing.md b/docs/webapp/webapp_exp_reproducing.md index c5f68fb2..9e94d165 100644 --- a/docs/webapp/webapp_exp_reproducing.md +++ b/docs/webapp/webapp_exp_reproducing.md @@ -13,9 +13,9 @@ Experiments can also be modified and then executed remotely, see [Tuning Experim **To reproduce an experiment:** -1. Locate the experiment. Open the Project page for the experiment from the Home page or the main Projects page. +1. Locate the experiment. Open the Project page for the experiment from the Dashboard or the main Projects page. - * On the Home page, click a recent experiment, project card, or **VIEW ALL** and then click a project card. + * On the Dashboard, click a recent experiment, project card, or **VIEW ALL** and then click a project card. * On the Projects page, click project card, or the **All projects** card. 1. Reproduce the experiment. In the experiments table, right click and then either: diff --git a/docs/webapp/webapp_exp_tuning.md b/docs/webapp/webapp_exp_tuning.md index a0cab972..5310f8b0 100644 --- a/docs/webapp/webapp_exp_tuning.md +++ b/docs/webapp/webapp_exp_tuning.md @@ -6,9 +6,9 @@ Tune experiments and edit an experiment's execution details, then execute the tu ## To Tune an Experiment and Execute it Remotely: -1. Locate the experiment. Open the experiment's Project page from the Home page or the main Projects page. +1. Locate the experiment. Open the experiment's Project page from the Dashboard or the main Projects page. - * On the Home page, + * On the Dashboard, * Click on an experiment from RECENT EXPERIMENTS * In RECENT PROJECTS **>** click on a project card **>** click experiment * In RECENT PROJECTS **>** click **VIEW ALL** **>** click the project card **>** click experiment diff --git a/docs/webapp/webapp_home.md b/docs/webapp/webapp_home.md index f392158b..a29fe722 100644 --- a/docs/webapp/webapp_home.md +++ b/docs/webapp/webapp_home.md @@ -1,9 +1,9 @@ --- -title: Home Page +title: Dashboard --- -The Home page provides the following options: +The **Dashboard** provides the following options: * Quickly access the summarized monitoring of recently updated projects and their experiments * Create new projects * Open the [**Workers & Queues**](webapp_workers_queues.md) tab to monitor resource utilization and to manage queues. diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index 8d9ca775..0cbd8c9a 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -13,10 +13,8 @@ The **ClearML Web UI** is the graphical user interface for the ClearML platform, The ClearML Web UI is composed of the following pages: -* The [Home](webapp_home.md) Page Homepage - - The dashboard for recent activity and quick access to experiments and projects. -* The [Projects Page](webapp_projects_page.md) Projects page - - The main experimentation page. Access your experiments and models as they are organized into projects. +* [Dashboard](webapp_home.md) - The dashboard for recent activity and quick access to experiments and projects. +* [Projects](webapp_projects_page.md) - The main experimentation page. Access your experiments and models as they are organized into projects. The [experiments](webapp_exp_table.md) and [models](webapp_model_table.md) are displayed in tables which let you: * [Track ongoing experiments and visualize their results](webapp_exp_track_visual.md) @@ -26,10 +24,9 @@ The ClearML Web UI is composed of the following pages: * [Share experiments and their models](webapp_exp_sharing.md) with other ClearML hosted service users * [Archive experiments and models](webapp_archiving.md) -* The [Workers and Queues](webapp_workers_queues.md) Page Workers & Queues page - - The resource monitoring and queues management page. +* [Workers and Queues](webapp_workers_queues.md) - The resource monitoring and queues management page. -* The [Settings Page](webapp_profile.md) Settings page - +* [Settings](webapp_profile.md) (available through the profile menu Profile button) - Manage your ClearML user account: * Set WebApp preferences * Manage workspace API credentials @@ -38,9 +35,9 @@ The ClearML Web UI is composed of the following pages: * View usage information * Manage users and workspaces * Manage resource access permissions (Available in the ClearML Enterprise plan) + +![module icons](../img/webapp_module_icons.png) - To navigate to the Settings page, click the Profile button - button in the top right corner of the web UI screen, then click **Settings**. ## WebApp Menus