Skip to content

Commit 702f3ac

Browse files
committed
start
1 parent b73c738 commit 702f3ac

File tree

3 files changed

+26
-22
lines changed

3 files changed

+26
-22
lines changed

docs/source/en/_toctree.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@
9696
- sections:
9797
- local: modular_diffusers/overview
9898
title: Overview
99+
- local: modular_diffusers/end_to_end_guide
100+
title: Quickstart
99101
- local: modular_diffusers/modular_pipeline
100102
title: Modular Pipeline
101103
- local: modular_diffusers/components_manager
@@ -110,8 +112,6 @@
110112
title: Loop Sequential Pipeline Blocks
111113
- local: modular_diffusers/auto_pipeline_blocks
112114
title: Auto Pipeline Blocks
113-
- local: modular_diffusers/end_to_end_guide
114-
title: End-to-End Example
115115
title: Modular Diffusers
116116
- sections:
117117
- local: using-diffusers/consisid

docs/source/en/modular_diffusers/overview.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,31 @@ an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express o
1010
specific language governing permissions and limitations under the License.
1111
-->
1212

13-
# Getting Started with Modular Diffusers
13+
# Overview
1414

15-
<Tip warning={true}>
15+
> [!WARNING]
16+
> ⚠︎ Modular Diffusers is still under active development and it's API may change.
1617
17-
🧪 **Experimental Feature**: Modular Diffusers is an experimental feature we are actively developing. The API may be subject to breaking changes.
18+
Modular Diffusers is a unified pipeline system that simplifies your workflow with *pipeline blocks*.
1819

19-
</Tip>
20+
- Blocks are reusable and you only create new blocks that are unique to your pipeline.
21+
- Blocks can be mixed and matched to adapt to or create a pipeline for a specific workflow or multiple workflows.
2022

21-
With Modular Diffusers, we introduce a unified pipeline system that simplifies how you work with diffusion models. Instead of creating separate pipelines for each task, Modular Diffusers lets you:
23+
The Modular Diffusers docs are organized as shown below.
2224

23-
**Write Only What's New**: You won't need to write an entire pipeline from scratch every time you have a new use case. You can create pipeline blocks just for your new workflow's unique aspects and reuse existing blocks for existing functionalities.
25+
## Quickstart
2426

25-
**Assemble Like LEGO®**: You can mix and match between blocks in flexible ways. This allows you to write dedicated blocks unique to specific workflows, and then assemble different blocks into a pipeline that can be used more conveniently for multiple workflows.
27+
- A [quickstart](./end_to_end_guide) start for implementing an example workflow with Modular Diffusers.
2628

29+
## ModularPipeline
2730

28-
Here's how our guides are organized to help you navigate the Modular Diffusers documentation:
31+
- [ModularPipeline](./modular_pipeline) shows you how to build with pipeline blocks and convert them into an executable [`ModularPipeline`].
32+
- [ComponentsManager](./components_manager) shows you how to manage and reuse components across multiple pipelines.
2933

30-
### 🚀 Running Pipelines
31-
- **[Modular Pipeline Guide](./modular_pipeline.md)** - How to use predefined blocks to build a pipeline and run it
32-
- **[Components Manager Guide](./components_manager.md)** - How to manage and reuse components across multiple pipelines
34+
## ModularPipelineBlocks
3335

34-
### 📚 Creating PipelineBlocks
35-
- **[Pipeline and Block States](./modular_diffusers_states.md)** - Understanding PipelineState and BlockState
36-
- **[Pipeline Block](./pipeline_block.md)** - How to write custom PipelineBlocks
37-
- **[SequentialPipelineBlocks](sequential_pipeline_blocks.md)** - Connecting blocks in sequence
38-
- **[LoopSequentialPipelineBlocks](./loop_sequential_pipeline_blocks.md)** - Creating iterative workflows
39-
- **[AutoPipelineBlocks](./auto_pipeline_blocks.md)** - Conditional block selection
40-
41-
### 🎯 Practical Examples
42-
- **[End-to-End Example](./end_to_end_guide.md)** - Complete end-to-end examples including sharing your workflow in huggingface hub and deplying UI nodes
36+
- [States](./modular_diffusers_states) explains how data is shared and communicated between pipeline blocks and [`ModularPipeline`].
37+
- [PipelineBlock](./pipeline_block) is the most basic unit of a [`ModularPipeline`] and this guide shows you how to create one.
38+
- [SequentialPipelineBlocks](./sequential_pipeline_blocks) 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 [`SequentialPipelineBlocks`] and how they connect and work together.
39+
- [LoopSequentialPipelineBlocks](./loop_sequential_pipeline_blocks) is a type of block that runs a series of blocks in a loop. This guide shows you how to create [`LoopSequentialPipelineBlocks`].
40+
- [AutoPipelineBlocks](./auto_pipeline_blocks) is a type of block that automatically chooses which blocks to run based on the input. This guide shows you how to create [`AutoPipelineBlocks`].

src/diffusers/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@
6161
"is_unidecode_available",
6262
"logging",
6363
],
64+
"image_processor": [
65+
"VaeImageProcessor",
66+
],
67+
"video_processor": [
68+
"VideoProcessor",
69+
],
6470
}
6571

6672
try:

0 commit comments

Comments
 (0)