diff --git a/docs/img/webapp_experiment_table.png b/docs/img/webapp_experiment_table.png index 7623f945..69e60d6d 100644 Binary files a/docs/img/webapp_experiment_table.png and b/docs/img/webapp_experiment_table.png differ diff --git a/docs/img/webapp_experiment_table_context_menu.png b/docs/img/webapp_experiment_table_context_menu.png index 715f03b2..5f0aec25 100644 Binary files a/docs/img/webapp_experiment_table_context_menu.png and b/docs/img/webapp_experiment_table_context_menu.png differ diff --git a/docs/img/webapp_experiment_table_context_menu_dark.png b/docs/img/webapp_experiment_table_context_menu_dark.png index e0bd1c4e..ed1c0e67 100644 Binary files a/docs/img/webapp_experiment_table_context_menu_dark.png and b/docs/img/webapp_experiment_table_context_menu_dark.png differ diff --git a/docs/img/webapp_experiment_table_dark.png b/docs/img/webapp_experiment_table_dark.png index 2b3544a7..62df1f16 100644 Binary files a/docs/img/webapp_experiment_table_dark.png and b/docs/img/webapp_experiment_table_dark.png differ diff --git a/docs/img/webapp_search_options.png b/docs/img/webapp_search_options.png new file mode 100644 index 00000000..39378102 Binary files /dev/null and b/docs/img/webapp_search_options.png differ diff --git a/docs/img/webapp_search_options_dark.png b/docs/img/webapp_search_options_dark.png new file mode 100644 index 00000000..9fb3667e Binary files /dev/null and b/docs/img/webapp_search_options_dark.png differ diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index ed41e7c0..f539de3e 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -66,18 +66,25 @@ to access the following: * **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. +The ClearML UI provides two search options on most pages: +* **In-page search**: Each object (e.g. projects, tasks etc.) page includes its own search bar Magnifying glass + for filtering the objects shown on that page. This search focuses on attributes relevant to that object type: + * Projects: show projects whose name or ID match the searched text + * Tasks: show tasks whose name, ID, description, or input/output models match the searched text + * Models: show models whose name, ID, or description match the searched text. + * Dataviews: show dataviews whose name, ID, description, hyper-datasets, or hyper-dataset versions match the searched text. + * Reports: show reports whose name, ID, tags, project, description, or content match the searched text. + * Datasets: show datasets whose name, ID, or description match the searched text + * Pipeline Runs: show reports whose name, ID, or description match the searched text +* **Global search**: The search bar Magnifying glass + on the top banner of every page searches the whole WebApp for objects that match the queries as specified above and + returns results grouped by object (projects, tasks, models, etc.). -The search functionality is tailored to each page, returning results specific to the object type displayed on the page. -For example, searching a task table looks for matches in the tasks' name, ID, description and input and output models. -On the reports page, it matches reports by name, ID, tags, project, description, and content. Similarly, searches in -models, datasets, pipelines, dataviews, and annotations, focus on attributes relevant to their respective objects. +To use regular expressions, click the .* icon in the search bar. -The search bar in the [Project 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, tasks, models, etc.). +![WebApp Search options](../img/webapp_search_options.png#light-mode-only) +![WebApp Search options](../img/webapp_search_options_dark.png#dark-mode-only) :::tip Additional filtering ClearML's object tables (e.g. [tasks](webapp_exp_table.md), [models](webapp_model_table.md), [pipelines](pipelines/webapp_pipeline_table.md),