Documentation#

Developer guides

Guides that teach you how to understand, extend, and build on FlashDreams, combining conceptual explanation with worked code examples.

Developer Guides
CLI and API Reference

Complete reference for the flashdreams-run CLI, the core runtime, the infrastructure layer, the pipelines and runners, and the serving components.

CLI and API Reference
Troubleshooting

Common first-run failures (e.g. CUDA build mismatches, disk and cache limits, Hugging Face authentication, GPU memory) each with the likely cause and the next step to try.

Troubleshooting

Where to start#

New to FlashDreams? Start with Get Started to go from a fresh checkout to a running model. From there, read the developer guides for the conceptual model, reach for the CLI and API reference when you need exact symbols and flags, and check Troubleshooting when a first run fails.