Skip to main content

Environment Variables

info

ClearML's environment variables override the clearml.conf file, SDK, and configuration vault, but can be overridden by command-line arguments.

ClearML SDK Variables#

General#

NameDescription
CLEARML_LOG_ENVIRONMENTList of Environment variables to log
CLEARML_TASK_NO_REUSEControl Task reuse
CLEARML_CACHE_DIRSets the location of the cache directory
CLEARML_DOCKER_IMAGESets the default docker image to run from
CLEARML_LOG_LEVELdebug / warning / error / info - Sets the ClearML package's log verbosity
CLEARML_SUPPRESS_UPDATE_MESSAGESuppresses the message that notifies users of new ClearML package version

VCS#

Overrides Repository Auto-logging

NameDescription
CLEARML_VCS_REPO_URLRepository's URL
CLEARML_VCS_COMMIT_IDRepository's Commit ID
CLEARML_VCS_BRANCHRepository's Branch
CLEARML_VCS_ROOTRepository's Root directory

Server Connection#

NameDescription
CLEARML_API_HOSTSets the API Server URL
CLEARML_CONFIG_FILESets the ClearML configuration file. Overrides the default configuration file location
CLEARML_WEB_HOSTSets the Web UI Server URL
CLEARML_FILES_HOSTSets the File Server URL
CLEARML_API_ACCESS_KEYSets the Server's Public Access Key
CLEARML_API_SECRET_KEYSets the Server's Private Access Key
CLEARML_API_HOST_VERIFY_CERTEnables / Disables server certificate verification (if behind a firewall)
CLEARML_OFFLINE_MODESets Offline mode
CLEARML_NO_DEFAULT_SERVERDisables sending information to demo server when no HOST server is set

ClearML Agent Variables#

NameDescription
CLEARML_DOCKER_IMAGEDefault ClearML Agent docker image
CLEARML_WORKER_NAMESets the Worker's name
CLEARML_WORKER_IDSets the Worker ID
CLEARML_CUDA_VERSIONSets the CUDA version to be used
CLEARML_CUDNN_VERSIONSets the CUDNN version to be used
CLEARML_CPU_ONLYForce CPU only mode
CLEARML_DOCKER_SKIP_GPUS_FLAGSkips the GPUs flag (support for docker V18
CLEARML_AGENT_DISABLE_SSH_MOUNTDisables the auto .ssh mount into the docker
CLEARML_AGENT_GIT_USERSets the Git user for ClearML Agent
CLEARML_AGENT_GIT_PASSSets the Git password for ClearML Agent
CLEARML_AGENT_GIT_HOSTSets Git host (only sending login to this host)
CLEARML_AGENT_EXEC_USERUser for Agent executing tasks (root by default)
CLEARML_AGENT_EXTRA_DOCKER_ARGSOverrides extra docker args configuration
CLEARML_AGENT_EXTRA_PYTHON_PATHSets extra python path
CLEARML_AGENT_INITIAL_CONNECT_RETRY_OVERRIDEOverrides 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_MOUNTSpecifies Agent's mount point for Docker / K8s
CLEARML_AGENT_SKIP_PIP_VENV_INSTALLSkips Python virtual env installation on execute and provides a custom venv binary
CLEARML_AGENT_VENV_CACHE_PATHOverrides venv cache folder configuration