ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-29 09:39:23 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Small edits
Some checks are pending
CI / build (push) Waiting to run
Details

Browse Source
This commit is contained in:
Noam Wasersprung 2025-05-04 12:59:54 +03:00 committed by GitHub
commit 3741b2c8f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/clearml_agent.md
View File

@ -53,8 +53,8 @@ automated workflows in one (or both) of the following ways:
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:
code modification. When you modify a cloned task’s configuration, the ClearML agent will override the original values
during execution:
* Modified package requirements will have the task 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

8
docs/clearml_sdk/task_sdk.md
View File

@ -47,7 +47,7 @@ If multiple tasks need to be created in the same process (for example, for loggi
make sure to close a task, before initializing a new one. To close a task simply call [`Task.close()`](../references/sdk/task.md#close)
(see example [here](../guides/advanced/multiple_tasks_single_process.md)).
When initializing a task, its project needs to be specified. If the project entered does not exist, it will be created on-the-fly.
When initializing a task, its project needs to be specified. If the project entered does not exist, it is created on-the-fly.
Projects can be divided into subprojects, just like folders are broken into subfolders.
For example:
@ -166,8 +166,8 @@ auto_connect_arg_parser={}
```
### Task Reuse
Every `Task.init` call will create a new task for the current execution.
To mitigate the clutter that a multitude of debugging tasks might create, a task will be reused if:
Every `Task.init` call creates a new task for the current execution.
To mitigate the clutter that a multitude of debugging tasks might create, a task is reused if:
* The last time it was executed (on this machine) was under 24 hours ago (configurable, see
[`sdk.development.task_reuse_time_window_in_hours`](../configs/clearml_conf.md#task_reuse) in
the ClearML configuration reference)
@ -486,7 +486,7 @@ a_func_task = task.create_function_task(
some_argument=123
)
```
Arguments passed to the function will be automatically logged in the
Arguments passed to the function are automatically logged in the
task's **CONFIGURATION** tab under the **HYPERPARAMETERS > Function** section.
Like any other arguments, they can be changed from the UI or programmatically.

2
docs/guides/frameworks/xgboost/xgboost_metrics.md
View File

@ -25,7 +25,7 @@ View saved snapshots in the task's **ARTIFACTS** tab.
![Artifacts tab](../../../img/examples_xgboost_metric_artifacts.png#light-mode-only)
![Artifacts tab](../../../img/examples_xgboost_metric_artifacts_dark.png#dark-mode-only)
To view the model details, click the model name in the **ARTIFACTS** page, which will open the model's info tab. Alternatively, download the model.
To view the model details, click the model name in the **ARTIFACTS** page to open its info tab. Alternatively, download the model.
![Model info panel](../../../img/examples_xgboost_metric_model.png#light-mode-only)
![Model info panel](../../../img/examples_xgboost_metric_model_dark.png#dark-mode-only)

2
docs/integrations/click.md
View File

@ -46,7 +46,7 @@ When this code is executed, ClearML logs your command-line arguments, which you
![click configuration](../img/integrations_click_configs_dark.png#dark-mode-only)
In the UI, you can clone the task multiple times and set the clones' parameter values for execution by the [ClearML Agent](../clearml_agent.md).
When the clone is executed, the executing agent will use the new parameter values as if set by the command-line.
When the task clone is executed, the executing agent uses the new parameter values as if set by the command-line.
See [code examples](https://github.com/clearml/clearml/blob/master/examples/frameworks/click) demonstrating integrating
ClearML with code that uses `click`.

4
docs/webapp/webapp_orchestration_dash.md
View File

@ -29,7 +29,7 @@ The top of the dashboard displays the current resource availability and utilizat
picture of the resources available and in use. The **Total** section displays available and idle resource counts.
These counts are also available per worker category.
The **Totals** section displays:
The **Total** section displays:
* GPUs - The total number of GPUs in currently running workers out of the total number of GPUs in all provisioned workers, and the number of idle GPUs. GPUs are considered idle when their average
utilization falls below 80%.
* CPUs - The total number of CPUs in currently running workers out of the total number of CPUs in all provisioned workers, and the number of idle CPUs. CPUs are considered idle when their average
@ -99,7 +99,7 @@ The threshold values applied to the dashboard table affect all workspace users w
</div>
Clicking on a resource group opens the group's info panel and replace the **Overview** graph with that resource's usage
Clicking on a resource group opens the group's info panel and replaces the **Overview** graph with that resource's usage
history.
![Resource group info panel](../img/webapp_orch_dash_resource_group_info.png#light-mode-only)

4
docs/webapp/webapp_workers_queues.md
View File

@ -58,7 +58,7 @@ 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
Clicking on a worker opens the worker's details panel and replaces 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
@ -66,7 +66,7 @@ information. The resource metric being monitored can be selected through the men
* Network Usage.
The worker's details panel includes the following two tabs:
* **INFO** - worker information:
* **INFO** - Worker information:
* Worker Name
* Update time - The last time the worker reported data
* Current Task - The task currently being executed by the worker