Repository navigation
Description
Community Pipelines
As of diffusers==0.4.0, you can make use of Community Pipelines.
The goal with community pipelines is to have a community-driven offering of an exotic variety of features built on top of diffusers which is maintained by the community
How to use community pipelines
Load community pipelines passing the custom_pipeline argument to DiffusionPipeline, as one of the files in diffusers/examples/community.
pipe = DiffusionPipeline.from_pretrained("CompVis/stable-diffusion-v1-4", custom_pipeline="filename_in_the_community_folder")Contribute to the community pipelines by sending a PR with your own pipelines to diffusers/examples/community, we will merge them quickly.
Why community pipelines?
While the code of community pipelines will not be in official PyPI releases, the code is usable from the diffusers package >= 0.4.0. The reason community pipelines are not under the officially maintained pipelines but instead under the examples/community folder is:
- There is a vast amount of use cases that could be supported, but it's hard to figure out what's important enough to be maintained rigorously.
- Different opinions on the design philosophy of pipelines.
- We don't want to block the community from adding features they would like to add, but at the same time, we cannot take the burden of full maintenance upon ourselves.
So by providing community pipelines, we allow community members to contribute and share their work while having flexibility and development speed while making their work easily accessible to the rest of the ecosystem.
What pipelines to contribute?
Feel free to contribute with any pipeline that is exciting to you! If you want some ideas, we've compiled some ideas in different issues here, but you can do other pipelines as well! Some examples:
- 1. [Community Pipelines] SD v1-v4 compare #873
- 2. [Community Pipeline] Seed resize #875
- 3. [Community Pipeline] Composable Diffusion #876
- 4. [Community Pipeline] Checkpoint merging #877
- 5. [Community Pipeline] Speech to Image #871
- 6. [Community Pipeline] Wildcards #872
How to contribute to a community pipeline?
Let's make an example! Say you want to define a pipeline that just does a single forward pass to a U-Net and then calls a scheduler only once (Note, this doesn't make any sense from a scientific point of view, but only represents an example of how things work under the hood).
Cool! So you open your favorite IDE and start creating your pipeline 💻. First, what model weights and configurations do we need? We have a U-Net and a scheduler, so our pipeline should take a U-Net and a scheduler as an argument. Also, as stated above, you'd like to be able to load weights and the scheduler config for Hub and share your code with others, so we'll inherit from DiffusionPipeline:
from diffusers import DiffusionPipeline
import torch
class UnetSchedulerOneForwardPipeline(DiffusionPipeline):
def __init__(self, unet, scheduler):
super().__init__()Now, we must save the unet and scheduler in a config file so that you can save your pipeline with save_pretrained. Therefore, make sure you add every component that is save-able to the register_modules function:
from diffusers import DiffusionPipeline
import torch
class UnetSchedulerOneForwardPipeline(DiffusionPipeline):
def __init__(self, unet, scheduler):
super().__init__()
self.register_modules(unet=unet, scheduler=scheduler)Cool, the init is done! 🔥 Now, let's go into the forward pass, which we recommend defining as __call__ . Here you're given all the creative freedom there is. For our amazing "one-step" pipeline, we simply create a random image and call the unet once and the scheduler once:
from diffusers import DiffusionPipeline
import torch
class UnetSchedulerOneForwardPipeline(DiffusionPipeline):
def __init__(self, unet, scheduler):
super().__init__()
self.register_modules(unet=unet, scheduler=scheduler)
def __call__(self):
image = torch.randn(
(1, self.unet.in_channels, self.unet.sample_size, self.unet.sample_size),
)
timestep = 1
model_output = self.unet(image, timestep).sample
scheduler_output = self.scheduler.step(model_output, timestep, image).prev_sample
return scheduler_outputCool, that's it! 🚀 You can now run this pipeline by passing a unet and a scheduler to the init:
from diffusers import DDPMScheduler, Unet2DModel
scheduler = DDPMScheduler()
unet = UNet2DModel()
pipeline = UnetSchedulerOneForwardPipeline(unet=unet, scheduler=scheduler)
output = pipeline()But what's even better is that you can load pre-existing weights into the pipeline if they match exactly your pipeline structure. This is e.g. the case for https://huggingface.co/google/ddpm-cifar10-32 so that we can do the following:
pipeline = UnetSchedulerOneForwardPipeline.from_pretrained("google/ddpm-cifar10-32")
output = pipeline()We want to share this amazing pipeline with the community, so we would open a PR request to add the following code under one_step_unet.py to https://github.com/huggingface/diffusers/tree/main/examples/community .
from diffusers import DiffusionPipeline
import torch
class UnetSchedulerOneForwardPipeline(DiffusionPipeline):
def __init__(self, unet, scheduler):
super().__init__()
self.register_modules(unet=unet, scheduler=scheduler)
def __call__(self):
image = torch.randn(
(1, self.unet.in_channels, self.unet.sample_size, self.unet.sample_size),
)
timestep = 1
model_output = self.unet(image, timestep).sample
scheduler_output = self.scheduler.step(model_output, timestep, image).prev_sample
return scheduler_outputOur amazing pipeline got merged here: #840.
Now everybody that has diffusers >= 0.4.0 installed can use our pipeline magically 🪄 as follows:
from diffusers import DiffusionPipeline
pipe = DiffusionPipeline.from_pretrained("google/ddpm-cifar10-32", custom_pipeline="one_step_unet")
pipe()Another way to upload your custom_pipeline, besides sending a PR, is uploading the code that contains it to the Hugging Face Hub, as exemplified here.
Try it out now - it works!
In general, you will want to create much more sophisticated pipelines, so we recommend looking at existing pipelines here: https://github.com/huggingface/diffusers/tree/main/examples/community
IMPORTANT:
You can use whatever package you want in your community pipeline file - as long as the user has it installed, everything will work fine. Make sure you have one and only one pipeline class that inherits from DiffusionPipeline as this will be automatically detected.
How do community pipelines work?
A community pipeline is a class that has to inherit from DiffusionPipeline: https://huggingface.co/docs/diffusers/api/diffusion_pipeline#diffusers.DiffusionPipeline and that has been added to https://github.com/huggingface/diffusers/tree/main/examples/community.
The community can load the pipeline code via the custom_pipeline argument from DiffusionPipeline. See docs here: https://huggingface.co/docs/diffusers/api/diffusion_pipeline#diffusers.DiffusionPipelinehttps://huggingface.co/docs/diffusers/api/diffusion_pipeline#diffusers.DiffusionPipeline.from_pretrained.custom_pipeline
This means:
- The model weights and configs of the pipeline should be loaded from the
pretrained_model_name_or_pathargument: https://huggingface.co/docs/diffusers/api/diffusion_pipeline#diffusers.DiffusionPipeline.from_pretrained.pretrained_model_name_or_path whereas the code that powers the community pipeline is defined in a file added in https://github.com/huggingface/diffusers/tree/main/examples/community
Now, it might very well be that only some of your pipeline components weights can be downloaded from an official repo. The other components should then be passed directly to init as is the case for the ClIP guidance notebook here)
The magic behind all of this is that we load the code directly from GitHub. You can check it out in more detail if you follow the functionality defined here:
diffusers/src/diffusers/pipeline_utils.py
Line 405 in d3eb3b3
| pipeline_class = get_class_from_dynamic_module( |
diffusers packages.
Activity
[-][Community Pipelines] - How do they work?[/-][+][Community Pipelines][/+]WASasquatch commentedon Oct 17, 2022
So there is no init image support or mask support in
DiffusionPipeline()? I don't see it referenced. What is the point of these community pipelines, exactly?patrickvonplaten commentedon Oct 17, 2022
Hey @WASasquatch,
Sorry I don't really understand your question here - what does
init_imagehave to do with community pipelines? The point of community pipeline is explained under Why community pipelines? in the section above.WASasquatch commentedon Oct 18, 2022
Hey @patrickvonplaten ,
I'm just curious why the
DiffusionPipelinemethod doesn't have init image or inpainting support or does it? So when something like CLIP Guided Stable Diffusion is released, as cool as it is, is limited to just txt2img?From a "community examples" perspective, coming across this, I wonder; "how do I make this work in a typical diffusers workflow?", using img2img and inpainting refinement and experimentation, not just a txt2img which I feel more a demo or starting point in a lot of techniques (if not starting with an init image)
WASasquatch commentedon Oct 19, 2022
Looking at all these pipelines. Things are quickly falling apart, imo. Pipelines doing one little thing, and then its own pipeline to manage, is horribly counter-productive. This is falling back to the fundamental issue with diffusers itself, and needing manage tons of pipes in code just to take on certain tasks (like img2img, inpainting), and now what about, clip guided diffusion (still limited to just text2img), or wildcard pipeline being worked on just for wildcards and again, based on limited DiffusionPipeline.
The idea behind community pipelines does not seem flushed. If this was a modular plugin idea, where a pipeline could have plugins that add functionality, it would to make far more sense.
None of this seems to think of the end developers/users and how this is implemented in an efficient, and minimal API philosophy. Give it a couple months, and in order to use all the cool things community pipelines has to offer, you'll have a script 10x the size it needs to be just to implement all these pipes, put in the logic to use the right pipes for the right tasks, etc, etc, essentially building your own API, off an API, to do something...
Like you released the mega community pipeline, which is still kinda useless. It's just a community pipeline which conveniently has img2img and inpainting, but is incompatible with the features one may want, like CLIP Guided Diffusion not being limited to just text2img because it is its own pipe. So what is the point in Mega if it's not useful for any of this?
juancopi81 commentedon Oct 21, 2022
Hey @patrickvonplaten,
Sorry if it already exists. I did not find it. I was wondering: How would you like a pipeline with multilingual support? Something like:
patrickvonplaten commentedon Oct 24, 2022
Great idea! We could/should definitely add such a pipeline :-)
juancopi81 commentedon Oct 24, 2022
@patrickvonplaten, great! I could give it a try if it is ok...
bglick13 commentedon Oct 26, 2022
I recently developed a community pipeline and found it a bit awkward to develop and test before it gets pulled into main.
I think the issue is with how
from_pretrainedfetches the pipeline file.If you provide just the pipeline file name, like the documentation suggests, behind the scenes it seems to look for that file on githubcontent on the main branch, which won't work during development.
If you pass your hub repo name, it looks for a
pipeline.pyfile in your repo. This works, but it doesn't seem to download/cache themodel_index.jsonfile, which is also required. This means if you try to run your pipeline a second time, it will fail. If I delete my cache and rerun, it works again.I'm sure my problems were mostly self-inflicted, but I didn't see an obviously better workflow. Is there a suggested workflow for developing community pipelines?
vvvm23 commentedon Nov 3, 2022
I had the same experience developing my own. There doesn't seem to be a way to specify using a local pipeline file. This is definitely something that could be useful - not just for development!
patrickvonplaten commentedon Nov 4, 2022
True it'd make sense to allow this! Could you maybe open a seperate issue for it? I'll try to have a look into it soon :-)
6 remaining items
patrickvonplaten commentedon Nov 17, 2022
Loading custom pipeline should now be much easier - sorry for being so late here. #1327 should be merged today! cc @bglick13
bglick13 commentedon Nov 17, 2022
Wow that's awesome - thanks for being so quick on that!
teticio commentedon Nov 18, 2022
Hi @patrickvonplaten, the PR is ready to go here #1334, for when you have a chance to look at it.
patrickvonplaten commentedon Nov 20, 2022
Very cool, just reviewed it :-)
RELNO commentedon Dec 27, 2022
Hi @patrickvonplaten, thanks for this great guide. I wonder if it make sense to allow loading custom pipelines (CP) not as a filename
stronly, but also by passing an instance of the CP class, i.e:A use case for that would be a notebook where one can both write a CP class and test it in stiu.
(I'm referring to this line in utils)
patrickvonplaten commentedon Jan 3, 2023
Hey @RELNO,
Wouldn't:
make more sense then? Think this should work :-)
Wei-Lin-Intel commentedon Apr 1, 2023
Hi Diffuser Pipeline Community @patrickvonplaten,
Recently our Intel PyTorch extension IPEX has enabled the Flash Attention which can significantly speedup the inference of Stable-Diffusion on CPU with BF16 precision. Since it requires to run torch.jit.trace on UNet and an additional installation of IPEX, I wonder if there is any chance that we can contribute to the Pipeline to accelerate S-D inference on CPU? I am not sure adding the above steps to the Pipeline is allowed or not.
Thanks!
patrickvonplaten commentedon Apr 4, 2023
Hey @Wei-Lin-Intel,
Feel free to add a community pipeline :-)
See: https://github.com/huggingface/diffusers/blob/main/CONTRIBUTING.md#6-contribute-a-community-pipeline
yingjie-han commentedon Apr 24, 2023
charchit7 commentedon Dec 12, 2023
Hey @patrickvonplaten when opening the link you have used above
As of diffusers==0.4.0, you can make use of [Community Pipelines](https://huggingface.co/docs/diffusers/using-diffusers/custom_pipelines).It gives an error
The documentation page USING-DIFFUSERS/CUSTOM_PIPELINES doesn’t exist in v0.24.0, but exists on the main version. Click [here](https://huggingface.co/docs/diffusers/main/en/using-diffusers/custom_pipelines) to redirect to the main version of the documentation.EntroSanity commentedon Mar 11, 2024
Hey @patrickvonplaten I'm trying to incorporate a custom pipeline named lpw-stable-diffusion_xl into my application. I've noticed that the following snippet does not produce the desired outcome:
StableDiffusionPipeline.from_single_file(_path_to_my_safetensor, torch_dtype=torch.float16, custom_pipeline='lpw-stable-diffusion_xl')In my search for a workaround, I stumbled upon a method that seems promising. However, I'm facing a challenge with specifying the correct argument for the first parameter in the
from_pretrainedfunction. Given that all my models are stored locally in safetensor format, attempting to use a path directly to the safetensor leads to a ValueError, indicating the path is incorrect. Could anyone offer advice or a more effective approach for this?StableDiffusionXLPipeline.from_pretrained(_repo_id_, torch_dtype=torch.float16, use_safetensors=True, variant="fp16", custom_pipeline="lpw_stable_diffusion_xl")asomoza commentedon Jan 9, 2026
closing as we now don't require an issue for contributors to add community pipelines.