clearml-docs/docs/webapp/webapp_overview.md

72 lines
3.7 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
title: Overview
---
2021-12-22 08:54:04 +00:00
The **ClearML Web UI** is the graphical user interface for the ClearML platform, which includes:
2021-05-23 20:17:12 +00:00
* Experiment management
* Browsing
* Resource utilization monitoring
* Profile management
2021-12-22 08:54:04 +00:00
* Direct access to the ClearML community (Slack Channel, Youtube, and GitHub).
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
![image](../img/webapp_screenshots.gif)
2022-01-11 10:59:41 +00:00
The ClearML Web UI is composed of the following pages:
2022-01-11 14:18:11 +00:00
* [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.
2022-01-11 10:59:41 +00:00
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)
* [Reproduce previously run experiments](webapp_exp_reproducing.md)
* [Tune experiments with no code change](webapp_exp_tuning.md)
2021-05-13 23:48:51 +00:00
* [Compare experiments](webapp_exp_comparing.md)
2022-01-11 10:59:41 +00:00
* [Share experiments and their models](webapp_exp_sharing.md) with other ClearML hosted service users
2021-05-13 23:48:51 +00:00
* [Archive experiments and models](webapp_archiving.md)
2022-01-11 14:18:11 +00:00
* [Workers and Queues](webapp_workers_queues.md) - The resource monitoring and queues management page.
2022-01-11 10:59:41 +00:00
2022-01-11 14:18:11 +00:00
* [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" />) -
2022-01-11 10:59:41 +00:00
Manage your ClearML user account:
* Set WebApp preferences
* Manage workspace API credentials
* Configure Cloud Storage Access credentials for the ClearML Web UI
* ClearML Hosted service specific options
* View usage information
* Manage users and workspaces
* Manage resource access permissions (available in the ClearML Enterprise plan)
2022-01-11 14:18:11 +00:00
![module icons](../img/webapp_module_icons.png)
2021-05-13 23:48:51 +00:00
2022-01-11 10:59:41 +00:00
## WebApp Menus
Click the help menu button <img src="/docs/latest/icons/ico-help-outlined.svg" alt="Help menu" className="icon size-lg space-sm" />
in the top right corner of the web UI screen to access the self-help resources including:
* **ClearML Documentation**
* **Pro Tips** - Tips for working with ClearML efficiently
* **ClearML Python Package setup** - Instruction to get started with the `clearml` Python package
* **Contact Us** - Quick access to ClearML contact form
Click the profile menu button <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
in the top right corner of the web UI screen to access the following:
* **Settings** - Navigate to ClearML's [Settings](webapp_profile.md) page
* **Invite a User** to your workspace (supported in hosted service). Click **Invite a User** > input user's
email > click **ADD** > page will redirect to the [Users & Groups](webapp_profile.md#users--groups) section of
the **Settings** page
* **Switch to Workspace** - Hosted service users can be members of multiple workspaces. These workspaces are listed here.
Click a workspace to switch to.
* **Logout** of the workspace
2021-05-13 23:48:51 +00:00
2022-01-11 10:59:41 +00:00
## Community
In addition, from the **ClearML Web UI**, use these buttons to access the ClearML community resources:
* The **ClearML** <img src="/docs/latest/icons/ico-slack-c.svg" alt="Slack Channel" className="icon size-md" /> Slack channel.
Ask questions about **ClearML**.
* The **ClearML** <img src="/docs/latest/icons/ico-youtube.svg" alt="YouTube" className="icon size-md" /> YouTube Channel.
View our tutorials, presentations, and discussions.
* The **ClearML** <img src="/docs/latest/icons/ico-github.svg" alt="GitHub" className="icon size-md" /> GitHub repository.
2021-05-13 23:48:51 +00:00
2022-01-11 10:59:41 +00:00
For more information, see the [Community page](../community.md).