Skip to content

Commit

Permalink
Small docs updates (#2359)
Browse files Browse the repository at this point in the history
* add extra piece on requirements

* update docs for yaml config
  • Loading branch information
strickvl committed Jan 31, 2024
1 parent 9b507c4 commit c203cd5
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/book/user-guide/starter-guide/create-an-ml-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,12 @@ zenml integration install sklearn -y
In this case, ZenML has an integration with `sklearn` so you can use the ZenML CLI to install the right version directly.

{% hint style="info" %}
The `zenml integration install sklearn` command is simply doing a `pip install` of `sklearn` behind the scenes. If something goes wrong, one can always use `zenml integration requirements sklearn` to see which requirements are compatible and install using pip (or any other tool) directly.
The `zenml integration install sklearn` command is simply doing a `pip install`
of `sklearn` behind the scenes. If something goes wrong, one can always use
`zenml integration requirements sklearn` to see which requirements are
compatible and install using pip (or any other tool) directly. (If no specific
requirements are mentioned for an integration then this means we support using
all possible versions of that integration/package.)

{% endhint %}

Expand Down Expand Up @@ -247,6 +252,11 @@ training_pipeline = training_pipeline.with_options(
training_pipeline()
```

The reference to a local file will change depending on where you are executing
the pipeline and code from, so please bear this in mind. It is best practice to
put all config files in a configs directory at the root of your repository and
check them into git history.

A simple version of such a YAML file could be:

```yaml
Expand Down

0 comments on commit c203cd5

Please sign in to comment.