diff --git a/docs/model_cookbook.md b/docs/model_cookbook.md index be32f5602..fdf4c7ede 100644 --- a/docs/model_cookbook.md +++ b/docs/model_cookbook.md @@ -165,18 +165,13 @@ tokenizer_config.json: 100%|█████████████████ Setup (from [README.md](../README.md)): -* TODO: this could be replaced with `pip install iree-turbine` or - `pip install sharktank` at some point. For now these are dev packages. - ```bash # Setup venv. python -m venv --prompt sharktank .venv source .venv/bin/activate -# Install requirements. +# (Optional) Install PyTorch for CPU only, to save on download time. pip install -r pytorch-cpu-requirements.txt -pip install -f https://iree.dev/pip-release-links.html --src deps \ - -e "git+https://github.com/iree-org/iree-turbine.git#egg=iree-turbine" # Install local projects. pip install -r requirements.txt -e sharktank/ shortfin/ diff --git a/docs/nightly_releases.md b/docs/nightly_releases.md index 6f38098d5..c6b4e1bba 100644 --- a/docs/nightly_releases.md +++ b/docs/nightly_releases.md @@ -69,11 +69,6 @@ source 3.11.venv/bin/activate # Install 'sharktank' package from nightly releases. python -m pip install sharktank -f https://github.com/nod-ai/SHARK-Platform/releases/expanded_assets/dev-wheels -# Install iree-turbine from source -# TODO(#294): publish newer iree-turbine package so this isn't necessary. -python -m pip install -f https://iree.dev/pip-release-links.html --src deps \ - -e "git+https://github.com/iree-org/iree-turbine.git#egg=iree-turbine" - # Install some other dependencies. # TODO(#294): list these as "dependencies" in `pyproject.toml` or make optional? python -m pip install gguf numpy huggingface-hub transformers datasets \ @@ -90,8 +85,8 @@ deactivate ```bash # Set up a virtual environment to isolate packages from other envs. -python3.12 -m venv 3.12.venv -source 3.12.venv/bin/activate +python3.11 -m venv 3.11.venv +source 3.11.venv/bin/activate # Install 'shortfin' package from nightly releases. python -m pip install shortfin -f https://github.com/nod-ai/SHARK-Platform/releases/expanded_assets/dev-wheels @@ -102,3 +97,28 @@ python -c "import shortfin as sf; print('Sanity check passed')" # Deactivate the virtual environment when done. deactivate ``` + +## Installing newer versions of dependencies + +To install the `iree-turbine` package from the latest source: + +```bash +python -m pip install --src deps \ + -e "git+https://github.com/iree-org/iree-turbine.git#egg=iree-turbine" +``` + +To install the `iree-compiler` and `iree-runtime` packages from nightly +releases: + +```bash +python -m pip install -f https://iree.dev/pip-release-links.html --upgrade \ + iree-compiler iree-runtime +``` + +To install all three packages together: + +```bash +python -m pip install -f https://iree.dev/pip-release-links.html --upgrade \ + iree-compiler iree-runtime --src deps \ + -e "git+https://github.com/iree-org/iree-turbine.git#egg=iree-turbine" +``` diff --git a/turbine-requirements.txt b/sharktank/requirements-dev-turbine.txt similarity index 100% rename from turbine-requirements.txt rename to sharktank/requirements-dev-turbine.txt