clearml-docs/docs/webapp/webapp_overview.md

90 lines
5.9 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
2023-02-05 10:23:56 +00:00
## UI Modules
The WebApp's sidebar provides access to the following modules:
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-12-22 09:36:45 +00:00
* [Pipelines](pipelines/webapp_pipeline_page.md) <img src="/docs/latest/icons/ico-pipelines.svg" alt="Pipelines" className="icon size-md space-sm" /> - View and manage your pipelines.
* [Reports](webapp_reports.md) <img src="/docs/latest/icons/ico-reports.svg" alt="Reports" className="icon size-md space-sm" /> - View and manage your reports.
* [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.
2023-02-05 10:23:56 +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.
## UI Top Bar
### Settings Menu
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 user [Settings](webapp_profile.md) page:
2022-01-11 10:59:41 +00:00
* 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 10:59:41 +00:00
* **Invite a User** to your workspace (supported in hosted service). Click **Invite a User** > input user's
2023-02-05 10:23:56 +00:00
email > click **ADD** > page redirects to the [Users & Groups](webapp_profile.md#users--groups) section of
2022-01-11 10:59:41 +00:00
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.
2023-02-05 10:23:56 +00:00
* **Logout** of ClearML
### Finding What You're Looking for
2023-02-05 11:43:44 +00:00
Use the search bar <img src="/docs/latest/icons/ico-search.svg" alt="Magnifying glass" className="icon size-md space-sm" />
2023-02-05 10:23:56 +00:00
to find your ClearML resources.
To search using regex, click the `.*` icon on the search bar.
Search results are returned for the different ClearML objects:
* Experiments - Searching an experiment table looks for matches in the experiments' name, ID, description and input and
output models. The enterprise version also includes experiment Dataviews' hyper-datasets and versions.
* Models - Searching a Model table looks for matches in the models' name, ID and description.
* Dataviews (Enterprise only) - Searching a Dataviews table looks for matches in the Dataviews' name, ID, description,
hyper-datasets, and versions.
* Datasets - Searching the datasets page looks for matches in the datasets' name, ID, and description. In a dataset's
version table, a search looks for matches in the versions' name, ID, and description.
* Pipelines - Searching the pipelines page looks for matches in the datasets' name, ID, and description. In a pipeline
run's table, a search looks for matches in the runs' name and ID.
* Reports - Searching the reports page looks for matches in the reports' name, ID, tags, project, description, and
report content.
The search bar in the [Dashboard](webapp_home.md) page searches the whole WebApp for objects that match queries as
specified above and returns results divided by object type (projects, experiments, models, etc.).
:::tip Additional filtering
ClearML's object tables (e.g. [experiments](webapp_exp_table.md), [models](webapp_model_table.md), [pipelines](pipelines/webapp_pipeline_table.md),
and [datasets](datasets/webapp_dataset_page.md)) provide column filters to easily focus your search by object properties
(e.g status, creation/update time, metric values, etc.).
:::
### Helpful Resources
2023-02-05 11:43:44 +00:00
Click the help menu button <img src="/docs/latest/icons/ico-help-outlined.svg" alt="Help menu" className="icon size-md space-sm" />
2023-02-05 10:23:56 +00:00
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
2023-02-05 11:43:44 +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 space-sm" /> - Instructional videos on integrating ClearML into your workflow
2023-02-05 10:23:56 +00:00
* Online Documentation
* Pro Tips - Tips for working with ClearML efficiently
* [Contact Us](https://clear.ml/contact-us) - Quick access to ClearML contact form