Skip to content

Commit

Permalink
Tell users where they can import DockerSettings from (#2947)
Browse files Browse the repository at this point in the history
  • Loading branch information
strickvl authored Aug 25, 2024
1 parent c89c375 commit 647ac95
Showing 1 changed file with 4 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The configuration for specifying pip and apt dependencies only works in the remo

When a [pipeline is run with a remote orchestrator](../configure-python-environments/README.md) a [Dockerfile](https://docs.docker.com/engine/reference/builder/) is dynamically generated at runtime. It is then used to build the Docker image using the [image builder](../configure-python-environments/README.md#-configure-python-environments) component of your stack.

For all of examples on this page, note that `DockerSettings` can be imported using `from zenml.config import DockerSettings`.

By default, ZenML automatically installs all packages required by your active ZenML stack. However, you can specify additional packages to be installed in various ways:

* Install all the packages in your local Python environment (This will use the `pip` or `poetry` package manager to get a list of your local packages):
Expand All @@ -23,6 +25,8 @@ def my_pipeline(...):
If required, a custom command can be provided. This command must output a list of requirements following the format of the [requirements file](https://pip.pypa.io/en/stable/reference/requirements-file-format/):

```python
from zenml.config import DockerSettings

docker_settings = DockerSettings(replicate_local_python_environment=[
"poetry",
"export",
Expand Down

0 comments on commit 647ac95

Please sign in to comment.