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 (#418)

Browse Source
This commit is contained in:
pollfly
2022-12-26 11:08:10 +02:00
committed by GitHub
parent 9e3917bde8
commit 0addbc3549
37 changed files with 70 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/webapp/applications/apps_overview.md
View File

@@ -47,7 +47,7 @@ The prefilled configuration wizard can be edited before launching the new app in
:::
## App Instance Actions
Access app instance actions, by right clicking an instance, or through the menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> (available on hover).
Access app instance actions, by right-clicking an instance, or through the menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> (available on hover).
![App context menu](../../img/app_context_menu.png)

8
docs/webapp/pipelines/webapp_pipeline_table.md
View File

@@ -10,7 +10,7 @@ View the runs table in table view <img src="/docs/latest/icons/ico-table-view.sv
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your runs according to
columns of interest. Use the details view to access a selected run’s details, while keeping the pipeline runs list in view.
Details view can also be accessed by double clicking a specific pipeline run in the table view to open its details view.
Details view can also be accessed by double-clicking a specific pipeline run in the table view to open its details view.
![Pipeline runs table](../../img/webapp_pipeline_runs_table.png)
@@ -39,7 +39,7 @@ Customize the table using any of the following:
to view and select columns to show. Click **Metric** and **Hyper Parameter** to add the respective custom columns
* [Filter columns](#filtering-columns)
* Sort columns
* Resize columns - Drag the column separator to change the width of that column. Double click the column separator for
* Resize columns - Drag the column separator to change the width of that column. Double-click the column separator for
automatic fit.
Changes are persistent (cached in the browser) and represented in the URL, so customized settings can be saved in a
@@ -70,7 +70,7 @@ To clear all active filters, click <img src="/docs/latest/icons/ico-filter-reset
in the top right corner of the table.
:::note
The following table customizations are saved on a per pipeline basis:
The following table customizations are saved on a per-pipeline basis:
* Columns order
* Column width
* Active sort order
@@ -95,7 +95,7 @@ The following table describes the actions that can be done from the run table, i
that allow each operation.
Access these actions with the context menu in any of the following ways:
* In the pipeline runs table, right click a run, or hover over a pipeline and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
* In the pipeline runs table, right-click a run, or hover over a pipeline and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
* In a pipeline info panel, click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bar menu" className="icon size-md space-sm" />
| Action | Description | States Valid for the Action | State Transition |

2
docs/webapp/webapp_archiving.md
View File

@@ -16,7 +16,7 @@ When archiving an experiment:
* Archive an experiment or model from either the:
* Experiments or models table - Right click the experiment or model **>** **Archive**.
* Experiments or models table - Right-click the experiment or model **>** **Archive**.
* Info panel or full screen details view - Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu) **>** **Archive**.
* Archive multiple experiments or models from the:

2
docs/webapp/webapp_exp_reproducing.md
View File

@@ -18,7 +18,7 @@ Experiments can also be modified and then executed remotely, see [Tuning Experim
* On the Dashboard, click a recent experiment, project card, or **VIEW ALL** and then click a project card.
* On the Projects page, click project card, or the **All projects** card.
1. Reproduce the experiment. In the experiments table, right click and then either:
1. Reproduce the experiment. In the experiments table, right-click and then either:
* Clone (make an exact copy)

2
docs/webapp/webapp_exp_sharing.md
View File

@@ -22,7 +22,7 @@ Share experiments from the experiments table, the info panel menu, and/or the fu
1. Click **Share** in one of these ways:
* The experiment table - Right click the experiment **>** **Share**
* The experiment table - Right-click the experiment **>** **Share**
* The info panel or full screen details view - Click the experiment **>** <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
(menu) **>** **Share**.

8
docs/webapp/webapp_exp_table.md
View File

@@ -10,7 +10,7 @@ View the experiments table in table view <img src="/docs/latest/icons/ico-table-
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your experiments according
to columns of interest. Use the details view to access a selected experiment’s details, while keeping the experiment list
in view. Details view can also be accessed by double clicking a specific experiment in the table view to open its details view.
in view. Details view can also be accessed by double-clicking a specific experiment in the table view to open its details view.
:::info
To assist in focusing on active experimentation, experiments and models can be archived, so they will not appear
@@ -45,7 +45,7 @@ The experiments table default and customizable columns are described in the foll
Customize the table using any of the following:
* Dynamic column order - Drag a column title to a different position.
* Resize columns - Drag the column separator to change the width of that column. Double click the column separator for
* Resize columns - Drag the column separator to change the width of that column. Double-click the column separator for
automatic fit.
* Changing table columns
* Show / hide columns - Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" />
@@ -68,7 +68,7 @@ Changes are persistent (cached in the browser), and represented in the URL so cu
bookmark and shared with other ClearML users to collaborate.
:::note
The following experiments-table customizations are saved on a **per project** basis:
The following experiments-table customizations are saved on a **per-project** basis:
* Columns order
* Column width
* Active sort order
@@ -132,7 +132,7 @@ The following table describes the actions that can be done from the experiments
that allow each operation.
Access these actions with the context menu in any of the following ways:
* In the experiments table,right click an experiment or hover over an experiment and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
* In the experiments table, right-click an experiment or hover over an experiment and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
* In an experiment info panel, click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bar menu" className="icon size-md space-sm" />
| Action | Description | States Valid for the Action | State Transition |

10
docs/webapp/webapp_model_table.md
View File

@@ -9,7 +9,7 @@ View the models table in table view <img src="/docs/latest/icons/ico-table-view.
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your models according to
columns of interest. Use the details view to access a selected model’s details, while keeping the model list in view.
Details view can also be accessed by double clicking a specific model in the table view to open its details view.
Details view can also be accessed by double-clicking a specific model in the table view to open its details view.
![Models table](../img/webapp_models_01.png)
@@ -39,7 +39,7 @@ can be saved in a browser bookmark and shared with other ClearML users to collab
Customize the table using any of the following:
* Dynamic column order - Drag a column title to a different position.
* Resize columns - Drag the column separator to change the width of that column. Double click the column separator for
* Resize columns - Drag the column separator to change the width of that column. Double-click the column separator for
automatic fit.
* Changing table columns
* Show / hide columns - Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" />
@@ -51,7 +51,7 @@ Customize the table using any of the following:
* Sort columns - By metadata, ML framework, description, and last update elapsed time.
:::note
The following models-table customizations are saved on a **per project** basis:
The following models-table customizations are saved on a **per-project** basis:
* Columns order
* Column width
* Active sort order
@@ -68,12 +68,12 @@ The following table describes the actions that can be done from the models table
allow each feature. Model states are *Draft* (editable) and *Published* (read-only).
Access these actions with the context menu in any of the following ways:
* In the models table, right click a model, or hover over a model and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
* In the models table, right-click a model, or hover over a model and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
* In a model's info panel, click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bar menu" className="icon size-md space-sm" />
| ClearML Action | Description | States Valid for the Action |
|---|---|--|
| Details | View model details, which include general information, the model configuration, and label enumeration. Can also be accessed by double clicking a model in the models table | Any state |
| Details | View model details, which include general information, the model configuration, and label enumeration. Can also be accessed by double-clicking a model in the models table | Any state |
| Publish | Publish a model to prevent changes to it. *Published* models are read-only. If a model is Published, its experiment also becomes Published (read-only). | *Draft* |
| Archive | To more easily work with active models, move a model to the archive. See [Archiving](webapp_archiving.md). | Any state |
| Restore | Action available in the archive. Restore a model to the active model table. | Any state |

2
docs/webapp/webapp_model_viewing.md
View File

@@ -2,7 +2,7 @@
title: Model Details
---
In the models table, double click on a model to view and / or modify the following:
In the models table, double-click on a model to view and / or modify the following:
* General model information
* Model configuration
* Model label enumeration

2
docs/webapp/webapp_profile.md
View File

@@ -144,7 +144,7 @@ file entries will be overridden by the vault values.
Fill in values using any of ClearML supported configuration formats: HOCON / JSON / YAML.
**To edit vault contents:**
1. Click **EDIT** or double click the vault box
1. Click **EDIT** or double-click the vault box
1. Insert / edit the configurations in the vault
1. Press **OK**