Skip to main content

Documentation Index

Fetch the complete documentation index at: https://zenml.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The local orchestrator is an orchestrator flavor which comes built-in with ZenML and runs your pipelines locally.

​
When to use it

The local orchestrator is part of your default stack when you’re first getting started with ZenML. Due to it running locally on your machine, it requires no additional setup and is easy to use and debug. You should use the local orchestrator if:
  • you’re just getting started with ZenML and want to run pipelines without setting up any cloud infrastructure.
  • you’re writing a new pipeline and want to experiment and debug quickly

​
How to deploy it

The local orchestrator comes with ZenML and works without any additional setup.

​
How to use it

To use the local orchestrator, we can register it and use it in our active stack: 
zenml orchestrator register  --flavor=local

# Register and activate a stack with the new orchestrator
zenml stack register  -o  ... --set
You can now run any ZenML pipeline using the local orchestrator: 
python file_that_runs_a_zenml_pipeline.py
For more information and a full list of configurable attributes of the local orchestrator, check out the API Docs.