clearml-docs/docs/webapp/webapp_overview.md

62 lines
4.1 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
2022-04-10 07:50:21 +00:00
![WebApp screenshots gif](../img/gif/webapp_screenshots.gif)
2021-05-13 23:48:51 +00:00
2022-01-11 10:59:41 +00:00
The ClearML Web UI is composed of the following pages:
2022-06-30 18:46:22 +00:00
* [Dashboard](webapp_home.md) <img src="/docs/latest/icons/ico-homepage.svg" className="icon size-md space-sm" /> -
The dashboard for recent activity and quick access to experiments and projects.
2022-06-30 18:46:22 +00:00
* [Projects](webapp_projects_page.md) <img src="/docs/latest/icons/ico-projects.svg" className="icon size-md space-sm" /> -
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)
* [Datasets](datasets/webapp_dataset_page.md) <img src="/docs/latest/icons/ico-side-bar-datasets.svg" alt="Datasets" className="icon size-md space-sm" /> - View and manage your datasets.
2022-06-30 18:46:22 +00:00
* [Pipelines](pipelines/webapp_pipeline_page.md) <img src="/docs/latest/icons/ico-pipelines.svg" className="icon size-md space-sm" /> - View and manage your pipelines.
* [Workers and Queues](webapp_workers_queues.md) <img src="/docs/latest/icons/ico-workers.svg" alt="Workers and Queues" className="icon size-md space-sm" /> - The resource monitoring and queues management page.
2022-08-03 09:15:15 +00:00
* [Applications](applications/apps_overview.md) <img src="/docs/latest/icons/ico-applications.svg" alt="ClearML Apps" className="icon size-md space-sm" /> - ClearML's GUI applications for no-code workflow execution.
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
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 Python Package setup** - Instruction to get started with the `clearml` Python package
2022-06-12 09:28:08 +00:00
* **[ClearML on Youtube](https://www.youtube.com/c/ClearML/featured)** <img src="/docs/latest/icons/ico-youtube.svg" alt="YouTube" className="icon size-md" /> - Instructional videos on integrating ClearML into your workflow
2022-04-07 08:49:11 +00:00
* **Online Documentation**
* **Pro Tips** - Tips for working with ClearML efficiently
2022-06-12 09:28:08 +00:00
* **[Contact Us](https://clear.ml/contact-us)** - Quick access to ClearML contact form
2022-01-11 10:59:41 +00:00
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