ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-03 02:32:49 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

small edits (#155)

Browse Source
This commit is contained in:
pollfly 2022-01-11 16:18:11 +02:00 committed by GitHub
parent a91c92d76f
commit 93ef98a051
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guides/ui/building_leader_board.md
View File

@ -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

BIN
docs/img/webapp_module_icons.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

4
docs/webapp/webapp_exp_reproducing.md
View File

@ -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:

4
docs/webapp/webapp_exp_tuning.md
View File

@ -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

4
docs/webapp/webapp_home.md
View File

@ -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.

15
docs/webapp/webapp_overview.md
View File

@ -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 <img src="/docs/latest/icons/ico-homepage.svg" alt="Homepage" className="icon size-md" /> -
The dashboard for recent activity and quick access to experiments and projects.
* The [Projects Page](webapp_projects_page.md) <img src="/docs/latest/icons/ico-projects.svg" alt="Projects page" className="icon size-md" /> -
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 <img src="/docs/latest/icons/ico-workers.svg" alt="Workers & Queues page" className="icon size-md" /> -
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) <img src="/docs/latest/icons/ico-settings.svg" alt="Settings page" className="icon size-md" /> -
* [Settings](webapp_profile.md) (available through the profile menu <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />) -
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 <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
button in the top right corner of the web UI screen, then click **Settings**.
## WebApp Menus