petals

(β˜… 10,505)

🌸 Run LLMs at home, BitTorrent-style. Fine-tuning and inference up to 10x faster than offloading

  • .gitignore
  • Dockerfile
  • LICENSE
  • pyproject.toml
  • README.md
  • setup.cfg

# Installation Guide

1. Get the code
git clone https://github.com/bigscience-workshop/petals

Downloads the entire project code from GitHub to your computer.

cd petals

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
  • Homebrew A package manager for macOS/Linux.
pip install git+https://github.com/bigscience-workshop/petals

Installs the package published on PyPI directly β€” no need to clone the source.

brew install python

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
sudo docker run -p 31330:31330 --ipc host --gpus all --volume petals-cache:/cache --rm \

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install git+https://github.com/bigscience-workshop/petals

Installs the package published on PyPI directly β€” no need to clone the source.

python -m petals.cli.run_server meta-llama/Meta-Llama-3.1-405B-Instruct

Runs the Python script (or module).

python -m petals.cli.run_server --port 31330 meta-llama/Meta-Llama-3.1-405B-Instruct

Runs the Python script (or module).

python3 -m pip install git+https://github.com/bigscience-workshop/petals

Installs the Python libraries listed in requirements.txt (or similar).

python3 -m petals.cli.run_server meta-llama/Meta-Llama-3.1-405B-Instruct

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation