Installation

How to install ZenML

This is an older version of the ZenML documentation. To check the latest version please visit https://docs.zenml.io

Installation

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.7 <3.10, so please adjust your Python environment 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/zenml.git@develop --upgrade

Once the installation is completed, you can check whether the installation was successful through:

Known installation issues for M1 Mac Users

If you have a M1 Mac machine and you are encountering an error while trying to install ZenML, please try to setup brew and pyenv with Rosetta 2 and then install ZenML. The issue arises because some of the dependencies aren’t fully compatible with the vanilla ARM64 Architecture. The following links may be helpful (Thank you Reid Falconer!):

• Pyenv with Apple Silicon

• Install Python Under Rosetta 2

Bash

zenml version

Python

import zenml
print(zenml.__version__)

If you would like to learn more about the current release, please visit our PyPi 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