From 0b9495ba31d64a053bcfdf0e48ebce6fd96275d3 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 19 Mar 2023 12:34:17 +0200 Subject: [PATCH] Small edits (#500) --- docs/clearml_agent.md | 12 ++++++------ docs/hyperdatasets/webapp/webapp_datasets.md | 8 ++++++++ docs/webapp/datasets/webapp_dataset_page.md | 4 ++++ docs/webapp/pipelines/webapp_pipeline_page.md | 4 ++++ docs/webapp/webapp_projects_page.md | 4 ++-- docs/webapp/webapp_reports.md | 4 ++++ static/icons/ico-flat-view.svg | 2 +- 7 files changed, 29 insertions(+), 9 deletions(-) diff --git a/docs/clearml_agent.md b/docs/clearml_agent.md index aab84b01..dba0562f 100644 --- a/docs/clearml_agent.md +++ b/docs/clearml_agent.md @@ -33,12 +33,12 @@ automated workflows in one (or both) of the following ways: * Through the ClearML Web UI (without working directly with code), by cloning experiments and enqueuing them to the queue that a ClearML Agent is servicing. - The agent facilitates [overriding task execution detail](webapp/webapp_exp_tuning.md) values through the UI without - code modification. Modifying a task clone’s configuration will have the ClearML agent executing it override the - original values: - * Modified package requirements will have the experiment script run with updated packages - * Modified recorded command line arguments will have the ClearML agent inject the new values in their stead - * Code-level configuration instrumented with [`Task.connect`](references/sdk/task.md#connect) will be overridden by modified hyperparameters +The agent facilitates [overriding task execution detail](webapp/webapp_exp_tuning.md) values through the UI without +code modification. Modifying a task clone’s configuration will have the ClearML agent executing it override the +original values: +* Modified package requirements will have the experiment script run with updated packages +* Modified recorded command line arguments will have the ClearML agent inject the new values in their stead +* Code-level configuration instrumented with [`Task.connect`](references/sdk/task.md#connect) will be overridden by modified hyperparameters For more information, see [ClearML Agent Reference](clearml_agent/clearml_agent_ref.md), and [configuration options](configs/clearml_conf.md#agent-section). diff --git a/docs/hyperdatasets/webapp/webapp_datasets.md b/docs/hyperdatasets/webapp/webapp_datasets.md index 7ba6bb0f..605c5832 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets.md +++ b/docs/hyperdatasets/webapp/webapp_datasets.md @@ -26,8 +26,12 @@ Filter the hyper-datasets to find the one you’re looking for more easily. Thes In Project view, project cards display a project’s summarized hyper-dataset information: +
+ ![Hyper-Dataset project card](../../img/hyperdatasets/hyperdataset_project_card.png) +
+ * Project name * Number of hyper-datasets in project * Tags used by hyper-datasets in project @@ -39,8 +43,12 @@ Click on a project card to view its hyper-datasets. In List view, the Hyper-Dataset cards display summarized dataset information: +
+ ![Hyper-Dataset card](../../img/hyperdatasets/hyperdataset_card.png) +
+ * Dataset name * Time since last update. Hover over elapsed time to view date of last update * User updating the Dataset diff --git a/docs/webapp/datasets/webapp_dataset_page.md b/docs/webapp/datasets/webapp_dataset_page.md index f24d9f2c..779e6a70 100644 --- a/docs/webapp/datasets/webapp_dataset_page.md +++ b/docs/webapp/datasets/webapp_dataset_page.md @@ -31,8 +31,12 @@ Filter the datasets to find the one you’re looking for more easily. These filt In Project view, project cards display a project’s summarized dataset information: +
+ ![Project card](../../img/webapp_dataset_project_card.png) +
+ * Project name * Number of datasets in project * Tags used by datasets in project diff --git a/docs/webapp/pipelines/webapp_pipeline_page.md b/docs/webapp/pipelines/webapp_pipeline_page.md index fdb9d4e8..f0b99049 100644 --- a/docs/webapp/pipelines/webapp_pipeline_page.md +++ b/docs/webapp/pipelines/webapp_pipeline_page.md @@ -26,8 +26,12 @@ Filter the pipelines to find the one you’re looking for more easily. These fil ## Project Cards In Project view, project cards display a project's summarized pipeline information: +
+ ![Pipeline project card](../../img/webapp_pipeline_project_card.png) +
+ Click on a project card to view its pipelines. diff --git a/docs/webapp/webapp_projects_page.md b/docs/webapp/webapp_projects_page.md index acfb1582..8a0cece0 100644 --- a/docs/webapp/webapp_projects_page.md +++ b/docs/webapp/webapp_projects_page.md @@ -28,13 +28,13 @@ subprojects. Click on a subproject's name to navigate to it. ![Subproject tab](../img/webapp_sub_project_card.png) -:::note Hidden Projects + By default, ClearML infrastructure projects (i.e. dataset, pipeline, reports, application projects) are not shown in the projects page. You can enable viewing them in **Settings > Configuration > User Preferences**. When enabled, all infrastructure projects are labeled with Hidden project ![Hidden project configurtion](../img/settings_hidden_projects.png) -::: + ### Project Actions diff --git a/docs/webapp/webapp_reports.md b/docs/webapp/webapp_reports.md index 91a6d816..d108775e 100644 --- a/docs/webapp/webapp_reports.md +++ b/docs/webapp/webapp_reports.md @@ -72,8 +72,12 @@ top-level projects are displayed. Click on a project card to view the project's ## Project Cards In Project view, project cards display a project’s summarized report information: +
+ ![Report project card](../img/webapp_report_project_card.png) +
+ Click on a project card to view its reports. ### Report Cards diff --git a/static/icons/ico-flat-view.svg b/static/icons/ico-flat-view.svg index b5ba3859..24052dbb 100644 --- a/static/icons/ico-flat-view.svg +++ b/static/icons/ico-flat-view.svg @@ -1,4 +1,4 @@ - +