📚How do I...?

Links to common use cases, workflows and tasks using ZenML.

Last Updated: December 13, 2023

Some common questions that we get asked are:

contribute to ZenML's open-source codebase?

Please read our Contribution guide for more information. For small features and bug fixes, please open a pull request as described in the guide. For anything bigger, it is worth posting a message in Slack or creating an issue so we can best discuss and support your plans.

custom components: adding them to ZenML?

Please start by reading the general documentation page on implementing a custom stack component which offers some general advice on what you'll need to do.

From there, each of the custom stack component types has a dedicated section about adding your own custom components. For example, for adding custom orchestrators you would visit this page.

dependency clashes mitigation with ZenML?

Check out our dedicated documentation page on some ways you can try to solve these dependency and versioning issues.

deploy cloud infrastructure and/or MLOps stacks?

ZenML is designed to be stack-agnostic, so you can use it with any cloud infrastructure or MLOps stack. Each of the documentation pages for stack components explain how to deploy these components on the most popular cloud providers.

We also build and maintain the mlstacks package and library which offers a dedicated way to spin up infrastructure for your ZenML pipelines. It's fully integrated into ZenML's CLI and is a great way to get started with deploying your infrastructure. ZenML also publishes and maintains modules on the Terraform Registry (which are used by mlstacks under the hood) which you can also use as a standalone solution if you are familiar with Terraform.

deploy ZenML on my internal company cluster?

Read the documentation on self-hosted ZenML deployments in which several options are presented.

hyperparameter tuning?