diffusers 0.38.0
pip install diffusers
Released:
State-of-the-art diffusion in PyTorch and JAX.
Navigation
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
๐ Avatar for DN6 from gravatar.comDN6 ๐ Avatar for lysandre from gravatar.com
lysandre ๐ Avatar for spsayakpaul from gravatar.com
spsayakpaul ๐ Avatar for yiyixu from gravatar.com
yiyixu
Unverified details
These details have not been verified by PyPIMeta
- License: Apache Software License (Apache 2.0 License)
- Author: The Hugging Face team (past and future) with the help of all our contributors (https://github.com/huggingface/diffusers/graphs/contributors)
- Tags deep , learning , diffusion , jax , pytorch , stable , diffusion , audioldm
- Requires: Python >=3.10.0
-
Provides-Extra:
quality,docs,training,test,torch,bitsandbytes,gguf,optimum-quanto,torchao,nvidia-modelopt,flashpack,flax,dev
Classifiers
- Development Status
- Intended Audience
- License
- Operating System
- Programming Language
- Topic
Project description
๐ GitHub
๐ GitHub release
๐ GitHub release
๐ Contributor Covenant
๐ X account
๐ค Diffusers is the go-to library for state-of-the-art pretrained diffusion models for generating images, audio, and even 3D structures of molecules. Whether you're looking for a simple inference solution or training your own diffusion models, ๐ค Diffusers is a modular toolbox that supports both. Our library is designed with a focus on usability over performance, simple over easy, and customizability over abstractions.
๐ค Diffusers offers three core components:
- State-of-the-art diffusion pipelines that can be run in inference with just a few lines of code.
- Interchangeable noise schedulers for different diffusion speeds and output quality.
- Pretrained models that can be used as building blocks, and combined with schedulers, for creating your own end-to-end diffusion systems.
Installation
We recommend installing ๐ค Diffusers in a virtual environment from PyPI or Conda. For more details about installing PyTorch, please refer to their official documentation.
PyTorch
With pip (official package):
pipinstall--upgradediffusers[torch]
With conda (maintained by the community):
condainstall-cconda-forgediffusers
Apple Silicon (M1/M2) support
Please refer to the How to use Stable Diffusion in Apple Silicon guide.
Quickstart
Generating outputs is super easy with ๐ค Diffusers. To generate an image from text, use the from_pretrained method to load any pretrained diffusion model (browse the Hub for 30,000+ checkpoints):
fromdiffusersimport DiffusionPipeline importtorch pipeline = DiffusionPipeline.from_pretrained("stable-diffusion-v1-5/stable-diffusion-v1-5", torch_dtype=torch.float16) pipeline.to("cuda") pipeline("An image of a squirrel in Picasso style").images[0]
You can also dig into the models and schedulers toolbox to build your own diffusion system:
fromdiffusersimport DDPMScheduler, UNet2DModel fromPILimport Image importtorch scheduler = DDPMScheduler.from_pretrained("google/ddpm-cat-256") model = UNet2DModel.from_pretrained("google/ddpm-cat-256").to("cuda") scheduler.set_timesteps(50) sample_size = model.config.sample_size noise = torch.randn((1, 3, sample_size, sample_size), device="cuda") input = noise for t in scheduler.timesteps: with torch.no_grad(): noisy_residual = model(input, t).sample prev_noisy_sample = scheduler.step(noisy_residual, t, input).prev_sample input = prev_noisy_sample image = (input / 2 + 0.5).clamp(0, 1) image = image.cpu().permute(0, 2, 3, 1).numpy()[0] image = Image.fromarray((image * 255).round().astype("uint8")) image
Check out the Quickstart to launch your diffusion journey today!
How to navigate the documentation
| Documentation | What can I learn? |
|---|---|
| Tutorial | A basic crash course for learning how to use the library's most important features like using models and schedulers to build your own diffusion system, and training your own diffusion model. |
| Loading | Guides for how to load and configure all the components (pipelines, models, and schedulers) of the library, as well as how to use different schedulers. |
| Pipelines for inference | Guides for how to use pipelines for different inference tasks, batched generation, controlling generated outputs and randomness, and how to contribute a pipeline to the library. |
| Optimization | Guides for how to optimize your diffusion model to run faster and consume less memory. |
| Training | Guides for how to train a diffusion model for different tasks with different training techniques. |
Contribution
We โค๏ธ contributions from the open-source community! If you want to contribute to this library, please check out our Contribution guide. You can look out for issues you'd like to tackle to contribute to the library.
- See Good first issues for general opportunities to contribute
- See New model/pipeline to contribute exciting new diffusion models / diffusion pipelines
- See New scheduler
Also, say ๐ in our public Discord channel ๐ Join us on Discord
. We discuss the hottest trends about diffusion models, help each other with contributions, personal projects or just hang out โ.
Popular Tasks & Pipelines
| Task | Pipeline | ๐ค Hub |
|---|---|---|
| Unconditional Image Generation | DDPM | google/ddpm-ema-church-256 |
| Text-to-Image | Stable Diffusion Text-to-Image | stable-diffusion-v1-5/stable-diffusion-v1-5 |
| Text-to-Image | unCLIP | kakaobrain/karlo-v1-alpha |
| Text-to-Image | DeepFloyd IF | DeepFloyd/IF-I-XL-v1.0 |
| Text-to-Image | Kandinsky | kandinsky-community/kandinsky-2-2-decoder |
| Text-guided Image-to-Image | ControlNet | lllyasviel/sd-controlnet-canny |
| Text-guided Image-to-Image | InstructPix2Pix | timbrooks/instruct-pix2pix |
| Text-guided Image-to-Image | Stable Diffusion Image-to-Image | stable-diffusion-v1-5/stable-diffusion-v1-5 |
| Text-guided Image Inpainting | Stable Diffusion Inpainting | stable-diffusion-v1-5/stable-diffusion-inpainting |
| Image Variation | Stable Diffusion Image Variation | lambdalabs/sd-image-variations-diffusers |
| Super Resolution | Stable Diffusion Upscale | stabilityai/stable-diffusion-x4-upscaler |
| Super Resolution | Stable Diffusion Latent Upscale | stabilityai/sd-x2-latent-upscaler |
Popular libraries using ๐งจ Diffusers
- https://github.com/microsoft/TaskMatrix
- https://github.com/invoke-ai/InvokeAI
- https://github.com/InstantID/InstantID
- https://github.com/apple/ml-stable-diffusion
- https://github.com/Sanster/lama-cleaner
- https://github.com/IDEA-Research/Grounded-Segment-Anything
- https://github.com/ashawkey/stable-dreamfusion
- https://github.com/deep-floyd/IF
- https://github.com/bentoml/BentoML
- https://github.com/bmaltais/kohya_ss
- +14,000 other amazing GitHub repositories ๐ช
Thank you for using us โค๏ธ.
Credits
This library concretizes previous work by many different authors and would not have been possible without their great research and implementations. We'd like to thank, in particular, the following implementations which have helped us in our development and without which the API could not have been as polished today:
- @CompVis' latent diffusion models library, available here
- @hojonathanho original DDPM implementation, available here as well as the extremely useful translation into PyTorch by @pesser, available here
- @ermongroup's DDIM implementation, available here
- @yang-song's Score-VE and Score-VP implementations, available here
We also want to thank @heejkoo for the very helpful overview of papers, code and resources on diffusion models, available here as well as @crowsonkb and @rromb for useful discussions and insights.
Citation
@misc{von-platen-etal-2022-diffusers, author={Patrick von Platen and Suraj Patil and Anton Lozhkov and Pedro Cuenca and Nathan Lambert and Kashif Rasul and Mishig Davaadorj and Dhruv Nair and Sayak Paul and William Berman and Yiyi Xu and Steven Liu and Thomas Wolf}, title={Diffusers: State-of-the-art diffusion models}, year={2022}, publisher={GitHub}, journal={GitHub repository}, howpublished={\url{https://github.com/huggingface/diffusers}} }
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
๐ Avatar for DN6 from gravatar.comDN6 ๐ Avatar for lysandre from gravatar.com
lysandre ๐ Avatar for spsayakpaul from gravatar.com
spsayakpaul ๐ Avatar for yiyixu from gravatar.com
yiyixu
Unverified details
These details have not been verified by PyPIMeta
- License: Apache Software License (Apache 2.0 License)
- Author: The Hugging Face team (past and future) with the help of all our contributors (https://github.com/huggingface/diffusers/graphs/contributors)
- Tags deep , learning , diffusion , jax , pytorch , stable , diffusion , audioldm
- Requires: Python >=3.10.0
-
Provides-Extra:
quality,docs,training,test,torch,bitsandbytes,gguf,optimum-quanto,torchao,nvidia-modelopt,flashpack,flax,dev
Classifiers
- Development Status
- Intended Audience
- License
- Operating System
- Programming Language
- Topic
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file diffusers-0.38.0.tar.gz.
File metadata
- Download URL: diffusers-0.38.0.tar.gz
- Upload date:
- Size: 4.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1e094ec5c16f18c42fb89d37f07a94cf9aab3ebbe527ab059c609597b8857626
|
|
| MD5 |
e1f15bfdeff1a2ebf6597542df29b1e6
|
|
| BLAKE2b-256 |
01ed255d3dfd4a2271dffc8f1895f9d2720b3bf1beaecf02148bb5604439e594
|
Provenance
The following attestation bundles were made for diffusers-0.38.0.tar.gz:
Publisher:
pypi_publish.yaml on huggingface/diffusers
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
diffusers-0.38.0.tar.gz -
Subject digest:
1e094ec5c16f18c42fb89d37f07a94cf9aab3ebbe527ab059c609597b8857626 - Sigstore transparency entry: 1417226415
- Sigstore integration time:
-
Permalink:
huggingface/diffusers@275869dcae4ebcfee6a80253fdabc56033335020 -
Branch / Tag:
refs/tags/v0.38.0 - Owner: https://github.com/huggingface
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi_publish.yaml@275869dcae4ebcfee6a80253fdabc56033335020 -
Trigger Event:
push
-
Statement type:
File details
Details for the file diffusers-0.38.0-py3-none-any.whl.
File metadata
- Download URL: diffusers-0.38.0-py3-none-any.whl
- Upload date:
- Size: 5.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
18e53f9e539096320470f62c6360a6fd5727ff28cffda566265316e13fcdb612
|
|
| MD5 |
1cc80c28052b3ecdc410979e67df49e2
|
|
| BLAKE2b-256 |
42c03237566ea6e3a542f3c0669a253d62fe75f27b84b3d7bd4fb3b5ee89d73c
|
Provenance
The following attestation bundles were made for diffusers-0.38.0-py3-none-any.whl:
Publisher:
pypi_publish.yaml on huggingface/diffusers
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
diffusers-0.38.0-py3-none-any.whl -
Subject digest:
18e53f9e539096320470f62c6360a6fd5727ff28cffda566265316e13fcdb612 - Sigstore transparency entry: 1417226418
- Sigstore integration time:
-
Permalink:
huggingface/diffusers@275869dcae4ebcfee6a80253fdabc56033335020 -
Branch / Tag:
refs/tags/v0.38.0 - Owner: https://github.com/huggingface
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi_publish.yaml@275869dcae4ebcfee6a80253fdabc56033335020 -
Trigger Event:
push
-
Statement type:
