Installation
Installing ZenML and getting started.
Install ZenML
ZenML currently supports Python 3.9, 3.10, 3.11, and 3.12. Please make sure that you are using a supported Python version.
ZenML is a Python package that can be installed using pip
or other Python package managers:
pip install zenml
Installing the base package only allows you to connect to a deployed ZenML server. If you want to use ZenML purely locally, install it with the local
extra:
pip install 'zenml[local]'
Verifying Installations
Once the installation is completed, you can check whether the installation was successful either through Bash or Python:
zenml version
If you would like to learn more about the current release, please visit our PyPi package page.
Running with Docker
zenml
is also 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
If you would like to run the ZenML server with Docker:
docker run -it -d -p 8080:8080 zenmldocker/zenml-server
Starting the local server
By default, ZenML runs without a server connected to a local database on your machine. If you want to access the dashboard locally, you need to start a local server:
# Make sure to have the `server` extra installed
pip install "zenml[server]"
zenml login --local # opens the dashboard locally
However, advanced ZenML features are dependent on a centrally deployed ZenML server accessible to other MLOps stack components. You can read more about it here. For the deployment of ZenML, you have the option to either self-host it or register for a free ZenML Pro account.
Last updated
Was this helpful?