StreamDiffusion

(β˜… 10,802)

StreamDiffusion: A Pipeline-Level Solution for Real-Time Interactive Generation

  • .dockerignore
  • .gitignore
  • Dockerfile
  • LICENSE
  • pyproject.toml
  • README-ja.md
  • README-ko.md
  • README.md
  • setup.py

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/cumulo-autumn/StreamDiffusion

Downloads the entire project code from GitHub to your computer.

cd StreamDiffusion

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip3 install torch==2.1.0 torchvision==0.16.0 xformers --index-url https://download.pytorch.org/whl/cu118

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

pip3 install torch==2.1.0 torchvision==0.16.0 xformers --index-url https://download.pytorch.org/whl/cu121

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

pip install git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]

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

pip install streamdiffusion[tensorrt]

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 build -t stream-diffusion:latest -f Dockerfile .

Builds a runnable image based on the Dockerfile.

docker run --gpus all -it -v $(pwd):/home/ubuntu/streamdiffusion stream-diffusion:latest

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. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd demo/realtime-img2img/frontend

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. 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).

pip3 install torch==2.1.0 torchvision==0.16.0 xformers --index-url https://download.pytorch.org/whl/cu118

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

pip3 install torch==2.1.0 torchvision==0.16.0 xformers --index-url https://download.pytorch.org/whl/cu121

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

pip install git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]

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

pip install streamdiffusion[tensorrt]

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