OpenDiloco

(β˜… 590)

OpenDiLoCo: An Open-Source Framework for Globally Distributed Low-Communication Training

  • .dockerignore
  • .gitignore
  • .gitmodules
  • .pre-commit-config.yaml
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE
  • pyproject.toml
  • README.md
  • requirements-dev.txt
  • requirements.txt

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/PrimeIntellect-ai/OpenDiloco

Downloads the entire project code from GitHub to your computer.

cd OpenDiloco

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install .

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

pip install --pre torchdata --index-url https://download.pytorch.org/whl/nightly/cpu

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

pip install flash-attn>=2.5.8

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

βœ… 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.
docker pull primeintellect/open_diloco:main

Type this command into your terminal and run it.

docker run -d --name open-diloco --ipc=host --network=host --gpus=all primeintellect/open_diloco:main

Runs the built image as an actual container.

docker exec -it open-diloco bash

Type this command into your terminal and run it.

βœ… 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.
python -m venv .venv

Runs the Python script (or module).

pip install .

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

pip install --pre torchdata --index-url https://download.pytorch.org/whl/nightly/cpu

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

pip install flash-attn>=2.5.8

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

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

Pulled directly from this repo's README.

// repository documentation