Change terminology (#1028)

This commit is contained in:
pollfly
2025-02-06 17:31:11 +02:00
committed by GitHub
parent 30805e474d
commit b12b71d835
158 changed files with 857 additions and 855 deletions

View File

@@ -166,8 +166,8 @@ The values configured through the wizard are stored in the task's hyperparameter
[`Task.connect()`](../../references/sdk/task.md#connect) and [`Task.set_configuration_object()`](../../references/sdk/task.md#set_configuration_object)
methods respectively. They can be viewed in the WebApp, in the task's **CONFIGURATION** page under **HYPERPARAMETERS** and **CONFIGURATION OBJECTS > General**.
ClearML automatically logs command line arguments defined with argparse. View them in the experiments **CONFIGURATION**
page under **HYPERPARAMETERS > General**.
ClearML automatically logs command line arguments defined with argparse. View them in the task's **CONFIGURATION**
tab under **HYPERPARAMETERS > General**.
![Autoscaler configuration](../../img/examples_aws_autoscaler_config.png)
@@ -177,6 +177,6 @@ in [services mode](../../clearml_agent/clearml_agent_services_mode.md) for such
### Console
All other console output appears in the experiment's **CONSOLE**.
All other console output appears in the task's **CONSOLE**.
![Autoscaler console](../../img/examples_aws_autoscaler_console.png)

View File

@@ -6,7 +6,7 @@ The [cleanup service](https://github.com/allegroai/clearml/blob/master/examples/
demonstrates how to use the `clearml.backend_api.session.client.APIClient` class to implement a service that deletes old
archived tasks and their associated files: model checkpoints, other artifacts, and debug samples.
Modify the cleanup service's parameters to specify which archived experiments to delete and when to delete them.
Modify the cleanup service's parameters to specify which archived tasks to delete and when to delete them.
### Running the Cleanup Service
@@ -52,14 +52,14 @@ an `APIClient` object that establishes a session with the ClearML Server, and ac
* [`Task.delete`](../../references/sdk/task.md#delete) - Delete a Task.
## Configuration
The experiment's hyperparameters are explicitly logged to ClearML using the [`Task.connect()`](../../references/sdk/task.md#connect)
method. View them in the WebApp, in the experiment's **CONFIGURATION** page under **HYPERPARAMETERS > General**.
The task's hyperparameters are explicitly logged to ClearML using the [`Task.connect()`](../../references/sdk/task.md#connect)
method. View them in the WebApp, in the task's **CONFIGURATION** tab under **HYPERPARAMETERS > General**.
The task can be reused. Clone the task, edit its parameters, and enqueue the task to run in ClearML Agent [services mode](../../clearml_agent/clearml_agent_services_mode.md).
![Cleanup service configuration](../../img/example_cleanup_configuration.png)
## Console
All console output appears in the experiment's **CONSOLE**.
All console output appears in the task's **CONSOLE** tab.
![Cleanup service console](../../img/examples_cleanup_console.png)

View File

@@ -60,17 +60,17 @@ The script supports the following additional command line options:
* `service_queue` - The queue to use when running remotely as a service. The default value is `services` (make sure
your workspace has such a queue and to assign a ClearML Agent to this queue).
* `message_prefix` - A message prefix for Slack alerts. For example, to alert all channel members use: `"Hey <!here>"`.
* `min_num_iterations` - Minimal iteration threshold below which experiments are ignored. Use this option to eliminate
* `min_num_iterations` - Minimal iteration threshold below which tasks are ignored. Use this option to eliminate
debug sessions that fail quickly. The default value is 0.
* `project` - The name of the project to monitor. By default, all projects are monitored.
* `include_manual_experiments` - Whether to include experiments that are running locally:
* `True` - Monitor all experiments (both local and remote, executed by ClearML Agent).
* `False` (default) - Monitor only remote experiments.
* `include_manual_experiments` - Whether to include tasks that are running locally:
* `True` - Monitor all tasks (both local and remote, executed by ClearML Agent).
* `False` (default) - Monitor only remote tasks.
* `include_completed_experiments` - If `False` (default), send alerts only for failed tasks. If `True`, send an alert
for completed and failed tasks.
* `include_archived` - If `False` (default), only tasks that are not archived will be reported. This option can be
useful if a task is archived between polling.
* `refresh_rate` - How often to monitor the experiments in seconds. The default value is 10.0.
* `refresh_rate` - How often to monitor the tasks in seconds. The default value is 10.0.
* `include_users` - Only report tasks that were initiated by these users (usernames and user IDs are accepted).
Mutually exclusive to `exclude_users`.
* `exclude_users` - Only report tasks that were NOT initiated by these users (usernames and user IDs are accepted).
@@ -79,7 +79,7 @@ The script supports the following additional command line options:
## Configuration
ClearML automatically logs command line options defined with argparse. They appear in the experiment's **CONFIGURATION**
ClearML automatically logs command line options defined with argparse. They appear in the task's **CONFIGURATION**
page under **HYPERPARAMETERS > Args**.
![Monitoring configuration](../../img/examples_slack_config.png)
@@ -89,7 +89,7 @@ execution (you'll typically want to use a ClearML Agent running in [services mod
for such service tasks).
## Console
All console output appears in the experiment's **CONSOLE** page.
All console output appears in the task's **CONSOLE** page.
## Additional Information about slack_alerts.py