Files
diffusers/docs/source/en/modular_diffusers/overview.md
Steven Liu 38740ddbd8
Some checks are pending
Build documentation / build (push) Waiting to run
Run dependency tests / check_dependencies (push) Waiting to run
Run Flax dependency tests / check_flax_dependencies (push) Waiting to run
Run Torch dependency tests / check_torch_dependencies (push) Waiting to run
Fast GPU Tests on main / Setup Torch Pipelines CUDA Slow Tests Matrix (push) Waiting to run
Fast GPU Tests on main / Torch Pipelines CUDA Tests (push) Blocked by required conditions
Fast GPU Tests on main / Torch CUDA Tests (lora) (push) Waiting to run
Fast GPU Tests on main / Torch CUDA Tests (models) (push) Waiting to run
Fast GPU Tests on main / Torch CUDA Tests (others) (push) Waiting to run
Fast GPU Tests on main / Torch CUDA Tests (schedulers) (push) Waiting to run
Fast GPU Tests on main / Torch CUDA Tests (single_file) (push) Waiting to run
Fast GPU Tests on main / PyTorch Compile CUDA tests (push) Waiting to run
Fast GPU Tests on main / PyTorch xformers CUDA tests (push) Waiting to run
Fast GPU Tests on main / Examples PyTorch CUDA tests on Ubuntu (push) Waiting to run
Fast tests on main / ${{ matrix.config.name }} (map[framework:pytorch image:diffusers/diffusers-pytorch-cpu name:Fast PyTorch CPU tests on Ubuntu report:torch_cpu runner:aws-general-8-plus]) (push) Waiting to run
Fast tests on main / ${{ matrix.config.name }} (map[framework:pytorch_examples image:diffusers/diffusers-pytorch-cpu name:PyTorch Example CPU tests on Ubuntu report:torch_example_cpu runner:aws-general-8-plus]) (push) Waiting to run
Secret Leaks / trufflehog (push) Waiting to run
Update Diffusers metadata / update_metadata (push) Waiting to run
[docs] Modular diffusers (#11931)
* start

* draft

* state, pipelineblock, apis

* sequential

* fix links

* new

* loop, auto

* fix

* pipeline

* guiders

* components manager

* reviews

* update

* update

* update

---------

Co-authored-by: DN6 <dhruv.nair@gmail.com>
2025-08-12 18:50:20 +05:30

2.5 KiB

Overview

Warning

Modular Diffusers is under active development and it's API may change.

Modular Diffusers is a unified pipeline system that simplifies your workflow with pipeline blocks.

  • Blocks are reusable and you only need to create new blocks that are unique to your pipeline.
  • Blocks can be mixed and matched to adapt to or create a pipeline for a specific workflow or multiple workflows.

The Modular Diffusers docs are organized as shown below.

Quickstart

  • A quickstart demonstrating how to implement an example workflow with Modular Diffusers.

ModularPipelineBlocks

  • States explains how data is shared and communicated between blocks and [ModularPipeline].
  • ModularPipelineBlocks is the most basic unit of a [ModularPipeline] and this guide shows you how to create one.
  • SequentialPipelineBlocks is a type of block that chains multiple blocks so they run one after another, passing data along the chain. This guide shows you how to create [~modular_pipelines.SequentialPipelineBlocks] and how they connect and work together.
  • LoopSequentialPipelineBlocks is a type of block that runs a series of blocks in a loop. This guide shows you how to create [~modular_pipelines.LoopSequentialPipelineBlocks].
  • AutoPipelineBlocks is a type of block that automatically chooses which blocks to run based on the input. This guide shows you how to create [~modular_pipelines.AutoPipelineBlocks].

ModularPipeline

  • ModularPipeline shows you how to create and convert pipeline blocks into an executable [ModularPipeline].
  • ComponentsManager shows you how to manage and reuse components across multiple pipelines.
  • Guiders shows you how to use different guidance methods in the pipeline.