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

Browse Source
This commit is contained in:
pollfly
2023-10-01 10:31:48 +03:00
committed by GitHub
parent 6b02f02b0d
commit 83fa8adcd5
40 changed files with 127 additions and 127 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/webapp/applications/apps_dashboard.md
View File

@@ -6,7 +6,7 @@ title: Project Dashboard
The ClearML Project Dashboard App is available under the ClearML Pro plan
:::
The Project Dashboard Application provides an overview of a project or workspace’s progress. It presents an aggregated
The Project Dashboard Application provides an overview of a project or workspace's progress. It presents an aggregated
view of task status and a chosen metric over time, as well as project GPU and worker usage. It also supports alerts/warnings
on completed/failed Tasks via Slack integration.
@@ -15,7 +15,7 @@ on completed/failed Tasks via Slack integration.
values from the file, which can be modified before launching the app instance
* **Dashboard Title** - Name of the project dashboard instance, which will appear in the instance list
* **Monitoring** - Select what the app instance should monitor. The options are:
* Project - Monitor a specific project. You can select an option to also monitor the specified project’s subprojects
* Project - Monitor a specific project. You can select an option to also monitor the specified project's subprojects
* Entire workspace - Monitor all projects in your workspace
:::caution
@@ -34,7 +34,7 @@ of the chosen metric over time.
* Alert Iteration Threshold - Minimum number of task iterations to trigger Slack alerts (tasks that fail prior to the threshold will be ignored)
* **Additional options**
* Track manual (non agent-run) experiments as well - Select to include in the dashboard experiments that were not executed by an agent
* Alert on completed experiments - Select to include completed tasks in alerts: in the dashboard’s Task Alerts section and in Slack Alerts.
* Alert on completed experiments - Select to include completed tasks in alerts: in the dashboard's Task Alerts section and in Slack Alerts.
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration.
@@ -48,7 +48,7 @@ Once a project dashboard instance is launched, its dashboard displays the follow
* Experiments Summary - Number of tasks by status over time
* Monitoring - GPU utilization and GPU memory usage
* Metric Monitoring - An aggregated view of the values of a metric over time
* Project’s Active Workers - Number of workers currently executing experiments in the monitored project
* Project's Active Workers - Number of workers currently executing experiments in the monitored project
* Workers Table - List of active workers
* Task Alerts
* Failed tasks - Failed experiments and their time of failure summary

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

