Skip to content

Commit

Permalink
chore: add basic docs to describe needing to install python deps for …
Browse files Browse the repository at this point in the history
…building zarf packages
  • Loading branch information
YrrepNoj committed Jul 31, 2024
1 parent 5234339 commit 742cf4c
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions packages/llama-cpp-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ To build and deploy just the llama-cpp-python Zarf package (from the root of the
> Deploy a [UDS cluster](/README.md#uds) if one isn't deployed already
```shell
pip install 'huggingface_hub[cli,hf_transfer]' # Used to download the model weights from huggingface
make build-llama-cpp-python LOCAL_VERSION=dev
uds zarf package deploy packages/llama-cpp-python/zarf-package-llama-cpp-python-*-dev.tar.zst --confirm
```
Expand Down
1 change: 1 addition & 0 deletions packages/text-embeddings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ To build and deploy just the text-embeddings Zarf package (from the root of the
> Deploy a [UDS cluster](/README.md#uds) if one isn't deployed already
```shell
pip install 'huggingface_hub[cli,hf_transfer]' # Used to download the model weights from huggingface
make build-text-embeddings LOCAL_VERSION=dev
uds zarf package deploy packages/text-embeddings/zarf-package-text-embeddings-*-dev.tar.zst --confirm
```
Expand Down
1 change: 1 addition & 0 deletions packages/vllm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ To build and deploy just the VLLM Zarf package (from the root of the repository)
> Deploy a [UDS cluster](/README.md#uds) if one isn't deployed already
```shell
pip install 'huggingface_hub[cli,hf_transfer]' # Used to download the model weights from huggingface
make build-vllm LOCAL_VERSION=dev
uds zarf package deploy packages/vllm/zarf-package-vllm-*-dev.tar.zst --confirm
```
Expand Down
2 changes: 2 additions & 0 deletions packages/whisper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ To build and deploy just the whisper Zarf package (from the root of the reposito
> Deploy a [UDS cluster](/README.md#uds) if one isn't deployed already
```shell
pip install 'ctranslate2' # Used to download and convert the model weights
pip install 'transformers[torch]' # Used to download and convert the model weights
make build-whisper LOCAL_VERSION=dev
uds zarf package deploy packages/whisper/zarf-package-whisper-*-dev.tar.zst --confirm
```
Expand Down
2 changes: 2 additions & 0 deletions uds-bundles/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ source .venv/bin/activate
Each component is built into its own Zarf package. You can build all of the packages you need at once with the following `Make` targets:
> ***Note:*** You need to build with `make build-* LOCAL_VERSION=dev` to set the tag to `dev` instead of the commit hash locally.
> ***NOTE:*** Some of the packages have Python dev dependencies that need to be installed when building them locally. These dependencies are used to download the model weights that will be included in the final Zarf package. These dependencies are listed as `dev` in the `project.optional-dependencies` section of each models `pyproject.toml`.
You can build all of the packages you need at once with the following `Make` targets:

```shell
Expand Down
2 changes: 2 additions & 0 deletions website/content/en/docs/local deploy guide/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Additionally, please check the list of tested [operating systems](https://docs.l

## Prerequisites

- [Python 3.11](https://www.python.org/downloads/release/python-3116/)
- NOTE: Different model packages will require different Python libraries. The libraries required will be listed in the `dev` optional dependencies in each projects `pyproject.toml` file.
- [Docker](https://docs.docker.com/engine/install/)
- [K3D](https://k3d.io/)
- [Zarf](https://docs.zarf.dev/getting-started/install/)
Expand Down

0 comments on commit 742cf4c

Please sign in to comment.