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

Browse Source
This commit is contained in:
pollfly
2025-02-09 19:35:03 +02:00
committed by GitHub
parent 0b45e486f2
commit 9f2935fbbd
17 changed files with 88 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/webapp/datasets/webapp_dataset_viewing.md
View File

@@ -107,7 +107,7 @@ Access these actions with the context menu by right-clicking a version on the da
|-----|----|
|Add Tag |User-defined labels added to versions for grouping and organization. |
|Archive| Move dataset versions to the dataset's archive. |
|Restore|Action available in the archive. Restore a version to the active dataset versions table.|
|Restore|Action available in the archive. Restore a version to the active dataset version table.|
|Delete| Delete an archived version and its artifacts. This action is available only from the dataset's archive. |
![Dataset actions](../../img/webapp_dataset_actions.png#light-mode-only)

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

@@ -1,5 +1,5 @@
---
title: The Pipeline Runs Table
title: The Pipeline Run Table
---
The pipeline runs table is a [customizable](#customizing-the-runs-table) list of the pipeline's runs. Use it to
@@ -31,7 +31,7 @@ The downloaded data consists of the currently displayed table columns.
## Run Table Columns
The models table contains the following columns:
The pipeline run table contains the following columns:
| Column | Description | Type |
|---|---|---|

2
docs/webapp/webapp_exp_reproducing.md
View File

@@ -32,7 +32,7 @@ the original task to become the clone's parent.
## Resetting
To reset a task:
1. In the tasks table, right-click the relevant task and click **Reset**.
1. In the task table, right-click the relevant task and click **Reset**.
1. In the `Reset Task` modal, if you want the task's artifacts and debug samples to be deleted from the
ClearML file server, click the checkbox
1. Click **Reset**

2
docs/webapp/webapp_model_comparing.md
View File

@@ -7,7 +7,7 @@ You can view the differences in model details, configuration, scalar values, and
## Selecting Models to Compare
To select models to compare:
1. Go to a models table that includes the models to be compared.
1. Go to a model table that includes the models to be compared.
1. Select the models to compare. Once multiple models are selected, the batch action bar appears.
1. In the batch action bar, click **COMPARE**.

2
docs/webapp/webapp_model_endpoints.md
View File

@@ -2,7 +2,7 @@
title: Model Endpoints
---
The Model Endpoints table lists all currently live (active, and being brought up) model endpoints, allowing you to view
The Model Endpoint table lists all currently live (active, and being brought up) model endpoints, allowing you to view
endpoint details and monitor status over time. Whenever you deploy a model through the [ClearML Deploy UI applications](applications/apps_overview.md#deploy),
it will be listed in the table.

32
docs/webapp/webapp_model_table.md
View File

@@ -1,33 +1,33 @@
---
title: The Models Table
title: The Model table
---
The models table is a [customizable](#customizing-the-models-table) list of models associated with the tasks in a project. From the models table,
The model table is a [customizable](#customizing-the-models-table) list of models associated with the tasks in a project. From the model table,
view model details, and modify, publish, archive, tag, and move models to other projects.
View the models table in table view <img src="/docs/latest/icons/ico-table-view.svg" alt="Table view" className="icon size-md space-sm" />
View the model table in table view <img src="/docs/latest/icons/ico-table-view.svg" alt="Table view" className="icon size-md space-sm" />
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.
You can archive models so the models table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
You can archive models so the model table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
table to open the archive and view all archived models. From the archive, you can restore
models to remove them from the archive, and permanently delete models.
You can download the models table as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />
You can download the model table as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />
and choosing one of these options:
* **Download onscreen items** - Download the values for models currently visible on screen
* **Download all items** - Download the values for all models in this project that match the current active filters
The downloaded data consists of the currently displayed table columns.
![Models table](../img/webapp_models_01.png#light-mode-only)
![Models table](../img/webapp_models_01_dark.png#dark-mode-only)
![Model table](../img/webapp_models_01.png#light-mode-only)
![Model table](../img/webapp_models_01_dark.png#dark-mode-only)
## Models Table Columns
## Model Table Columns
The models table contains the following columns:
The model table contains the following columns:
| Column | Description | Type |
|---|---|---|
@@ -44,9 +44,9 @@ The models table contains the following columns:
| *Metadata* | User defined metadata key column. Available options depend upon the models in the table. | String |
## Customizing the Models Table
## Customizing the Model table
The models table is customizable. Changes are persistent (cached in the browser) and represented in the URL, so customized settings
The model table is customizable. Changes are persistent (cached in the browser) and represented in the URL, so customized settings
can be saved in a browser bookmark and shared with other ClearML users to collaborate.
Customize the table using any of the following:
@@ -77,18 +77,18 @@ all the models in the project. The customizations of these two views are saved s
## Model Actions
The following table describes the actions that can be done from the models table, including the states that
The following table describes the actions that can be done from the model table, including the states that
allow each feature. Model states are *Draft* (editable) and *Published* (read-only).
Access these actions 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" /> to
* In the model 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" /> to
open the context menu
* 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" />
* Through the batch action bar, available at screen bottom when multiple models are selected
| 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 model table | Any state |
| Publish | Publish a model to prevent changes to it. *Published* models are read-only. If a model is Published, its task also becomes Published (read-only). | *Draft* |
| Archive | Move model to the project's archive. | Any state |
| Restore | Action available in the archive. Restore a model to the main model table. | Any state |
@@ -109,8 +109,8 @@ Select multiple models, then use either the context menu, or the bar that appear
operations on the selected models. The context menu shows the number of models that can be affected by each action.
The same information can be found in the bottom menu, in a tooltip that appears when hovering over an action icon.
![Models table batch operations](../img/webapp_models_table_batch_operations.png#light-mode-only)
![Models table batch operations](../img/webapp_models_table_batch_operations_dark.png#dark-mode-only)
![Model table batch operations](../img/webapp_models_table_batch_operations.png#light-mode-only)
![Model table batch operations](../img/webapp_models_table_batch_operations_dark.png#dark-mode-only)
## Tagging Models

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 model 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_overview.md
View File

@@ -64,7 +64,7 @@ Search results are returned for the different ClearML objects:
* Tasks - Searching a task table looks for matches in the tasks' name, ID, description and input and
output models. The enterprise version also includes task 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,
* Dataviews (Enterprise only) - Searching a Dataview 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.

4
docs/webapp/webapp_reports.md
View File

@@ -307,8 +307,8 @@ MarkDown code for a table looks like this:
The rendered output should look like this:
![Reports table](../img/reports_table.png#light-mode-only)
![Reports table](../img/reports_table_dark.png#dark-mode-only)
![Report table](../img/reports_table.png#light-mode-only)
![Report table](../img/reports_table_dark.png#dark-mode-only)
Add the table column names in the first row; each name is preceded and followed by a pipe (`|`).
In the second row, add sets of at least three hyphens (`---`) for each column, and add a pipe before and after each set