From 756f9b2361f25d66d25d647b97e61d8bac45fbf8 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 4 May 2023 10:52:09 +0300 Subject: [PATCH] Small edits (#550) --- docs/fundamentals/agents_and_queues.md | 2 +- docs/fundamentals/hyperparameters.md | 2 +- docs/getting_started/ds/best_practices.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/fundamentals/agents_and_queues.md b/docs/fundamentals/agents_and_queues.md index 39e5a8f3..0898bce9 100644 --- a/docs/fundamentals/agents_and_queues.md +++ b/docs/fundamentals/agents_and_queues.md @@ -99,7 +99,7 @@ In its default mode, a ClearML Agent executes a single task at a time, since tra available to them. Some tasks are mostly idling and require less computation power, such as controller tasks (e.g. a pipeline controller) or service tasks (e.g. cleanup service). -This is where the `services-modes` comes into play. An agent running in `services-mode` will let multiple tasks execute +This is where the `services-mode` comes into play. An agent running in `services-mode` will let multiple tasks execute in parallel (each task will register itself as a sub-agent, visible in the [Workers & Queues](../webapp/webapp_workers_queues.md) tab in the UI). This mode is intended for running maintenance tasks. Some suitable tasks include: diff --git a/docs/fundamentals/hyperparameters.md b/docs/fundamentals/hyperparameters.md index c499f69f..d70b52b8 100644 --- a/docs/fundamentals/hyperparameters.md +++ b/docs/fundamentals/hyperparameters.md @@ -86,7 +86,7 @@ method. The `set_parameters_as_dict` method updates parameters while the `set_pa ClearML does not automatically track changes to explicitly set parameters. ### User Properties -User properties do not impact tasks execution and can be modified at any stage. They are convenient for setting +User properties do not impact task execution and can be modified at any stage. They are convenient for setting helpful values which are displayed in the [experiment table](../webapp/webapp_exp_table.md) (i.e. customize columns), making it easier to search / filter experiments. Add user properties to an experiment with the [`Task.set_user_properties`](../references/sdk/task.md#set_user_properties) method. diff --git a/docs/getting_started/ds/best_practices.md b/docs/getting_started/ds/best_practices.md index 4ff0b2e6..15d6ae66 100644 --- a/docs/getting_started/ds/best_practices.md +++ b/docs/getting_started/ds/best_practices.md @@ -46,7 +46,7 @@ that we need. - [ClearML SDK](../../clearml_sdk/clearml_sdk.md) ensures that all the metrics, parameters and Models are automatically logged and can later be accessed, [compared](../../webapp/webapp_exp_comparing.md) and [tracked](../../webapp/webapp_exp_track_visual.md). - [ClearML Agent](../../clearml_agent.md) does the heavy lifting. It reproduces the execution environment, clones your code, - applies code patches, manages parameters (including overriding them on the fly), executes the code and queues multiple tasks + applies code patches, manages parameters (including overriding them on the fly), executes the code, and queues multiple tasks. It can even [build](../../clearml_agent.md#exporting-a-task-into-a-standalone-docker-container) the docker container for you! - [ClearML Pipelines](../../pipelines/pipelines.md) ensure that steps run in the same order, programmatically chaining tasks together, while giving an overview of the execution pipeline's status.