📼Global settings

Understanding the global settings of your ZenML installation.

The information about the global settings of ZenML on a machine is kept in a folder commonly referred to as the ZenML Global Config Directory or the ZenML Config Path. The location of this folder depends on the operating system type and the current system user, but is usually located in the following locations:

Linux: ~/.config/zenml

Mac: ~/Library/Application Support/zenml

Windows: C:\Users\%USERNAME%\AppData\Local\zenml

The default location may be overridden by setting the ZENML_CONFIG_PATH environment variable to a custom value. The current location of the global config directory used on a system can be retrieved by running the following commands:

# The output will tell you something like this:

# Using configuration from: '/home/stefan/.config/zenml'

zenml status

python -c 'from zenml.utils.io_utils import get_global_config_directory; print(get_global_config_directory())'

Manually altering or deleting the files and folders stored under the ZenML global config directory is not recommended, as this can break the internal consistency of the ZenML configuration. As an alternative, ZenML provides CLI commands that can be used to manage the information stored there:

zenml analytics - manage the analytics settings

zenml clean - to be used only in case of emergency, to bring the ZenML configuration back to its default factory state

zenml downgrade - downgrade the ZenML version in the global configuration to match the version of the ZenML package installed in the current environment. Read more about this in the ZenML Version Mismatch section.

The first time that ZenML is run on a machine, it creates the global config directory and initializes the default configuration in it, along with a default Stack:

Initializing the ZenML global configuration version to 0.13.2

Creating default workspace 'default' ...

Creating default user 'default' ...