mirror of
https://github.com/huggingface/diffusers.git
synced 2026-02-28 05:40:40 +08:00
* add a real quick start guide * Update docs/source/en/modular_diffusers/quickstart.md * update a bit more * fix * Apply suggestions from code review Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/modular_diffusers/quickstart.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/modular_diffusers/quickstart.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * update more * Apply suggestions from code review Co-authored-by: Sayak Paul <spsayakpaul@gmail.com> * address more feedbacks: move components amnager earlier, explain blocks vs sub-blocks etc * more * remove the link to mellon guide, not exist in this PR yet --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: Sayak Paul <spsayakpaul@gmail.com>
2.5 KiB
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
- The quickstart shows you how to run a modular pipeline, understand its structure, and customize it by modifying the blocks that compose it.
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.