mirror of
https://github.com/huggingface/diffusers.git
synced 2026-02-11 21:35:18 +08:00
6d4fc6baa0
* add metadata field to input/output param * refactor mellonparam: move the template outside, add metaclass, define some generic template for custom node * add from_custom_block * style * up up fix * add mellon guide * add to toctree * style * add mellon_types * style * mellon_type -> inpnt_types + output_types * update doc * add quant info to components manager * fix more * up up * fix components manager * update custom block guide * update * style * add a warn for mellon and add new guides to overview * Apply suggestions from code review Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/modular_diffusers/mellon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * more update on custom block guide * Update docs/source/en/modular_diffusers/mellon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * a few mamual * apply suggestion: turn into bullets * support define mellon meta with MellonParam directly, and update doc * add the video --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: yiyi@huggingface.co <yiyi@ip-26-0-160-103.ec2.internal>
2.9 KiB
2.9 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]. - 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
- Using Custom Blocks with Mellon shows you how to make your custom blocks work with Mellon, a visual node-based interface for building workflows.