1
0
mirror of https://github.com/huggingface/diffusers.git synced 2026-10-23 09:09:01 +03:00
Files
diffusers/docs/source/en/modular_diffusers/overview.md
YiYi Xu b800f828f3 [docs] FLUX.3: modular-only notes, lazy loading, callbacks (#15069)
* [docs] FLUX.3: modular-only notes, lazy loading, callbacks

Add a tips callout on what differs from DiffusionPipeline (lazy loading,
outputs, guider, offloading, editing blocks), move the prompting advice
into the upsampling section with the pop-the-step example, and add a
per-step callbacks section with a block that takes callback_on_step_end.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* [docs] FLUX.3: callback block walks all denoising loops

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* [docs] modular: add "Coming from DiffusionPipeline" to the quickstart and move per-step callbacks to the callbacks guide

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* [docs] FLUX.3: show the upsampled caption; clarify the index note in the quickstart

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* [docs] modular: make "Coming from DiffusionPipeline" its own page

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-16 13:34:11 -10:00

3.0 KiB

Overview

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

  • The quickstart shows you how to run a modular pipeline, understand its structure, and customize it by modifying the blocks that compose it.
  • Coming from DiffusionPipeline lists what works differently from a [DiffusionPipeline], for readers who know the standard pipelines.

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].
  • Building Custom Blocks shows you how to create your own custom blocks and share them on the Hub.

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.

Mellon Integration