ZenML is a Python package that can be installed directly via pip:
pip install zenml
Please note that ZenML currently only supports Python 3.7, 3.8, 3.9 and 3.10. Please adjust your Python environment accordingly.ZenML comes bundled with a React-based dashboard that lives inside a sister repository. In order to get access to the dashboard locally, you need to launch the ZenML Server and Dashboard locally. For this, you need to install the optional dependencies for the ZenML Server:
pip install "zenml[server]"
Virtual Environments
We highly encourage you to install ZenML in a virtual environment. At ZenML, We like to use virtualenvwrapper or pyenv-virtualenv to manage our Python virtual environments.As mentioned above, make sure that your virtual environment uses one of the supported Python versions.
Verifying Installations
Once the installation is completed, you can check whether the installation was successful through:
Bash
zenml version
Python
import zenmlprint(zenml.__version__)
If you would like to learn more about the current release, please visit our PyPi package page.
Running with Docker
Python package
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
ZenML Server
If you would like to run the ZenML server with Docker:
docker run -it -d -p 8080:80 zenmldocker/zenml-server
Installing Develop
If you want to use the bleeding edge of ZenML that has not even been released yet, you can install our develop branch directly.Installing develop is mainly useful if there are key features or bug fixes that you urgently need so you can get those immediately and do not have to wait for the next release.
As the name suggests, the new features in the develop branch are still under
development and might not be as polished as the final released version.Use at your own risk; no guarantees given!
Remote orchestrators like Kubeflow require Docker Images to set up the environments of each step. By default, they use the official ZenML docker image that we provide with each release. However, if you install from develop, this image will be outdated, so you need to build a custom image instead, and specify it in the configuration of your orchestrator accordingly (see the MLOps Stacks Orchestrator page of your specific orchestrator flavor for more details on how this can be done).
Building Custom Docker Images
To build a custom image, you first need to install Docker, then run one of the following commands from the ZenML repo root depending on your operating system:Linux, MacOS (Intel), Windows
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"ZenML","colors":{"primary":"#3E1F8D","light":"#7848F6","dark":"#7848F6"},"favicon":"/favicon.svg","logo":{"dark":"https://mintlify.s3-us-west-1.amazonaws.com/zenml/logo/dark.svg","light":"https://mintlify.s3-us-west-1.amazonaws.com/zenml/logo/light.svg"},"navbar":{"links":[{"label":"Home","href":"https://zenml.io/home"},{"label":"Blog","href":"https://blog.zenml.io"}],"primary":{"type":"button","label":"Get Started","href":"https://github.com/zenml-io/zenml/tree/main/examples/quickstart"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/zenml/","slack":"https://zenml.io/slack-invite","github":"https://github.com/zenml-io/zenml","twitter":"https://twitter.com/zenml_io","youtube":"https://www.youtube.com/@ZenML"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zenml","hasAudioNarration":false,"actualSubdomain":"zenml","customDomains":[],"gitSource":{"type":"github","owner":"mintlify-onboarding","repo":"zenml","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91426b34e8aacd7503b08:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Component Gallery","count":142},{"language":"default","tag":"Documentation","count":52},{"language":"default","tag":"Advanced Guide","count":20},{"language":"default","tag":"Orchestrators","count":11},{"language":"default","tag":"Starter Guide","count":11},{"language":"default","tag":"In-depth Configuration","count":9},{"language":"default","tag":"Getting Started","count":9},{"language":"default","tag":"Container Registries","count":8},{"language":"default","tag":"Secrets Managers","count":8},{"language":"default","tag":"Practical MLOps","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"getting-started/installation","slug":"/getting-started/installation","pageMetadata":{"title":"Installation","description":"How to install ZenML","href":"/getting-started/installation"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"How to install ZenML\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`ZenML`}),` is a Python package that can be installed directly via `,_jsx(_components.code,{children:`pip`}),`:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` zenml`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Please note that ZenML currently only supports Python 3.7, 3.8, 3.9 and 3.10. Please adjust your Python environment accordingly.`}),`\n`,_jsxs(_components.p,{children:[`ZenML comes bundled with a React-based dashboard that lives inside a `,_jsx(_components.a,{href:`https://github.com/zenml-io/zenml-dashboard`,children:`sister repository`}),`. In order to get access to the dashboard locally, you need to launch the `,_jsx(_components.a,{href:`/getting-started/deploying-zenml`,children:`ZenML Server and Dashboard locally`}),`. For this, you need to install the optional dependencies for the ZenML Server:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"zenml[server]\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`virtual-environments`,children:`Virtual Environments`}),`\n`,_jsxs(_components.p,{children:[`We highly encourage you to install ZenML in a virtual environment. At ZenML, We like to use `,_jsx(_components.a,{href:`https://virtualenvwrapper.readthedocs.io/en/latest/`,children:`virtualenvwrapper`}),` or `,_jsx(_components.a,{href:`https://github.com/pyenv/pyenv-virtualenv`,children:`pyenv-virtualenv`}),` to manage our Python virtual environments.`]}),`\n`,_jsx(_components.p,{children:`As mentioned above, make sure that your virtual environment uses one of the supported Python versions.`}),`\n`,_jsx(Heading,{level:`2`,id:`verifying-installations`,children:`Verifying Installations`}),`\n`,_jsx(_components.p,{children:`Once the installation is completed, you can check whether the installation was successful through:`}),`\n`,_jsx(Heading,{level:`3`,id:`bash`,children:`Bash`}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`zenml`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` version`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`python`,children:`Python`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` zenml`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(zenml.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:`__version__`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`If you would like to learn more about the current release, please visit our `,_jsx(_components.a,{href:`https://pypi.org/project/zenml`,children:`PyPi package page.`})]}),`\n`,_jsx(Heading,{level:`2`,id:`running-with-docker`,children:`Running with Docker`}),`\n`,_jsx(Heading,{level:`3`,id:`python-package`,children:`Python package`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`zenml`}),` is also available as a Docker image hosted publicly on `,_jsx(_components.a,{href:`https://hub.docker.com/r/zenmldocker/zenml`,children:`DockerHub`}),`. Use the following command to get started in a bash environment with `,_jsx(_components.code,{children:`zenml`}),` available:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`docker`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -it`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` zenmldocker/zenml`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /bin/bash`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`zenml-server`,children:`ZenML Server`}),`\n`,_jsx(_components.p,{children:`If you would like to run the ZenML server with Docker:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`docker`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -it`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -p`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 8080:80`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` zenmldocker/zenml-server`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`installing-develop`,children:`Installing Develop`}),`\n`,_jsxs(_components.p,{children:[`If you want to use the bleeding edge of ZenML that has not even been released yet, you can install our `,_jsx(_components.code,{children:`develop`}),` branch directly.`]}),`\n`,_jsx(_components.p,{children:`Installing develop is mainly useful if there are key features or bug fixes that you urgently need so you can get those immediately and do not have to wait for the next release.`}),`\n`,_jsxs(Warning,{children:[_jsxs(_components.p,{children:[`As the name suggests, the new features in the `,_jsx(_components.code,{children:`develop`}),` branch are still under\ndevelopment and might not be as polished as the final released version.`]}),_jsx(_components.p,{children:`Use at your own risk; no guarantees given!`})]}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` git+https://github.com/zenml-io/zenml.git@develop`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --upgrade`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`using-develop-with-remote-orchestrators`,children:`Using develop with Remote Orchestrators`}),`\n`,_jsxs(_components.p,{children:[`Remote orchestrators like `,_jsx(_components.a,{href:`/component-gallery/orchestrators/kubeflow`,children:`Kubeflow`}),` require `,_jsx(_components.a,{href:`/getting-started/deploying-zenml/docker`,children:`Docker Images`}),` to set up the environments of each step. By default, they use the official ZenML docker image that we provide with each release. However, if you install from develop, this image will be outdated, so you need to build a custom image instead, and specify it in the configuration of your orchestrator accordingly (see the `,_jsx(_components.a,{href:`/component-gallery/orchestrators`,children:`MLOps Stacks Orchestrator`}),` page of your specific orchestrator flavor for more details on how this can be done).`]}),`\n`,_jsx(Heading,{level:`4`,id:`building-custom-docker-images`,children:`Building Custom Docker Images`}),`\n`,_jsxs(_components.p,{children:[`To build a custom image, you first need to `,_jsx(_components.a,{href:`https://docs.docker.com/engine/install/`,children:`install Docker`}),`, then run one of the following commands from the ZenML repo root depending on your operating system:`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Linux, MacOS (Intel), Windows`})}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`docker`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` build`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -t`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`IMAGE_NAM`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`E`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` docker/local-dev.Dockerfile`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` .`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`MacOS (M1)`})}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`docker`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` build`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --platform`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` linux/amd64`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -t`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`IMAGE_NAM`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`E`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` docker/local-dev.Dockerfile`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` .`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Installation","description":"How to install ZenML","href":"/getting-started/installation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Virtual Environments","slug":"virtual-environments","depth":2,"children":[]},{"title":"Verifying Installations","slug":"verifying-installations","depth":2,"children":[{"title":"Bash","slug":"bash","depth":3,"children":[]},{"title":"Python","slug":"python","depth":3,"children":[]}]},{"title":"Running with Docker","slug":"running-with-docker","depth":2,"children":[{"title":"Python package","slug":"python-package","depth":3,"children":[]},{"title":"ZenML Server","slug":"zenml-server","depth":3,"children":[]}]},{"title":"Installing Develop","slug":"installing-develop","depth":2,"children":[{"title":"Using develop with Remote Orchestrators","slug":"using-develop-with-remote-orchestrators","depth":3,"children":[]},{"title":"Building Custom Docker Images","slug":"building-custom-docker-images","depth":4,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"zenml","siteName":"ZenML","title":"Installation - ZenML","navMaps":{"firstHrefInVersion":{"0.31.1":{"href":"/getting-started/installation","matchLevel":0}},"firstHrefInLanguage":{}},"originalFileLocation":"getting-started/installation.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"How to install ZenML\">\u003cmeta data-mint-head name=\"application-name\" content=\"ZenML\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/zenml/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/zenml/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/zenml/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/zenml/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Installation - ZenML\">\u003cmeta data-mint-head property=\"og:description\" content=\"How to install ZenML\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ZenML\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://zenml.mintlify.app/getting-started/installation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zenml.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Installation\u0026amp;description=How+to+install+ZenML\u0026amp;theme=d8a2be9d1cf4281f5cf2a416\u0026amp;signature=2d5cf42cc38b6f23bb7b4dcd1b1dba0708be7e90d3c848545e8a7bd59473b964\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Installation - ZenML\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"How to install ZenML\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zenml.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Installation\u0026amp;description=How+to+install+ZenML\u0026amp;theme=d8a2be9d1cf4281f5cf2a416\u0026amp;signature=2d5cf42cc38b6f23bb7b4dcd1b1dba0708be7e90d3c848545e8a7bd59473b964\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/zenml/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ZenML\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3E1F8D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://zenml.mintlify.app/getting-started/installation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started/installation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://zenml.mintlify.app/#organization\",\"name\":\"ZenML\",\"url\":\"https://zenml.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3-us-west-1.amazonaws.com/zenml/logo/light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://zenml.mintlify.app#website\",\"name\":\"ZenML\",\"url\":\"https://zenml.mintlify.app\",\"publisher\":{\"@id\":\"https://zenml.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://zenml.mintlify.app/getting-started/installation#webpage\",\"url\":\"https://zenml.mintlify.app/getting-started/installation\",\"name\":\"Installation\",\"description\":\"How to install ZenML\",\"isPartOf\":{\"@id\":\"https://zenml.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://zenml.mintlify.app/getting-started/installation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://zenml.mintlify.app/getting-started/installation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://zenml.mintlify.app/getting-started/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Installation\",\"item\":\"https://zenml.mintlify.app/getting-started/installation\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://zenml.mintlify.app/getting-started/installation#article\",\"headline\":\"Installation\",\"name\":\"Installation\",\"description\":\"How to install ZenML\",\"url\":\"https://zenml.mintlify.app/getting-started/installation\",\"mainEntityOfPage\":{\"@id\":\"https://zenml.mintlify.app/getting-started/installation#webpage\"},\"publisher\":{\"@id\":\"https://zenml.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://zenml.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ZenML\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ZenML\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/getting-started/installation.md","siteName":"ZenML","nav":{"global":null,"versions":[{"version":"0.31.1","anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/getting-started/introduction"},{"title":"Core Concepts","description":"What are the core concepts in ZenML","href":"/getting-started/core-concepts"},{"title":"Installation","href":"/getting-started/installation"},{"group":"Deploying ZenML","pages":[{"title":"Deploying ZenML","description":"A guide on how to deploy ZenML","href":"/getting-started/deploying-zenml"},{"title":"One Click Deployment using CLI","href":"/getting-started/deploying-zenml/cli"},{"title":"Deploying with Docker","href":"/getting-started/deploying-zenml/docker"},{"title":"Deploying with Helm","href":"/getting-started/deploying-zenml/helm"}]},{"title":"Architecture Diagrams","href":"/getting-started/architecture-diagrams"},{"title":"Examples","href":"/getting-started/examples"}]},{"group":"Starter Guide","pages":[{"group":"Pipelines","pages":[{"title":"Pipelines","href":"/starter-guide/pipelines"},{"title":"Dashboard Overview","href":"/starter-guide/pipelines/dashboard"},{"title":"Fetching Pipelines","href":"/starter-guide/pipelines/fetching-pipelines"},{"title":"Step Parameterization and Caching","href":"/starter-guide/pipelines/parameters-and-caching"}]},{"group":"Stacks","pages":[{"title":"Stacks","href":"/starter-guide/stacks"},{"title":"Registering Stacks","href":"/starter-guide/stacks/registering-stacks"},{"title":"Managing Stacks","href":"/starter-guide/stacks/managing-stacks"}]},{"group":"Collaboration","pages":[{"title":"Collaboration","href":"/starter-guide/collaborate"},{"title":"Connecting to a Deployed ZenML","href":"/starter-guide/collaborate/zenml-deployment"},{"title":"Inviting Users","href":"/starter-guide/collaborate/users"},{"title":"User Roles \u0026 Permissions","href":"/starter-guide/collaborate/roles-and-permissions"}]}]},{"group":"Advanced Guide","pages":[{"group":"In-depth Configuration","pages":[{"title":"In-depth Configuration","href":"/advanced-guide/pipelines"},{"title":"Runtime Settings","href":"/advanced-guide/pipelines/settings"},{"title":"Containerization (Docker)","href":"/advanced-guide/pipelines/containerization"},{"title":"Passing Custom Data Types through Steps (Materializers)","href":"/advanced-guide/pipelines/materializers"},{"title":"Specifying Step Resources","href":"/advanced-guide/pipelines/step-resources"},{"title":"Enabling GPU-backed hardware","href":"/advanced-guide/pipelines/gpu-hardware"},{"title":"Scheduling Pipeline Runs","href":"/advanced-guide/pipelines/scheduling-runs"},{"title":"Accessing Metadata within Steps","href":"/advanced-guide/pipelines/step-metadata"},{"title":"Controlling the Step Execution Order","href":"/advanced-guide/pipelines/step-order"}]},{"group":"Extending Stacks","pages":[{"title":"Extending Stacks","href":"/advanced-guide/stacks"},{"title":"Writing Custom Flavors","href":"/advanced-guide/stacks/custom-flavors"},{"title":"Managing Stack Component States","href":"/advanced-guide/stacks/stack-state-management"},{"title":"Managing External Services","href":"/advanced-guide/stacks/manage-external-services"}]},{"group":"Practical MLOps","pages":[{"title":"Practical MLOps","href":"/advanced-guide/practical-mlops"},{"title":"Stack Recipes","href":"/advanced-guide/practical-mlops/stack-recipes"},{"title":"Switching Orchestration","href":"/advanced-guide/practical-mlops/switching-orchestration"},{"title":"Secrets Management","href":"/advanced-guide/practical-mlops/secrets-management"},{"title":"Tracking Experiments","href":"/advanced-guide/practical-mlops/tracking-experiments"},{"title":"Validating Data","href":"/advanced-guide/practical-mlops/validating-data"},{"title":"Deploying Models and Batch Inference","href":"/advanced-guide/practical-mlops/deploying-models"}]}]},{"group":"Guidelines","pages":[{"title":"Best Practices","href":"/guidelines/best-practices"},{"title":"Global Configuration","href":"/guidelines/global-config"},{"title":"System Environmental Variables","href":"/guidelines/system-environmental-variables"},{"title":"Migration Guide 0.20.0","href":"/guidelines/migration-zero-twenty"}]},{"group":"Misc","pages":[{"title":"Contribution Guide","href":"/misc/contributing"},{"title":"Debugging Guide","href":"/misc/debugging"},{"title":"External Integration Guide","href":"/misc/integrating"},{"title":"Usage Analytics","href":"/misc/usage-analytics"}]},{"group":"Reference","pages":[{"title":"Community \u0026 Content","href":"/reference/community-and-content"},{"title":"Glossary","href":"/reference/glossary"},{"title":"FAQ","href":"/reference/faq"},{"title":"CLI Cheat Sheet","href":"/reference/cheat-sheet"}]}]},{"anchor":"Component Gallery","icon":"grid-2","pages":[{"title":"Component Gallery","href":"/component-gallery/categories"}]},{"anchor":"CLI Reference","href":"https://apidocs.zenml.io/latest/cli/","icon":"rectangle-terminal"},{"anchor":"API Reference","href":"https://apidocs.zenml.io","icon":"code"},{"anchor":"Github","href":"https://github.com/zenml-io/zenml","icon":"github"}]}]},"basePath":"","title":"Installation - ZenML","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}