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

Browse Source
This commit is contained in:
pollfly
2023-10-09 15:48:19 +03:00
committed by GitHub
parent 5dad105950
commit 3a4b10e43b
31 changed files with 95 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/webapp/applications/apps_aws_autoscaler.md
View File

@@ -35,7 +35,7 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
* Git Password / Personal Access Token
* **Max Idle Time** (optional) - Maximum time in minutes that an EC2 instance can be idle before the autoscaler spins it
down
* **Workers Prefix** (optional) - A Prefix added to workers’ names, associating them with this autoscaler
* **Workers Prefix** (optional) - A Prefix added to workers' names, associating them with this autoscaler
* **Polling Interval** (optional) - Time period in minutes at which the designated queue is polled for new tasks
* **Base Docker Image** (optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored
in a Docker artifactory so instances can automatically fetch it
@@ -106,22 +106,22 @@ The autoscaler dashboard shows:
* Queues and the resource type associated with them
* Number of current running instances
* Console: the application log containing everything printed to stdout and stderr appears in the console log. The log
shows polling results of the autoscaler’s associated queues, including the number of tasks enqueued, and updates EC2
shows polling results of the autoscaler's associated queues, including the number of tasks enqueued, and updates EC2
instances being spun up/down.
:::tip Console Debugging
To make the autoscaler console log show additional debug information, change an active app instance’s log level to DEBUG:
1. Go to the app instance task’s page > **CONFIGURATION** tab > **USER PROPERTIES** section
To make the autoscaler console log show additional debug information, change an active app instance's log level to DEBUG:
1. Go to the app instance task's page > **CONFIGURATION** tab > **USER PROPERTIES** section
1. Hover over the section > Click `Edit` > Click `+ADD PARAMETER`
1. Input `log_level` as the key and `DEBUG` as the value of the new parameter.
![Autoscaler debugging](../../img/webapp_autoscaler_debug_log.png)
The console’s log level will update in the autoscaler's next iteration.
The console's log level will update in the autoscaler's next iteration.
:::
* Instance log files - Click to access the app instance's logs. This takes you to the app instance task's ARTIFACTS tab,
which lists the app instance’s logs. In a log’s `File Path` field, click <img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-sm space-sm" />
which lists the app instance's logs. In a log's `File Path` field, click <img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-sm space-sm" />
to download the complete log.

12
docs/webapp/applications/apps_gcp_autoscaler.md
View File

@@ -48,7 +48,7 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
* \+ Add Item - Define another resource type
* **Autoscaler Instance Name** (optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Max Idle Time** (optional) - Maximum time in minutes that a VM instance can be idle before the autoscaler spins it down
* **Workers Prefix** (optional) - A Prefix added to workers’ names, associating them with this autoscaler
* **Workers Prefix** (optional) - A Prefix added to workers' names, associating them with this autoscaler
* **Polling Interval** (optional) - Time period in minutes at which the designated queue is polled for new tasks
* **Apply Task Owner Vault Configuration** - Select to apply values from the task owner's [ClearML vault](../webapp_profile.md#configuration-vault) when executing the task
* **Warn if more than one instance is executing the same task** - Select to print warning to console when multiple
@@ -91,22 +91,22 @@ The autoscaler dashboard shows:
* Queues and the resource type associated with them
* Number of current running instances
* Console: the application log containing everything printed to stdout and stderr appears in the console log. The log
shows polling results of the autoscaler’s associated queues, including the number of tasks enqueued, and updates VM
shows polling results of the autoscaler's associated queues, including the number of tasks enqueued, and updates VM
instances being spun up/down
:::tip Console Debugging
To make the autoscaler console log show additional debug information, change an active app instance’s log level to DEBUG:
1. Go to the app instance task’s page > **CONFIGURATION** tab > **USER PROPERTIES** section
To make the autoscaler console log show additional debug information, change an active app instance's log level to DEBUG:
1. Go to the app instance task's page > **CONFIGURATION** tab > **USER PROPERTIES** section
1. Hover over the section > Click `Edit` > Click `+ADD PARAMETER`
1. Input `log_level` as the key and `DEBUG` as the value of the new parameter.
![Autoscaler debugging](../../img/webapp_autoscaler_debug_log.png)
The console’s log level will update in the autoscaler's next iteration.
The console's log level will update in the autoscaler's next iteration.
:::
* Instance log files - Click to access the app instance's logs. This takes you to the app instance task's ARTIFACTS tab,
which lists the app instance’s logs. In a log’s `File Path` field, click <img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-sm space-sm" />
which lists the app instance's logs. In a log's `File Path` field, click <img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-sm space-sm" />
to download the complete log.
:::tip EMBEDDING CLEARML VISUALIZATION

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

@@ -21,7 +21,7 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
* **Machine Specification**
* GPU Type - NVIDIA GPU on the machine
* Number of GPUs - Number of GPUs in the cloud machine
* The rest of the machine’s available resources are dependent on the number and type of GPUs specified above:
* The rest of the machine's available resources are dependent on the number and type of GPUs specified above:
* vCPUs - Number of vCPUs in the cloud machine
* Memory - RAM available to the cloud machine
* Hourly Price - Machine's hourly rate
@@ -65,14 +65,14 @@ The GPU Compute dashboard shows:
* Console - The log shows updates of cloud instances being spun up/down.
:::tip Console Debugging
To make the autoscaler console log show additional debug information, change an active app instance’s log level to DEBUG:
1. Go to the app instance task’s page > **CONFIGURATION** tab > **USER PROPERTIES** section
To make the autoscaler console log show additional debug information, change an active app instance's log level to DEBUG:
1. Go to the app instance task's page > **CONFIGURATION** tab > **USER PROPERTIES** section
1. Hover over the section > Click `Edit` > Click `+ADD PARAMETER`
1. Input `log_level` as the key and `DEBUG` as the value of the new parameter.
![Autoscaler debugging](../../img/webapp_autoscaler_debug_log.png)
The console’s log level will update in the autoscaler's next iteration.
The console's log level will update in the autoscaler's next iteration.
:::
:::tip EMBEDDING CLEARML VISUALIZATION

6
docs/webapp/applications/apps_hpo.md
View File

@@ -25,8 +25,8 @@ limits.
sample a different set of hyperparameters values
* **Optimization Configuration**
* Optimization Method - The optimization strategy to employ (e.g. random, grid, hyperband)
* Optimization Objective Metric’s Title - Title of metric to optimize
* Optimization Objective Metric’s Series - Metric series (variant) to optimize
* Optimization Objective Metric's Title - Title of metric to optimize
* Optimization Objective Metric's Series - Metric series (variant) to optimize
* Optimization Objective Trend - Choose the optimization target, whether to maximize or minimize the value of the
metric specified above
* **Execution Queue** - The [ClearML Queue](../../fundamentals/agents_and_queues.md#what-is-a-queue) to which
@@ -39,7 +39,7 @@ limits.
* Step Size - Step size between samples
* Discrete Parameters - A set of values to sample
* Values - Comma separated list of values to sample
* Name - The original task’s configuration parameter name (including section name e.g. `Args/lr`) <br/>
* Name - The original task's configuration parameter name (including section name e.g. `Args/lr`) <br/>
:::tip Hydra Parameters
For experiments using Hydra, input parameters from the OmegaConf in the following format:
`Hydra/<param>`. Specify `<param>` using dot notation. For example, if your OmegaConf looks like this:

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

@@ -54,7 +54,7 @@ Access app instance actions, by right-clicking an instance, or through the menu
![App context menu](../../img/app_context_menu.png)
* **Rename** - Rename the instance
* **Configuration** - View an instance’s configuration
* **Configuration** - View an instance's configuration
* **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
* **Stop** - Shutdown the instance

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

@@ -52,7 +52,7 @@ The app monitors your workspace for trigger events and will launch copies of the
## Dashboard
The Trigger Manager app instance's dashboard displays its console log. The log shows the instance’s activity: periodic
The Trigger Manager app instance's dashboard displays its console log. The log shows the instance's activity: periodic
polling, and events triggered
![Trigger dashboard](../../img/apps_trigger_manager_dashboard.png)

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

@@ -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 |
@@ -91,9 +91,9 @@ The following table customizations are saved on a per-pipeline basis:
## Create Run
To launch a new run for a pipeline, click **+ NEW RUN** on the top left of the page. This opens a **NEW RUN** modal, where
you can set the run’s parameters. By default, the fields are pre-filled with the last run’s values.
you can set the run's parameters. By default, the fields are pre-filled with the last run's values.
Click **Advanced configurations** to change the run’s execution queue.
Click **Advanced configurations** to change the run's execution queue.
![New run modal](../../img/webapp_pipeline_new_run.png)

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

@@ -17,7 +17,7 @@ Each step shows:
* 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)
While the pipeline is running, the steps’ details and colors are updated.
While the pipeline is running, the steps' details and colors are updated.
## Run and Step Details
### Run and Step Info
@@ -30,24 +30,24 @@ On the right side of the pipeline run panel, view the **RUN INFO** which shows:
![Run info](../../img/webapp_pipeline_run_info.png)
To view a run’s complete information, click **Full details**, which will open the pipeline’s controller [task page](../webapp_exp_track_visual.md).
View each list’s complete details in the pipeline task’s corresponding tabs:
To view a run's complete information, click **Full details**, which will open the pipeline's controller [task page](../webapp_exp_track_visual.md).
View each list's complete details in the pipeline task's corresponding tabs:
* **PARAMETERS** list > **CONFIGURATION** tab
* **METRICS** list > **SCALARS** tab
* **ARTIFACTS** and **MODELS** lists > **ARTIFACTS** tab
![Pipeline task info](../../img/webapp_pipeline_task_info.png)
To view a specific step’s information, click the step on the execution graph, and the info panel displays its **STEP INFO**.
The panel displays the step’s name, task type, and status, as well as its parameters, metrics, artifacts, and models.
To view a specific step's information, click the step on the execution graph, and the info panel displays its **STEP INFO**.
The panel displays the step's name, task type, and status, as well as its parameters, metrics, artifacts, and models.
![Step info](../../img/webapp_pipeline_step_info.png)
To return to viewing the run’s information, click the pipeline graph, outside any of the steps.
To return to viewing the run's information, click the pipeline graph, outside any of the steps.
### Run and Step Details Panel
Click on **DETAILS** on the top left of the info panel to view the pipeline controller's details panel. To view a step’s
Click on **DETAILS** on the top left of the info panel to view the pipeline controller's details panel. To view a step's
details panel, click **DETAILS** and then click on a step node, or hover over a step node and click <img src="/docs/latest/icons/ico-console.svg" alt="details" className="icon size-md space-sm" />.
The details panel includes three tabs:
@@ -61,7 +61,7 @@ The details panel includes three tabs:
* **Code** - For pipeline steps generated from functions using either [`PipelineController.add_function_step`](../../references/sdk/automation_controller_pipelinecontroller.md#add_function_step)
or [`PipelineDecorator.component`](../../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorcomponent),
you can view the selected step’s code.
you can view the selected step's code.
![code](../../img/webapp_pipeline_step_code.png)

2
docs/webapp/webapp_exp_comparing.md
View File

@@ -198,7 +198,7 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
<img src="/docs/latest/icons/ico-circle-newer.svg" alt="Right arrow" className="icon size-md space-sm" /> (new images), or <img src="/docs/latest/icons/ico-circle-newest.svg" alt="right arrow, newest image" className="icon size-md space-sm" /> (newest images).
* Click <img src="/docs/latest/icons/ico-disconnect.svg" alt="Sync selection" className="icon size-md space-sm" /> in
order to synchronize iteration and metric selection across experiments. For example, if you select a metric for
one experiment’s debug samples, the same metric will be automatically selected for the rest of the experiments in the comparison.
one experiment's debug samples, the same metric will be automatically selected for the rest of the experiments in the comparison.
![image](../img/webapp_compare_30.png)

2
docs/webapp/webapp_exp_table.md
View File

@@ -9,7 +9,7 @@ to monitor experimentation, and more). The experiments table's auto-refresh allo
View the experiments 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 experiments according
to columns of interest. Use the details view to access a selected experiment’s details, while keeping the experiment list
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.
You can archive experiments so the experiments table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the

4
docs/webapp/webapp_model_comparing.md
View File

@@ -43,7 +43,7 @@ The comparison tabs provides the following views:
In the **Details**, **Network**, and **Scalars** (Values mode) tabs, you can view differences in the models' nominal
values. **Details** displays the models' general information, labels, and metadata. **Network** displays the models'
configuration. **Scalars** (in Values mode) displays the models’ scalar values (min, max, or last). Each model's
configuration. **Scalars** (in Values mode) displays the models' scalar values (min, max, or last). Each model's
information is displayed in a column, so each field is lined up side-by-side.
The model on the left is used as the base model, to which the other models are compared. You can set a new base model
@@ -67,7 +67,7 @@ models are combined.
![Merged plots](../img/webapp_compare_models_merge_plots.png)
The rest of the plots which can’t be merged are displayed separately for each model.
The rest of the plots which can't be merged are displayed separately for each model.
![Side-by-side plots](../img/webapp_compare_models_side_plots.png)

2
docs/webapp/webapp_model_table.md
View File

@@ -8,7 +8,7 @@ view model details, and modify, publish, archive, tag, and move models to other
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" />
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.
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

4
docs/webapp/webapp_profile.md
View File

@@ -123,7 +123,7 @@ pending invitations are displayed.
### Leaving a Workspace
You can leave any workspace you’ve previously joined (except your personal workspace).
You can leave any workspace you've previously joined (except your personal workspace).
When leaving a workspace, you lose access to its resources (tasks, models, etc.) and your previously created access
credentials to that workspace are revoked. Tasks and associated artifacts that you logged to that workspace will remain
@@ -223,7 +223,7 @@ To remove a user from a workspace:
1. Hover over the user's row on the table
1. Click the <img src="/docs/latest/icons/ico-trash.svg" alt="Trash can" className="icon size-md" /> button
Removed users lose access to your workspace’s resources (tasks, models, etc.) and their existing access credentials are
Removed users lose access to your workspace's resources (tasks, models, etc.) and their existing access credentials are
revoked. Tasks and associated artifacts logged to your workspace by a removed user will remain in your workspace. The
user can only rejoin your workspace when you re-invite them.

4
docs/webapp/webapp_projects_page.md
View File

@@ -6,12 +6,12 @@ Use the Projects Page for project navigation and management.
Your projects are displayed like folders: click a folder to access its contents. The Projects Page shows the top-level
projects in your workspace. Projects that contain nested subprojects are identified by an extra nested project tab.
An exception is the **All Experiments** folder, which shows all projects’ and subprojects’ contents in a single, flat
An exception is the **All Experiments** folder, which shows all projects' and subprojects' contents in a single, flat
list.
![Projects page](../img/webapp_project_page.png)
If a project has any subprojects, clicking its folder will open its own project page. Access the projects’ top-level
If a project has any subprojects, clicking its folder will open its own project page. Access the projects' top-level
contents (i.e. experiments, models etc.) via the folder with the bracketed (`[ ]`) project name.
If a project does not contain any subprojects, clicking on its folder will open its experiment table (or [Project Overview](webapp_project_overview.md)

6
docs/webapp/webapp_reports.md
View File

@@ -14,7 +14,7 @@ title: Reports
<br/>
With ClearML’s Reports you can write up notes, experiment findings, or really anything you want. You can create reports
With ClearML's Reports you can write up notes, experiment findings, or really anything you want. You can create reports
in any of your ClearML projects.
In addition to its main document, a report also contains a description field, which will appear in the report's card in
@@ -76,7 +76,7 @@ A standard embed code is formatted like this:
```
The `src` parameter is made up of the following components:
* Your web server’s URL (e.g. `app.clear.ml`)
* Your web server's URL (e.g. `app.clear.ml`)
* `/widget/` - The endpoint that serves the embedded data.
* The query parameters for your visualization (the path and query are separated by a question mark `?`)
@@ -105,7 +105,7 @@ resources will be displayed. See [Dynamic Queries](#dynamic-queries) below.
* `timestamp` - Time from start
* `iso_time` - Wall time
* `metrics` - Metric name
* `variants` - Variant’s name
* `variants` - Variant's name
* `company` - Workspace ID. Applicable to the ClearML hosted service, for embedding content from a different workspace
* `light` - add parameter to switch visualization to light theme

18
docs/webapp/webapp_workers_queues.md
View File

@@ -58,14 +58,14 @@ The worker table shows the currently available workers and their current executi
* Training iteration.
Clicking on a worker will open the worker’s details panel and replace the graph with that worker’s resource utilization
information. The resource metric being monitored can be selected through the menu at the graph’s top left corner:
Clicking on a worker will open the worker's details panel and replace the graph with that worker's resource utilization
information. The resource metric being monitored can be selected through the menu at the graph's top left corner:
* CPU and GPU Usage
* Memory Usage
* Video Memory Usage
* Network Usage.
The worker’s details panel includes the following two tabs:
The worker's details panel includes the following two tabs:
* **INFO** - worker information:
* Worker Name
* Update time - The last time the worker reported data
@@ -97,7 +97,7 @@ The queue table shows the following queue information:
To create a new queue - Click **+ NEW QUEUE** (top left).
Hover over a queue and click <img src="/docs/latest/icons/ico-copy-to-clipboard.svg" alt="Copy" className="icon size-md space-sm" />
to copy the queue’s ID.
to copy the queue's ID.
![image](../img/4100.png)
@@ -107,24 +107,24 @@ to access queue actions:
![Queue context menu](../img/webapp_workers_queues_context.png)
* Delete - Delete the queue. Any pending tasks will be dequeued.
* Rename - Change the queue’s name
* Rename - Change the queue's name
* Clear - Remove all pending tasks from the queue
* Custom action - The ClearML Enterprise Server provides a mechanism to define your own custom actions, which will
appear in the context menu. See [Custom UI Context Menu Actions](../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions)
Clicking on a queue will open the queue’s details panel and replace the graphs with that queue’s statistics.
Clicking on a queue will open the queue's details panel and replace the graphs with that queue's statistics.
The queue’s details panel includes the following two tabs:
The queue's details panel includes the following two tabs:
* **EXPERIMENTS** - A list of experiments in the queue. You can reorder and remove enqueued experiments. See
[Controlling Queue Contents](#controlling-queue-contents).
* **WORKERS** - Information about the workers assigned to the queue:
* Name - Worker name
* IP - Worker’s IP
* IP - Worker's IP
* Currently Executing - The experiment currently being executed by the worker
### Controlling Queue Contents
Click on an experiment’s menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
Click on an experiment's menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
in the **EXPERIMENTS** tab to reorganize your queue:
![Queue experiment's menu](../img/workers_queues_experiment_actions.png)