ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 13:21:46 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add agent configs (#400)

Browse Source
This commit is contained in:
pollfly 2022-12-06 09:44:52 +02:00 committed by GitHub
parent 8d983d4cdc
commit 1a07f8c617
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/clearml_agent/clearml_agent_env_var.md
View File

@ -9,27 +9,28 @@ ClearML's environment variables override the clearml.conf file, SDK, and [config
but can be overridden by command-line arguments.
:::
|Name|Description|
|---|---|
|**CLEARML_DOCKER_IMAGE** | Default ClearML Agent docker image|
|**CLEARML_WORKER_NAME** | Sets the Worker's name|
|**CLEARML_WORKER_ID** | Sets the Worker ID|
|**CLEARML_CUDA_VERSION** | Sets the CUDA version to be used|
|**CLEARML_CUDNN_VERSION** | Sets the CUDNN version to be used|
|**CLEARML_CPU_ONLY** | Force CPU only mode|
|**CLEARML_DOCKER_SKIP_GPUS_FLAG**| Skips the GPUs flag (support for docker V18|
|**CLEARML_AGENT_DISABLE_SSH_MOUNT**| Disables the auto `.ssh` mount into the docker|
|**CLEARML_AGENT_GIT_USER** | Sets the Git user for ClearML Agent|
|**CLEARML_AGENT_GIT_PASS** | Sets the Git password for ClearML Agent|
|**CLEARML_AGENT_GIT_HOST** | Sets Git host (only sending login to this host)|
|**CLEARML_AGENT_EXEC_USER**| User for Agent executing tasks (root by default)|
|**CLEARML_AGENT_EXTRA_DOCKER_ARGS**| Overrides extra docker args configuration |
|**CLEARML_AGENT_EXTRA_PYTHON_PATH**| Sets extra python path|
|**CLEARML_AGENT_INITIAL_CONNECT_RETRY_OVERRIDE**| Overrides initial server connection behavior (true by default), allows explicit number to specify number of connect retries) |
|**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT**| Specifies Agent's mount point for Docker / K8s|
|**CLEARML_K8S_GLUE_START_AGENT_SCRIPT_PATH**| Provide an alternate path to place the agent startup script generated inside a k8s task pod (instead of the default `~/~/__start_agent__.sh`)|
|**CLEARML_AGENT_DEBUG_INFO**| Provide additional debug information for a specific context (currently only the `docker` value is supported)|
|**CLEARML_AGENT_CHILD_AGENTS_COUNT_CMD**|Provide an alternate bash command to list child agents while working in services mode|
|**CLEARML_AGENT_SKIP_PIP_VENV_INSTALL**| Skips Python virtual env installation on execute and provides a custom venv binary |
|**CLEARML_AGENT_SKIP_PYTHON_ENV_INSTALL**| Skips entire Python venv installation and assumes python as well as every dependency is preinstalled|
|**CLEARML_AGENT_VENV_CACHE_PATH**|Overrides venv cache folder configuration|
|Name| Description |
|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|**CLEARML_DOCKER_IMAGE** | Default ClearML Agent docker image |
|**CLEARML_WORKER_NAME** | Sets the Worker's name |
|**CLEARML_WORKER_ID** | Sets the Worker ID |
|**CLEARML_CUDA_VERSION** | Sets the CUDA version to be used |
|**CLEARML_CUDNN_VERSION** | Sets the CUDNN version to be used |
|**CLEARML_CPU_ONLY** | Force CPU only mode |
|**CLEARML_DOCKER_SKIP_GPUS_FLAG**| Skips the GPUs flag (support for docker V18 |
|**CLEARML_AGENT_DOCKER_ARGS_HIDE_ENV**| Hide Docker environment variables containing secrets when printing out the Docker command. When printed, the variable values will be replaced by `********`. See [`agent.hide_docker_command_env_vars`](../configs/clearml_conf.md#hide_docker) |
|**CLEARML_AGENT_DISABLE_SSH_MOUNT**| Disables the auto `.ssh` mount into the docker |
|**CLEARML_AGENT_GIT_USER** | Sets the Git user for ClearML Agent |
|**CLEARML_AGENT_GIT_PASS** | Sets the Git password for ClearML Agent |
|**CLEARML_AGENT_GIT_HOST** | Sets Git host (only sending login to this host) |
|**CLEARML_AGENT_EXEC_USER**| User for Agent executing tasks (root by default) |
|**CLEARML_AGENT_EXTRA_DOCKER_ARGS**| Overrides extra docker args configuration |
|**CLEARML_AGENT_EXTRA_PYTHON_PATH**| Sets extra python path |
|**CLEARML_AGENT_INITIAL_CONNECT_RETRY_OVERRIDE**| Overrides initial server connection behavior (true by default), allows explicit number to specify number of connect retries) |
|**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT**| Specifies Agent's mount point for Docker / K8s |
|**CLEARML_K8S_GLUE_START_AGENT_SCRIPT_PATH**| Provide an alternate path to place the agent startup script generated inside a k8s task pod (instead of the default `~/~/__start_agent__.sh`) |
|**CLEARML_AGENT_DEBUG_INFO**| Provide additional debug information for a specific context (currently only the `docker` value is supported) |
|**CLEARML_AGENT_CHILD_AGENTS_COUNT_CMD**| Provide an alternate bash command to list child agents while working in services mode |
|**CLEARML_AGENT_SKIP_PIP_VENV_INSTALL**| Skips Python virtual env installation on execute and provides a custom venv binary |
|**CLEARML_AGENT_SKIP_PYTHON_ENV_INSTALL**| Skips entire Python venv installation and assumes python as well as every dependency is preinstalled |
|**CLEARML_AGENT_VENV_CACHE_PATH**| Overrides venv cache folder configuration |

9
docs/configs/clearml_conf.md
View File

@ -62,6 +62,13 @@ for information about using environment variables with Windows in the configurat
* Dictionary of top-level ClearML Agent options to configure ClearML Agent for Git credentials, package managers, cache management, workers, and Docker for workers.
---
**`agent.crash_on_exception`** (*bool*)
* By default, when encountering an exception while running a task, the agent will catch the exception, log it, and
continue running. When set to `true`, the agent crashes when encountering an exception.
---
**`agent.cuda_version`** (*float*)
@ -243,6 +250,8 @@ For example:
---
<id="hide_docker">
**`agent.hide_docker_command_env_vars`** (*dict*)
* Hide Docker environment variables containing secrets when printing out the Docker command. When printed, the variable