As ZenML continues to grow, we’ll be adding more features and integrations. Alongside whatever new things get added to the codebase, we work hard to make our documentation a complete reference for anyone trying to get up to speed quickly. For those of you who prefer a more hands-on approach, our examples might be better suited.
Right now you can find the following small, practical ways to experiment with ZenML pipelines:
You don’t even need to clone our repository to get the goodness of examples! Use the series of commands that begin with
zenml example to download and even run examples.
Get the full list of examples available:
zenml example list
Pick an example to download into your current working directory:
zenml example pull quickstart # at this point a `zenml_examples` dir would be created with the example(s) inside it
When you’re ready to run the example, simply type the following command. If there are any dependencies needed to be downloaded for the example to run, the CLI will prompt you to install them.
zenml example run quickstart
It’s that easy to get started with some examples of ZenML in action! Visit our guides and walkthroughs for longer examples showcasing some longer use cases.
The ZenML core team originally started discussing adding the
example run command as a way of including test runs of our examples as part of our continuous integration that Github Actions invokes whenever merging to
main. It was only later that we saw how it might also be a useful option for users to be able to run the examples with very little setup or configuration needs.