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

Edit ClearML Agent reference (#132)

Browse Source
This commit is contained in:
pollfly 2021-12-14 14:51:46 +02:00 committed by GitHub
parent e3afc3ad93
commit 6ae75beaa2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/references/clearml_agent_ref.md
View File

@ -15,7 +15,8 @@ Use the `build` subcommand to create a worker environment without executing the
### Syntax ### Syntax
clearml-agent build [-h] --id TASK_ID [--target TARGET] ```bash
clearml-agent build [-h] --id TASK_ID [--target TARGET]
[--install-globally] [--install-globally]
[--docker [DOCKER [DOCKER ...]]] [--docker [DOCKER [DOCKER ...]]]
[--python-version PYTHON_VERSION] [--python-version PYTHON_VERSION]
@ -23,6 +24,7 @@ Use the `build` subcommand to create a worker environment without executing the
[--git-user GIT_USER] [--git-pass GIT_PASS] [--git-user GIT_USER] [--git-pass GIT_PASS]
[--log-level {DEBUG,INFO,WARN,WARNING,ERROR,CRITICAL}] [--log-level {DEBUG,INFO,WARN,WARNING,ERROR,CRITICAL}]
[--gpus GPUS] [--cpu-only] [--gpus GPUS] [--cpu-only]
```
### Arguments ### Arguments
@ -152,17 +154,30 @@ Use the `daemon` subcommand to run a worker, optionally in a Docker container, l
### Syntax ### Syntax
clearml-agent daemon [-h] [--foreground] [--queue QUEUES [QUEUES ...]] [--order-fairness] [--standalone-mode] ```bash
[--services-mode [SERVICES_MODE]] [--create-queue] [--detached] [--stop] [--dynamic-gpus] clearml-agent daemon [-h] [--foreground] [--queue QUEUES [QUEUES ...]] [--order-fairness]
[--uptime [UPTIME [UPTIME ...]]] [--downtime [DOWNTIME [DOWNTIME ...]]] [--status] [-O] [--standalone-mode] [--services-mode [SERVICES_MODE]]
[--git-user GIT_USER] [--git-pass GIT_PASS] [--log-level {DEBUG,INFO,WARN,WARNING,ERROR,CRITICAL}] [--child-report-tags CHILD_REPORT_TAGS [CHILD_REPORT_TAGS ...]]
[--gpus GPUS] [--cpu-only] [--docker [DOCKER [DOCKER ...]]] [--force-current-version] [--create-queue] [--detached] [--stop] [--dynamic-gpus]
[--uptime [UPTIME [UPTIME ...]]] [--downtime [DOWNTIME [DOWNTIME ...]]]
[--status] [--use-owner-token] [-O]
[--git-user GIT_USER] [--git-pass GIT_PASS]
[--log-level {DEBUG,INFO,WARN,WARNING,ERROR,CRITICAL}]
[--gpus GPUS] [--cpu-only]
[--docker [DOCKER [DOCKER ...]]] [--force-current-version]
```
### Arguments ### Arguments
--- ---
**`child-report-tags`**
List of tags to send with the status reports from the worker that executes a task.
---
**`cpu-only`** **`cpu-only`**
* If running in Docker mode (see the `docker` option), disable GPU access for the Docker container or virtual environment. * If running in Docker mode (see the `docker` option), disable GPU access for the Docker container or virtual environment.
@ -204,7 +219,7 @@ Use the `daemon` subcommand to run a worker, optionally in a Docker container, l
For example, use `09-13 TUE` to set Tuesday's downtime to 09-13. For example, use `09-13 TUE` to set Tuesday's downtime to 09-13.
:::note :::info
* This feature is only supported by the ClearML Enterprise Server * This feature is only supported by the ClearML Enterprise Server
* Make sure to have only one of uptime / downtime configuration and not both. * Make sure to have only one of uptime / downtime configuration and not both.
::: :::
@ -217,7 +232,7 @@ Use the `daemon` subcommand to run a worker, optionally in a Docker container, l
For example: `--dynamic-gpus --queue dual_gpus=2 single_gpu=1` For example: `--dynamic-gpus --queue dual_gpus=2 single_gpu=1`
:::note :::info Enterprise Feature
This feature is only supported by the ClearML Enterprise Server This feature is only supported by the ClearML Enterprise Server
::: :::
@ -339,20 +354,31 @@ This feature is only supported by the ClearML Enterprise Server
* Specify uptime for clearml-agent in `<hours> <days>` format. for example, use `17-20 TUE` to set Tuesday's * Specify uptime for clearml-agent in `<hours> <days>` format. for example, use `17-20 TUE` to set Tuesday's
uptime to 17-20 uptime to 17-20
:::note :::info
* This feature is only supported by the ClearML Enterprise Server * This feature is only supported by the ClearML Enterprise Server
* Make sure to have only one of uptime / downtime configuration and not both. * Make sure to have only one of uptime / downtime configuration and not both.
::: :::
---
**`use-owner-token`**
Generate and use the task owner's token for the execution of the task.
## execute ## execute
Use the `execute` subcommand to build and execute an experiment without a queue. Use the `execute` subcommand to build and execute an experiment without a queue.
### Syntax ### Syntax
clearml-agent execute [-h] --id TASK_ID [--log-file LOG_FILE] [--disable-monitoring] [--full-monitoring] [--require-queue] ```bash
[--standalone-mode] [--docker [DOCKER [DOCKER ...]]] [--clone] [-O] [--git-user GIT_USER] clearml-agent execute [-h] --id TASK_ID [--log-file LOG_FILE] [--disable-monitoring]
[--git-pass GIT_PASS] [--log-level {DEBUG,INFO,WARN,WARNING,ERROR,CRITICAL}] [--gpus GPUS] [--cpu-only] [--full-monitoring] [--require-queue]
[--standalone-mode] [--docker [DOCKER [DOCKER ...]]] [--clone]
[-O] [--git-user GIT_USER] [--git-pass GIT_PASS]
[--log-level {DEBUG,INFO,WARN,WARNING,ERROR,CRITICAL}]
[--gpus GPUS] [--cpu-only]
```
### Arguments ### Arguments
@ -420,7 +446,7 @@ Use the `execute` subcommand to build and execute an experiment without a queue.
**`gpus`** **`gpus`**
* Specify active GPUs for the daemon to use (docker / virtual environment), Equivalent to setting * Specify active GPUs for the daemon to use (docker / virtual environment), Equivalent to setting
NVIDIA_VISIBLE_DEVICES Examples: --gpus 0 or --gpu 0,1,2 or --gpus all NVIDIA_VISIBLE_DEVICES Examples: `--gpus 0` or `--gpu 0,1,2` or `--gpus all`
--- ---