Installation

Choose the setup path that matches your goal.

Use FlashDreams as a library

Install from PyPI:

pip install flashdreams

Install the latest main branch:

pip install "git+https://github.com/NVIDIA/flashdreams.git"

Run models directly in this codebase

We recommend to use the uv python package manager (installation instructions here). With uv installed, clone the repository and use the workspace environment:

git clone https://github.com/NVIDIA/flashdreams.git
cd flashdreams
uv sync --extra dev --extra runners

The unified runner CLI is available through uv run:

uv run flashdreams-run --help

Environment variables

Most model runs need Hugging Face authentication:

export HF_TOKEN=<your-hf-token>
export HF_HOME=~/.cache/huggingface  # optional

For more environment and container details, see the project README and the model pages under Models.