Update Docusaurus (#855)

This commit is contained in:
pollfly
2024-06-23 10:00:06 +03:00
committed by GitHub
parent f52a139c34
commit d166467a32
32 changed files with 8616 additions and 4726 deletions

View File

@@ -25,7 +25,7 @@ private credentials (assuming the entire code base, including `.git` already exi
## Optional: ClearML Configuration Parameters
:::caution
:::warning
If you set ClearML configuration parameters (ClearML Server and ClearML credentials) in the plugin, they will override
the settings in the ClearML configuration file.
:::

View File

@@ -62,21 +62,23 @@ task = Task.init(
When the script runs, ClearML creates the following directory structure:
+ - <output destination name>
| +-- <project name>
| +-- <task name>.<Task Id>
| +-- models
| +-- artifacts
```
+ - <output destination name>
| +-- <project name>
| +-- <task name>.<Task Id>
| +-- models
| +-- artifacts
```
and puts the model checkpoints (snapshots) and artifacts in that folder.
For example, if the Task ID is `9ed78536b91a44fbb3cc7a006128c1b0`, then the directory structure will be:
+ - model_snapshots
| +-- examples
| +-- extending automagical ClearML example.9ed78536b91a44fbb3cc7a006128c1b0
| +-- models
| +-- artifacts
```
+ - model_snapshots
| +-- examples
| +-- extending automagical ClearML example.9ed78536b91a44fbb3cc7a006128c1b0
| +-- models
| +-- artifacts
```
## Step 2: Logger Class Reporting Methods

View File

@@ -59,7 +59,7 @@ python slack_alerts.py --channel <Slack-channel-name> --slack-api <Slack-API-tok
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>".
* `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
debug sessions that fail quickly. The default value is 0.
* `project` - The name of the project to monitor. By default, all projects are monitored.

View File

@@ -23,7 +23,7 @@ the `offline_mode` argument to `True`
* Before running a task, set `CLEARML_OFFLINE_MODE=1`
:::caution
:::warning
Offline mode only works with tasks created using [`Task.init()`](../references/sdk/task.md#taskinit) and not with those created
using [`Task.create()`](../references/sdk/task.md#taskcreate).
:::

View File

@@ -51,33 +51,34 @@ For more information about workers, worker daemons, and queues, see [Agents and
Run the worker daemon on the local development machine.
1. Open a terminal session.
1. Run the following `clearml-agent` command which runs a worker daemon listening to the `default` queue:
clearml-agent daemon --queue default
```
clearml-agent daemon --queue default
```
The response to this command is information about the configuration, the worker, and the queue. For example:
Current configuration (clearml_agent v0.16.0, location: /home/<username>/clearml.conf):
----------------------
agent.worker_id =
agent.worker_name = LAPTOP-PPTKKPGK
agent.python_binary =
agent.package_manager.type = pip
.
.
.
sdk.development.worker.report_period_sec = 2
sdk.development.worker.ping_period_sec = 30
sdk.development.worker.log_stdout = true
```
Current configuration (clearml_agent v0.16.0, location: /home/<username>/clearml.conf):
----------------------
agent.worker_id =
agent.worker_name = LAPTOP-PPTKKPGK
agent.python_binary =
agent.package_manager.type = pip
.
.
.
sdk.development.worker.report_period_sec = 2
sdk.development.worker.ping_period_sec = 30
sdk.development.worker.log_stdout = true
Worker "LAPTOP-PPTKKPGK:0" - Listening to queues:
+ ---------------------------------+---------+-------+
| id | name | tags |
+ ---------------------------------+---------+-------+
| 2a03daf5ff9a4255b9915fbd5306f924 | default | |
+ ---------------------------------+---------+-------+
Worker "LAPTOP-PPTKKPGK:0" - Listening to queues:
+ ---------------------------------+---------+-------+
| id | name | tags |
+ ---------------------------------+---------+-------+
| 2a03daf5ff9a4255b9915fbd5306f924 | default | |
+ ---------------------------------+---------+-------+
Running CLEARML-AGENT daemon in background mode, writing stdout/stderr to /home/<username>/.clearml_agent_daemon_outym6lqxrz.txt
Running CLEARML-AGENT daemon in background mode, writing stdout/stderr to /home/<username>/.clearml_agent_daemon_outym6lqxrz.txt
```
## Step 5: Enqueue the Tuned Experiment
Enqueue the tuned experiment.