🌎Environment Variables
How to control ZenML behavior with environmental variables.
There are a few pre-defined environmental variables that can be used to control the behavior of ZenML. See the list below with default values and options:
Logging verbosity
Choose from INFO
, WARN
, ERROR
, CRITICAL
, DEBUG
.
Disable step logs
Usually, ZenML stores step logs in the artifact store, but this can sometimes cause performance bottlenecks, especially if the code utilizes progress bars.
If you want to configure whether logged output from steps is stored or not, set the ZENML_DISABLE_STEP_LOGS_STORAGE
environment variable to true
. Note that this will mean that logs from your steps will no longer be stored and thus won't be visible on the dashboard anymore.
ZenML repository path
To configure where ZenML will install and look for its repository, set the environment variable ZENML_REPOSITORY_PATH
.
Analytics
Please see our full page on what analytics are tracked and how you can opt out, but the quick summary is that you can set this to false
if you want to opt out of analytics.
Debug mode
Setting to true
switches to developer mode:
Active stack
Setting the ZENML_ACTIVE_STACK_ID
to a specific UUID will make the corresponding stack the active stack:
Prevent pipeline execution
When true
, this prevents a pipeline from executing:
Disable rich traceback
Set to false
to disable the rich
traceback:
Disable colorful logging
If you wish to disable colorful logging, set the following environment variable:
Note that setting this on the client environment (e.g. your local machine which runs the pipeline) will automatically disable colorful logging on remote orchestrators. If you wish to disable it locally, but turn on for remote orchestrators, you can set the ZENML_LOGGING_COLORS_DISABLED
environment variable in your orchestrator's environment as follows:
ZenML global config path
To set the path to the global config file, used by ZenML to manage and store the state for a number of settings, set the environment variable as follows:
Server configuration
For more information on server configuration, see the ZenML Server documentation for more, especially the section entitled "ZenML server configuration options".
Client configuration
Setting the ZENML_STORE_URL
and ZENML_STORE_API_KEY
environment variables automatically connects your ZenML Client to the specified server. This method is particularly useful when you are using the ZenML client in an automated CI/CD workload environment like GitHub Actions or GitLab CI or in a containerized environment like Docker or Kubernetes:
Last updated