Skip to main content

Environment Variables

This page lists the available environment variables for configuring ClearML Agent.

info

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

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_SKIP_PYTHON_ENV_INSTALLSkips entire Python venv installation and assumes python as well as every dependency is preinstalled
CLEARML_AGENT_VENV_CACHE_PATHOverrides venv cache folder configuration