ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#500)

Browse Source
This commit is contained in:
pollfly 2023-03-19 12:34:17 +02:00 committed by GitHub
parent 22376ce6a1
commit 0b9495ba31
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 29 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/clearml_agent.md
View File

@ -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).

8
docs/hyperdatasets/webapp/webapp_datasets.md
View File

@ -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:
<div class="max-w-50">
![Hyper-Dataset project card](../../img/hyperdatasets/hyperdataset_project_card.png)
</div>
* 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:
<div class="max-w-50">
![Hyper-Dataset card](../../img/hyperdatasets/hyperdataset_card.png)
</div>
* Dataset name
* Time since last update. Hover over elapsed time to view date of last update
* User updating the Dataset

4
docs/webapp/datasets/webapp_dataset_page.md
View File

@ -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:
<div class="max-w-50">
![Project card](../../img/webapp_dataset_project_card.png)
</div>
* Project name
* Number of datasets in project
* Tags used by datasets in project

4
docs/webapp/pipelines/webapp_pipeline_page.md
View File

@ -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:
<div class="max-w-50">
![Pipeline project card](../../img/webapp_pipeline_project_card.png)
</div>
Click on a project card to view its pipelines.

4
docs/webapp/webapp_projects_page.md
View File

@ -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
<Collapsible title="Hidden Projects" type="configuration">
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 <img src="/docs/latest/icons/ico-ghost.svg" alt="Hidden project" className="icon size-md space-sm" />
![Hidden project configurtion](../img/settings_hidden_projects.png)
:::
</Collapsible>
### Project Actions

4
docs/webapp/webapp_reports.md
View File

@ -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:
<div class="max-w-50">
![Report project card](../img/webapp_report_project_card.png)
</div>
Click on a project card to view its reports.
### Report Cards

2
static/icons/ico-flat-view.svg
View File

@ -1,4 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20">
<path style="fill:none" d="M0 0h20v20H0z"/>
<path data-name="al-ico-flat-view" d="M7.333 4.833V6.5a.834.834 0 0 1-.833.833H4.833A.834.834 0 0 1 4 6.5V4.833A.834.834 0 0 1 4.833 4H6.5a.834.834 0 0 1 .833.833M6.5 9H4.833A.834.834 0 0 0 4 9.833V11.5a.834.834 0 0 0 .833.833H6.5a.834.834 0 0 0 .833-.833V9.833A.834.834 0 0 0 6.5 9m0 5H4.833a.834.834 0 0 0-.833.833V16.5a.834.834 0 0 0 .833.833H6.5a.834.834 0 0 0 .833-.833v-1.667A.834.834 0 0 0 6.5 14m5-10H9.833A.834.834 0 0 0 9 4.833V6.5a.834.834 0 0 0 .833.833H11.5a.834.834 0 0 0 .833-.833V4.833A.834.834 0 0 0 11.5 4m0 5H9.833A.834.834 0 0 0 9 9.833V11.5a.834.834 0 0 0 .833.833H11.5a.834.834 0 0 0 .833-.833V9.833A.834.834 0 0 0 11.5 9m0 5H9.833a.834.834 0 0 0-.833.833V16.5a.834.834 0 0 0 .833.833H11.5a.834.834 0 0 0 .833-.833v-1.667A.834.834 0 0 0 11.5 14m5-10h-1.667a.834.834 0 0 0-.833.833V6.5a.834.834 0 0 0 .833.833H16.5a.834.834 0 0 0 .833-.833V4.833A.834.834 0 0 0 16.5 4m0 5h-1.667a.834.834 0 0 0-.833.833V11.5a.834.834 0 0 0 .833.833H16.5a.834.834 0 0 0 .833-.833V9.833A.834.834 0 0 0 16.5 9m0 5h-1.667a.834.834 0 0 0-.833.833V16.5a.834.834 0 0 0 .833.833H16.5a.834.834 0 0 0 .833-.833v-1.667A.834.834 0 0 0 16.5 14" transform="translate(-.667 -.667)" style="fill:#dce0ee"/>
<path data-name="al-ico-flat-view" d="M7.333 4.833V6.5a.834.834 0 0 1-.833.833H4.833A.834.834 0 0 1 4 6.5V4.833A.834.834 0 0 1 4.833 4H6.5a.834.834 0 0 1 .833.833M6.5 9H4.833A.834.834 0 0 0 4 9.833V11.5a.834.834 0 0 0 .833.833H6.5a.834.834 0 0 0 .833-.833V9.833A.834.834 0 0 0 6.5 9m0 5H4.833a.834.834 0 0 0-.833.833V16.5a.834.834 0 0 0 .833.833H6.5a.834.834 0 0 0 .833-.833v-1.667A.834.834 0 0 0 6.5 14m5-10H9.833A.834.834 0 0 0 9 4.833V6.5a.834.834 0 0 0 .833.833H11.5a.834.834 0 0 0 .833-.833V4.833A.834.834 0 0 0 11.5 4m0 5H9.833A.834.834 0 0 0 9 9.833V11.5a.834.834 0 0 0 .833.833H11.5a.834.834 0 0 0 .833-.833V9.833A.834.834 0 0 0 11.5 9m0 5H9.833a.834.834 0 0 0-.833.833V16.5a.834.834 0 0 0 .833.833H11.5a.834.834 0 0 0 .833-.833v-1.667A.834.834 0 0 0 11.5 14m5-10h-1.667a.834.834 0 0 0-.833.833V6.5a.834.834 0 0 0 .833.833H16.5a.834.834 0 0 0 .833-.833V4.833A.834.834 0 0 0 16.5 4m0 5h-1.667a.834.834 0 0 0-.833.833V11.5a.834.834 0 0 0 .833.833H16.5a.834.834 0 0 0 .833-.833V9.833A.834.834 0 0 0 16.5 9m0 5h-1.667a.834.834 0 0 0-.833.833V16.5a.834.834 0 0 0 .833.833H16.5a.834.834 0 0 0 .833-.833v-1.667A.834.834 0 0 0 16.5 14" transform="translate(-.667 -.667)" style="fill:#8492c2"/>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB