pip install zenml to install.’
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, so please adjust your pip accordingly.
Also, we highly encourage you to install ZenML in a virtual environment. We install dependencies like
Tensorflow that might cause your base installations to be overridden.
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
ZenML requires >= Python 3.6 and < Python 3.9.0
Alternatively, if you’re feeling brave, feel free to install the bleeding edge: NOTE: Do so on your own risk, no guarantees given!
pip install git+https://github.com/maiot-io/zenml.git@main --upgrade
Once the installation is completed, you can check whether the installation was successful through:
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)
Tensorflow Model Analysis support¶
In order to get the Tensorflow Model Analysis evaluation visualizations to work, you must also run:
jupyter nbextension install --py --symlink tensorflow_model_analysis jupyter nbextension enable --py tensorflow_model_analysis
If you encounter a
File already exists in database error error after the first command, this is most likely due to a known bug with one of our dependencies, namely PyArrow. Unfortunately, this will cause some features to not work on your machine (namely pipeline evaluate and compare).
We are aware of this issue and are working hard to fix it. A future release of
zenml will fix this issue.