From 280508a796b779cf5f76e9c14bbbd760c5c001c3 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 5 Feb 2023 12:23:56 +0200 Subject: [PATCH] Add search bar explanation (#466) --- docs/webapp/webapp_overview.md | 71 +++++++++++++++++++++++----------- 1 file changed, 49 insertions(+), 22 deletions(-) diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index d19256d4..8c674f62 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -11,8 +11,8 @@ The **ClearML Web UI** is the graphical user interface for the ClearML platform, ![WebApp screenshots gif](../img/gif/webapp_screenshots.gif) - -The ClearML Web UI is composed of the following pages: +## UI Modules +The WebApp's sidebar provides access to the following modules: * [Dashboard](webapp_home.md) - The dashboard for recent activity and quick access to experiments and projects. * [Projects](webapp_projects_page.md) - @@ -29,9 +29,14 @@ The ClearML Web UI is composed of the following pages: * [Pipelines](pipelines/webapp_pipeline_page.md) Pipelines - View and manage your pipelines. * [Reports](webapp_reports.md) Reports - View and manage your reports. * [Workers and Queues](webapp_workers_queues.md) Workers and Queues - The resource monitoring and queues management page. -* [Applications](applications/apps_overview.md) ClearML Apps - ClearML's GUI applications for no-code workflow execution. -* [Settings](webapp_profile.md) (available through the profile menu Profile button) - - Manage your ClearML user account: +* [Applications](applications/apps_overview.md) ClearML Apps - ClearML's GUI applications for no-code workflow execution. + +## UI Top Bar +### Settings Menu + +Click the profile menu button Profile button +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: * Set WebApp preferences * Manage workspace API credentials * Configure Cloud Storage Access credentials for the ClearML Web UI @@ -39,24 +44,46 @@ 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) - - -## WebApp Menus - -Click the help menu button Help menu -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 -* **[ClearML on Youtube](https://www.youtube.com/c/ClearML/featured)** YouTube - Instructional videos on integrating ClearML into your workflow -* **Online Documentation** -* **Pro Tips** - Tips for working with ClearML efficiently -* **[Contact Us](https://clear.ml/contact-us)** - Quick access to ClearML contact form - -Click the profile menu button Profile button - 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 +email > click **ADD** > page redirects 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 +* **Logout** of ClearML + +### Finding What You're Looking for +Use the search bar Magnifying glass +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 +Click the help menu button Help menu +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 +* [ClearML on YouTube](https://www.youtube.com/c/ClearML/featured) Youtube - Instructional videos on integrating ClearML into your workflow +* Online Documentation +* Pro Tips - Tips for working with ClearML efficiently +* [Contact Us](https://clear.ml/contact-us) - Quick access to ClearML contact form