@@ -6,7 +6,7 @@ title: Overview
ClearML Applications are available under the ClearML Pro plan
:::
Use ClearML’s GUI Applications to manage ML workloads and automatically run your recurring workflows without any coding.
Use ClearML's GUI Applications to manage ML workloads and automatically run your recurring workflows without any coding.
![Apps page](../../img/apps_overview_page.png)
@@ -18,23 +18,23 @@ ClearML provides the following applications:
* [**AWS Autoscaler**](apps_aws_autoscaler.md) - Optimize AWS EC2 instance usage according to a defined instance budget
* [**GCP Autoscaler**](apps_gcp_autoscaler.md) - Optimize GCP instance usage according to a defined instance budget
* [**Hyperparameter Optimization**](apps_hpo.md) - Find the parameter values that yield the best performing models
* **Nvidia Clara** - Train models using Nvidia’s Clara framework
* **Nvidia Clara** - Train models using Nvidia's Clara framework
* [**Project Dashboard**](apps_dashboard.md) - High-level project monitoring with Slack alerts
* [**Task Scheduler**](apps_task_scheduler.md) - Schedule tasks for one-shot and/or periodic execution at specified times (available under ClearML Enterprise Plan)
* [**Trigger Manager**](apps_trigger_manager) - Define tasks to be run when predefined events occur (available under ClearML Enterprise Plan)
## App Pages Layout
Each application’s page is split into two sections:
Each application's page is split into two sections:
* App Instance List - Launch new app instances and view previously launched instances. Click on an instance to view its
dashboard. Hover over it to access the [app instance actions](#app-instance-actions).
* App Instance Dashboard - The main section of the app page: displays the selected app instance’s status and results.
* App Instance Dashboard - The main section of the app page: displays the selected app instance's status and results.
![App format](../../img/apps_format_overview.png)
## Launching an App Instance
1. Choose the desired app
1. Click the `Launch New` button <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to open the app’s configuration wizard
1. Click the `Launch New` button <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> to open the app's configuration wizard
1. Fill in the configuration details
1. **Launch**

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

@@ -18,7 +18,7 @@ top-level projects are displayed. Click on a project card to view the project's
Click on a dataset card to navigate to its [Version List](webapp_dataset_viewing.md), where you can view the
dataset versions' lineage and contents.
Filter the datasets to find the one you’re looking for more easily. These filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />:
Filter the datasets to find the one you're looking for more easily. These filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />:
* My Work - Show only datasets that you created
* Tags - Choose which tags to filter by from a list of tags used in the datasets.
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR"
@@ -29,7 +29,7 @@ Filter the datasets to find the one you’re looking for more easily. These filt
## Project Cards
In Project view, project cards display a project’s summarized dataset information:
In Project view, project cards display a project's summarized dataset information:
<div class="max-w-50">
@@ -74,7 +74,7 @@ of a dataset card to open its context menu and access dataset actions.
</div>
* **Rename** - Change the dataset’s name
* **Rename** - Change the dataset's name
* **Add Tag** - Add label to the dataset to help easily classify groups of dataset.
* **Delete** - Delete the dataset and all of its versions. To delete a dataset, all its versions must first be
archived.

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

@@ -24,7 +24,7 @@ Each node in the graph represents a dataset version, and shows the following det
* Version size
* Version update time
* Version details button - Hover over the version and click <img src="/docs/latest/icons/ico-console.svg" alt="console" className="icon size-md space-sm" />
to view the version’s [details panel](#version-details-panel)
to view the version's [details panel](#version-details-panel)
:::tip archiving versions
You can archive dataset versions so the versions list doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of
@@ -65,7 +65,7 @@ On the right side of the dataset version panel, view the **VERSION INFO** which
</div>
To view a version’s detailed information, click **Full details**, which will open the dataset version’s [task page](../webapp_exp_track_visual.md).
To view a version's detailed information, click **Full details**, which will open the dataset version's [task page](../webapp_exp_track_visual.md).
![Dataset task info](../../img/webapp_dataset_task_page.png)
@@ -84,7 +84,7 @@ to view the version's details panel. The panel includes three tabs:
![preview](../../img/webapp_dataset_preview.png)
* **CONSOLE** - The dataset version’s console output
* **CONSOLE** - The dataset version's console output
![console](../../img/webapp_dataset_console.png)

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

@@ -11,9 +11,9 @@ view, all pipelines are shown side-by-side. In Project view, pipelines are organ
top-level projects are displayed. Click on a project card to view the project's pipelines.
Click on a pipeline card to navigate to its [Pipeline Runs Table](webapp_pipeline_table.md), where you can view the
pipeline structure, configuration, and outputs of all the pipeline’s runs, as well as create new runs.
pipeline structure, configuration, and outputs of all the pipeline's runs, as well as create new runs.
Filter the pipelines to find the one you’re looking for more easily. These filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />:
Filter the pipelines to find the one you're looking for more easily. These filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />:
* My Work - Show only pipelines that you created
* Tags - Choose which tags to filter by from a list of tags used in the pipelines.
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR"
@@ -46,7 +46,7 @@ In List view, the pipeline cards display summarized pipeline information:
</div>
* Pipeline name
* Time since the pipeline’s most recent run
* Time since the pipeline's most recent run
* Run summary - Number of *Running*/*Pending*/*Completed*/*Failed* runs
* Tags
@@ -62,7 +62,7 @@ of a pipeline card to open its context menu and access pipeline actions.
</div>
* **Rename** - Change the pipeline’s name
* **Rename** - Change the pipeline's name
* **Add Tag** - Add label to the pipeline to help easily classify groups of pipelines.
* **Delete** - Delete the pipeline: delete all its runs and any models/artifacts produced (a list of remaining artifacts
is returned). To delete a pipeline, all its runs must first be archived.

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

@@ -2,14 +2,14 @@
title: The Pipeline Runs Table
---
The pipeline runs table is a [customizable](#customizing-the-runs-table) list of the pipeline’s runs. Use it to
view a run’s details, and manage runs (create, continue, or abort). The runs table's auto-refresh allows users
The pipeline runs table is a [customizable](#customizing-the-runs-table) list of the pipeline's runs. Use it to
view a run's details, and manage runs (create, continue, or abort). The runs table's auto-refresh allows users
to continually monitor run progress.
View the runs 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 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.
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.
You can archive pipeline runs so the runs table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
@@ -32,7 +32,7 @@ The models table contains the following columns:
| Column | Description | Type |
|---|---|---|
| **RUN** | Pipeline run identifier | String |
| **VERSION** | The pipeline version number. Corresponds to the [PipelineController](../../references/sdk/automation_controller_pipelinecontroller.md#class-pipelinecontroller)’s and [PipelineDecorator](../../references/sdk/automation_controller_pipelinecontroller.md#class-automationcontrollerpipelinedecorator)’s `version` parameter | Version string |
| **VERSION** | The pipeline version number. Corresponds to the [PipelineController](../../references/sdk/automation_controller_pipelinecontroller.md#class-pipelinecontroller)'s and [PipelineDecorator](../../references/sdk/automation_controller_pipelinecontroller.md#class-automationcontrollerpipelinedecorator)’s `version` parameter | Version string |
| **TAGS** | Descriptive, user-defined, color-coded tags assigned to run. | Tag |
| **STATUS** | Pipeline run's status. See a list of the [task states and state transitions](../../fundamentals/task.md#task-states). For Running, Failed, and Aborted runs, you will also see a progress indicator next to the status. See [here](../../pipelines/pipelines.md#tracking-pipeline-progress). | String |
| **USER** | User who created the run. | String |

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

@@ -2,7 +2,7 @@
title: Pipeline Run Details
---
The run details panel shows the pipeline’s structure and the execution status of every step, as well as the run’s
The run details panel shows the pipeline's structure and the execution status of every step, as well as the run's
configuration parameters and output.
![Pipeline structure](../../img/webapp_pipeline_DAG.png)
@@ -15,7 +15,7 @@ Each step shows:
* Step status
* Step execution time
* Step log button - Hover over the step and click <img src="/docs/latest/icons/ico-console.svg" alt="console" className="icon size-md space-sm" />
to view the step’s [details panel](#run-and-step-details-panel)
to view the step's [details panel](#run-and-step-details-panel)
While the pipeline is running, the steps’ details and colors are updated.