Installation & Setup
TL;DR: Do *pip install zenml* to install.

Welcome

Your first step is to install ZenML, which comes bundled as a good old pip package.
Please note that we only support Python >= 3.6 <3.9, so please adjust your pip accordingly.

Virtual Environment

We highly encourage you to install ZenML in a virtual environment. We like to use virtualenvwrapper to manage our Python virtual environments.

Install with pip

When you're set with your environment, run:
pip install zenml
Alternatively, if you’re feeling brave, feel free to install the bleeding edge: NOTE: Do so at your own risk; no guarantees given!
pip install git+https://github.com/zenml-io/[email protected] --upgrade
Once the installation is completed, you can check whether the installation was successful through:

Bash

zenml version

Python

import zenml
print(zenml.__version__)
If you would like to learn more about the current release, please visit ourPyPi package page.

Running with Docker

zenml is available as a docker image hosted publicly on DockerHub. Use the following command to get started in a bash environment with zenml available:
docker run -it zenmldocker/zenml /bin/bash

Enabling auto-completion on the CLI

For Bash, add this to ~/.bashrc:
eval "$(_ZENML_COMPLETE=source_bash zenml)"
For Zsh, add this to ~/.zshrc:
eval "$(_ZENML_COMPLETE=source_zsh zenml)"
For Fish, add this to ~/.config/fish/completions/foo-bar.fish:
eval (env _ZENML_COMPLETE=source_fish zenml)
Last modified 6mo ago