Skip to content

Add links to uv new PyTorch documentation #3204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/book/component-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,13 @@ You can run `zenml integration --help` to see a full list of CLI commands that Z

Note, that you can also install your dependencies directly, but please note that there is no guarantee that ZenML internals with work with any arbitrary version of any external library.

#### Experimental: Use `uv` for package installation
#### Use `uv` for package installation

You can use [`uv`](https://github.com/astral-sh/uv) as a package manager if you want. Simply pass the `--uv` flag to the `zenml integration ...` command and it'll use `uv` for installation, upgrades and uninstallations. Note that `uv` must be installed for this to work. This is an experimental option that we've added for users wishing to use `uv` but given that it is relatively new as an option there might be certain packages that don't work well with `uv`. We will monitor how this performs and update as `uv` becomes more stable.
You can use [`uv`](https://github.com/astral-sh/uv) as a package manager if you want. Simply pass the `--uv` flag to the `zenml integration ...` command and it'll use `uv` for installation, upgrades and uninstalls. Note that `uv` must be installed for this to work. This is an experimental option that we've added for users wishing to use `uv` but given that it is relatively new as an option there might be certain packages that don't work well with `uv`.

Full documentation for how it works with PyTorch can be found on Astral's docs
website [here](https://docs.astral.sh/uv/guides/integration/pytorch/). It covers
some of the particular gotchas and details you might need to know.

### Upgrade ZenML integrations

Expand Down
6 changes: 5 additions & 1 deletion docs/book/component-guide/integration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,14 @@ You can run `zenml integration --help` to see a full list of CLI commands that Z

Note, that you can also install your dependencies directly, but please note that there is no guarantee that ZenML internals with work with any arbitrary version of any external library.

### Experimental: Use `uv` for package installation
### Use `uv` for package installation

You can use [`uv`](https://github.com/astral-sh/uv) as a package manager if you want. Simply pass the `--uv` flag to the `zenml integration ...` command and it'll use `uv` for installation, upgrades and uninstallations. Note that `uv` must be installed for this to work. This is an experimental option that we've added for users wishing to use `uv` but given that it is relatively new as an option there might be certain packages that don't work well with `uv`. We will monitor how this performs and update as `uv` becomes more stable.

Full documentation for how it works with PyTorch can be found on Astral Docs
website [here](https://docs.astral.sh/uv/guides/integration/pytorch/). It covers
some of the particular gotchas and details you might need to know.

## Upgrade ZenML integrations

You can upgrade all integrations to their latest possible version using:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,8 @@ def my_pipeline(...):
`uv` is a relatively new project and not as stable as `pip` yet, which might lead to errors during package installation. If this happens, try switching the installer back to `pip` and see if that solves the issue.
{% endhint %}

Full documentation for how `uv` works with PyTorch can be found on Astral Docs
website [here](https://docs.astral.sh/uv/guides/integration/pytorch/). It covers
some of the particular gotchas and details you might need to know.

<figure><img src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" alt="ZenML Scarf"><figcaption></figcaption></figure>