Skip to content

Commit

Permalink
Recommend installing torch cpu ahead of shark-ai. (#552)
Browse files Browse the repository at this point in the history
The default `torch` install pulls in multiple gigabytes of packages
(mostly CUDA), which are not needed.

We'll eventually
* Remove the implicit dep on default-torch in
https://github.com/iree-org/iree-turbine
* Rework shortfin_apps to not depend on torch

For now, suggest that users install the torch package of their choosing
before installing any of our packages.
  • Loading branch information
ScottTodd authored Nov 18, 2024
1 parent 6b5ff4a commit 5d453c3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Setup your Python environment with the following commands:
# Set up a virtual environment to isolate packages from other envs.
python3.11 -m venv 3.11.venv
source 3.11.venv/bin/activate

# Optional: faster installation of torch with just CPU support.
# See other options at https://pytorch.org/get-started/locally/
pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
```

## Install SHARK and its dependencies
Expand Down

0 comments on commit 5d453c3

Please sign in to comment.