2021-05-13 23:48:51 +00:00
|
|
|
---
|
|
|
|
|
title: Environment Variables
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
:::info
|
|
|
|
|
ClearML's environment variables overide the clearml.conf file and SDK
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
## ClearML SDK Variables
|
|
|
|
|
|
|
|
|
|
### General
|
|
|
|
|
|Name|Description|
|
|
|
|
|
|---|---|
|
|
|
|
|
|**CLEARML_LOG_ENVIRONMENT** | List of Environment variables to log|
|
|
|
|
|
|**CLEARML_TASK_NO_REUSE** | Control Task reuse|
|
|
|
|
|
|**CLEARML_CACHE_DIR** | Sets the location of the cache directory|
|
|
|
|
|
|**CLEARML_DOCKER_IMAGE** | Sets the default docker image to run from|
|
|
|
|
|
|**CLEARML_LOG_LEVEL** | debug \ warning \ error \ info | Sets the ClearML package's log verbosity|
|
|
|
|
|
|**CLEARML_SUPPRESS_UPDATE_MESSAGE** | Suppresses the message that notifies users of new ClearML package version|
|
|
|
|
|
|
|
|
|
|
### VCS
|
|
|
|
|
Overrides Repository Auto-logging
|
|
|
|
|
|
|
|
|
|
|Name|Description|
|
|
|
|
|
|---|---|
|
|
|
|
|
|**CLEARML_VCS_REPO_URL**| Repository's URL|
|
|
|
|
|
|**CLEARML_VCS_COMMIT_ID**| Repository's Commit ID|
|
|
|
|
|
|**CLEARML_VCS_BRANCH**| Repository's Branch|
|
|
|
|
|
|**CLEARML_VCS_ROOT**| Repository's Root directory|
|
|
|
|
|
|
|
|
|
|
### Server Connection
|
|
|
|
|
|Name|Description|
|
|
|
|
|
|---|---|
|
|
|
|
|
|**CLEARML_API_HOST** | Sets the API Server URL|
|
|
|
|
|
|**CLEARML_WEB_HOST** | Sets the Web UI Server URL|
|
|
|
|
|
|**CLEARML_FILES_HOST** | Sets the File Server URL
|
|
|
|
|
|**CLEARML_API_ACCESS_KEY** | Sets the Server's Public Access Key|
|
|
|
|
|
|**CLEARML_API_SECRET_KEY** | Sets the Server's Private Access Key|
|
|
|
|
|
|**CLEARML_API_HOST_VERIFY_CERT**| Enables \ Disable server certificate verification (If behind a firewall)|
|
|
|
|
|
|**CLEARML_OFFLINE_MODE** | Sets Offline mode|
|
2021-07-11 09:17:06 +00:00
|
|
|
|**CLEARML_NO_DEFAULT_SERVER** | Disables sending information to demo server when no HOST server is set|
|
2021-05-13 23:48:51 +00:00
|
|
|
|
|
|
|
|
## ClearML Agent Variables
|
|
|
|
|
|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_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_PYTHON_PATH**| Sets extra python path|
|
|
|
|
|
|**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT**| Specifies Agent's mount point for Docker \ K8s|
|
