ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-01-31 06:27:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add search bar explanation (#466)

Browse Source
This commit is contained in:
pollfly 2023-02-05 12:23:56 +02:00 committed by GitHub
parent 3d74c9768d
commit 280508a796
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
docs/webapp/webapp_overview.md
View File

@ -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) <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.
* [Projects](webapp_projects_page.md) <img src="/docs/latest/icons/ico-projects.svg" className="icon size-md space-sm" /> -
@ -29,9 +29,14 @@ The ClearML Web UI is composed of the following pages:
* [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.
* [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.
* [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:
* [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:
* 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 <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
* **[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
* **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 <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
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 <img src="/docs/latest/icons/ico-search.svg" alt="Magnifying glass" className="icon size-sm space-sm" />
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 <img src="/docs/latest/icons/ico-help-outlined.svg" alt="Help menu" className="icon size-sm 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
* [ClearML on YouTube](https://www.youtube.com/c/ClearML/featured) <img src="/docs/latest/icons/ico-youtube.svg" alt="Youtube" className="icon size-sm space-sm" /> - 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