Skip to content

[docs] Modular diffusers #11931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Aug 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions docs/source/en/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,22 +112,24 @@
sections:
- local: modular_diffusers/overview
title: Overview
- local: modular_diffusers/modular_pipeline
title: Modular Pipeline
- local: modular_diffusers/components_manager
title: Components Manager
- local: modular_diffusers/quickstart
title: Quickstart
- local: modular_diffusers/modular_diffusers_states
title: Modular Diffusers States
title: States
- local: modular_diffusers/pipeline_block
title: Pipeline Block
title: ModularPipelineBlocks
- local: modular_diffusers/sequential_pipeline_blocks
title: Sequential Pipeline Blocks
title: SequentialPipelineBlocks
- local: modular_diffusers/loop_sequential_pipeline_blocks
title: Loop Sequential Pipeline Blocks
title: LoopSequentialPipelineBlocks
- local: modular_diffusers/auto_pipeline_blocks
title: Auto Pipeline Blocks
- local: modular_diffusers/end_to_end_guide
title: End-to-End Example
title: AutoPipelineBlocks
- local: modular_diffusers/modular_pipeline
title: ModularPipeline
- local: modular_diffusers/components_manager
title: ComponentsManager
- local: modular_diffusers/guiders
title: Guiders

- title: Training
isExpanded: false
Expand Down Expand Up @@ -282,6 +284,18 @@
title: Outputs
- local: api/quantization
title: Quantization
- title: Modular
sections:
- local: api/modular_diffusers/pipeline
title: Pipeline
- local: api/modular_diffusers/pipeline_blocks
title: Blocks
- local: api/modular_diffusers/pipeline_states
title: States
- local: api/modular_diffusers/pipeline_components
title: Components and configs
- local: api/modular_diffusers/guiders
title: Guiders
- title: Loaders
sections:
- local: api/loaders/ip_adapter
Expand Down
39 changes: 39 additions & 0 deletions docs/source/en/api/modular_diffusers/guiders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Guiders

Guiders are components in Modular Diffusers that control how the diffusion process is guided during generation. They implement various guidance techniques to improve generation quality and control.

## BaseGuidance

[[autodoc]] diffusers.guiders.guider_utils.BaseGuidance

## ClassifierFreeGuidance

[[autodoc]] diffusers.guiders.classifier_free_guidance.ClassifierFreeGuidance

## ClassifierFreeZeroStarGuidance

[[autodoc]] diffusers.guiders.classifier_free_zero_star_guidance.ClassifierFreeZeroStarGuidance

## SkipLayerGuidance

[[autodoc]] diffusers.guiders.skip_layer_guidance.SkipLayerGuidance

## SmoothedEnergyGuidance

[[autodoc]] diffusers.guiders.smoothed_energy_guidance.SmoothedEnergyGuidance

## PerturbedAttentionGuidance

[[autodoc]] diffusers.guiders.perturbed_attention_guidance.PerturbedAttentionGuidance

## AdaptiveProjectedGuidance

[[autodoc]] diffusers.guiders.adaptive_projected_guidance.AdaptiveProjectedGuidance

## AutoGuidance

[[autodoc]] diffusers.guiders.auto_guidance.AutoGuidance

## TangentialClassifierFreeGuidance

[[autodoc]] diffusers.guiders.tangential_classifier_free_guidance.TangentialClassifierFreeGuidance
5 changes: 5 additions & 0 deletions docs/source/en/api/modular_diffusers/pipeline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Pipeline

## ModularPipeline

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.ModularPipeline
17 changes: 17 additions & 0 deletions docs/source/en/api/modular_diffusers/pipeline_blocks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Pipeline blocks

## ModularPipelineBlocks

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.ModularPipelineBlocks

## SequentialPipelineBlocks

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.SequentialPipelineBlocks

## LoopSequentialPipelineBlocks

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.LoopSequentialPipelineBlocks

## AutoPipelineBlocks

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.AutoPipelineBlocks
17 changes: 17 additions & 0 deletions docs/source/en/api/modular_diffusers/pipeline_components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Components and configs

## ComponentSpec

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.ComponentSpec

## ConfigSpec

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.ConfigSpec

## ComponentsManager

[[autodoc]] diffusers.modular_pipelines.components_manager.ComponentsManager

## InsertableDict

[[autodoc]] diffusers.modular_pipelines.modular_pipeline_utils.InsertableDict
9 changes: 9 additions & 0 deletions docs/source/en/api/modular_diffusers/pipeline_states.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Pipeline states

## PipelineState

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.PipelineState

## BlockState

[[autodoc]] diffusers.modular_pipelines.modular_pipeline.BlockState
Loading