diffusers 0.23.1__py3-none-any.whl → 0.25.0__py3-none-any.whl

diffusers/utils/torch_utils.py

@@ -82,14 +82,14 @@ def randn_tensor(
     return latents
 
 
-def is_compiled_module(module):
+def is_compiled_module(module) -> bool:
     """Check whether the module was compiled with torch.compile()"""
     if is_torch_version("<", "2.0.0") or not hasattr(torch, "_dynamo"):
         return False
     return isinstance(module, torch._dynamo.eval_frame.OptimizedModule)
 
 
-def fourier_filter(x_in, threshold, scale):
+def fourier_filter(x_in: "torch.Tensor", threshold: int, scale: int) -> "torch.Tensor":
     """Fourier filter as introduced in FreeU (https://arxiv.org/abs/2309.11497).
 
     This version of the method comes from here:
@@ -121,8 +121,8 @@ def fourier_filter(x_in, threshold, scale):
 
 
 def apply_freeu(
-    resolution_idx: int, hidden_states: torch.Tensor, res_hidden_states: torch.Tensor, **freeu_kwargs
-) -> Tuple[torch.Tensor, torch.Tensor]:
+    resolution_idx: int, hidden_states: "torch.Tensor", res_hidden_states: "torch.Tensor", **freeu_kwargs
+) -> Tuple["torch.Tensor", "torch.Tensor"]:
     """Applies the FreeU mechanism as introduced in https:
     //arxiv.org/abs/2309.11497. Adapted from the official code repository: https://github.com/ChenyangSi/FreeU.
 

{diffusers-0.23.1.dist-info → diffusers-0.25.0.dist-info}/METADATA

@@ -1,103 +1,121 @@
 Metadata-Version: 2.1
 Name: diffusers
-Version: 0.23.1
+Version: 0.25.0
 Summary: State-of-the-art diffusion in PyTorch and JAX.
 Home-page: https://github.com/huggingface/diffusers
-Author: The HuggingFace team
+Author: The Hugging Face team (past and future) with the help of all our contributors (https://github.com/huggingface/diffusers/graphs/contributors)
 Author-email: patrick@huggingface.co
-License: Apache
+License: Apache 2.0 License
 Keywords: deep learning diffusion jax pytorch stable diffusion audioldm
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Programming Language :: Python :: 3.10
 Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: Pillow
-Requires-Dist: filelock
-Requires-Dist: huggingface-hub (>=0.13.2)
 Requires-Dist: importlib-metadata
+Requires-Dist: filelock
+Requires-Dist: huggingface-hub >=0.19.4
 Requires-Dist: numpy
-Requires-Dist: regex (!=2019.12.17)
+Requires-Dist: regex !=2019.12.17
 Requires-Dist: requests
-Requires-Dist: safetensors (>=0.3.1)
+Requires-Dist: safetensors >=0.3.1
+Requires-Dist: Pillow
 Provides-Extra: dev
-Requires-Dist: Jinja2 ; extra == 'dev'
-Requires-Dist: accelerate (>=0.11.0) ; extra == 'dev'
-Requires-Dist: black (~=23.1) ; extra == 'dev'
-Requires-Dist: compel (==0.1.8) ; extra == 'dev'
+Requires-Dist: urllib3 <=2.0.0 ; extra == 'dev'
+Requires-Dist: isort >=5.5.4 ; extra == 'dev'
+Requires-Dist: ruff ==0.1.5 ; extra == 'dev'
+Requires-Dist: hf-doc-builder >=0.3.0 ; extra == 'dev'
+Requires-Dist: compel ==0.1.8 ; extra == 'dev'
+Requires-Dist: GitPython <3.1.19 ; extra == 'dev'
 Requires-Dist: datasets ; extra == 'dev'
-Requires-Dist: flax (>=0.4.1) ; extra == 'dev'
-Requires-Dist: hf-doc-builder (>=0.3.0) ; extra == 'dev'
-Requires-Dist: invisible-watermark (>=0.2.0) ; extra == 'dev'
-Requires-Dist: isort (>=5.5.4) ; extra == 'dev'
-Requires-Dist: jax (>=0.4.1) ; extra == 'dev'
-Requires-Dist: jaxlib (>=0.4.1) ; extra == 'dev'
-Requires-Dist: k-diffusion (>=0.0.12) ; extra == 'dev'
+Requires-Dist: Jinja2 ; extra == 'dev'
+Requires-Dist: invisible-watermark >=0.2.0 ; extra == 'dev'
+Requires-Dist: k-diffusion >=0.0.12 ; extra == 'dev'
 Requires-Dist: librosa ; extra == 'dev'
 Requires-Dist: omegaconf ; extra == 'dev'
 Requires-Dist: parameterized ; extra == 'dev'
-Requires-Dist: protobuf (<4,>=3.20.3) ; extra == 'dev'
 Requires-Dist: pytest ; extra == 'dev'
 Requires-Dist: pytest-timeout ; extra == 'dev'
 Requires-Dist: pytest-xdist ; extra == 'dev'
-Requires-Dist: requests-mock (==1.10.0) ; extra == 'dev'
-Requires-Dist: ruff (==0.0.280) ; extra == 'dev'
-Requires-Dist: safetensors (>=0.3.1) ; extra == 'dev'
+Requires-Dist: requests-mock ==1.10.0 ; extra == 'dev'
+Requires-Dist: safetensors >=0.3.1 ; extra == 'dev'
+Requires-Dist: sentencepiece !=0.1.92,>=0.1.91 ; extra == 'dev'
 Requires-Dist: scipy ; extra == 'dev'
-Requires-Dist: sentencepiece (!=0.1.92,>=0.1.91) ; extra == 'dev'
-Requires-Dist: tensorboard ; extra == 'dev'
-Requires-Dist: torch (>=1.4) ; extra == 'dev'
 Requires-Dist: torchvision ; extra == 'dev'
-Requires-Dist: transformers (>=4.25.1) ; extra == 'dev'
-Requires-Dist: urllib3 (<=2.0.0) ; extra == 'dev'
+Requires-Dist: transformers >=4.25.1 ; extra == 'dev'
+Requires-Dist: accelerate >=0.11.0 ; extra == 'dev'
+Requires-Dist: protobuf <4,>=3.20.3 ; extra == 'dev'
+Requires-Dist: tensorboard ; extra == 'dev'
+Requires-Dist: peft >=0.6.0 ; extra == 'dev'
+Requires-Dist: torch >=1.4 ; extra == 'dev'
+Requires-Dist: jax >=0.4.1 ; extra == 'dev'
+Requires-Dist: jaxlib >=0.4.1 ; extra == 'dev'
+Requires-Dist: flax >=0.4.1 ; extra == 'dev'
 Provides-Extra: docs
-Requires-Dist: hf-doc-builder (>=0.3.0) ; extra == 'docs'
+Requires-Dist: hf-doc-builder >=0.3.0 ; extra == 'docs'
 Provides-Extra: flax
-Requires-Dist: flax (>=0.4.1) ; extra == 'flax'
-Requires-Dist: jax (>=0.4.1) ; extra == 'flax'
-Requires-Dist: jaxlib (>=0.4.1) ; extra == 'flax'
+Requires-Dist: jax >=0.4.1 ; extra == 'flax'
+Requires-Dist: jaxlib >=0.4.1 ; extra == 'flax'
+Requires-Dist: flax >=0.4.1 ; extra == 'flax'
 Provides-Extra: quality
-Requires-Dist: black (~=23.1) ; extra == 'quality'
-Requires-Dist: hf-doc-builder (>=0.3.0) ; extra == 'quality'
-Requires-Dist: isort (>=5.5.4) ; extra == 'quality'
-Requires-Dist: ruff (==0.0.280) ; extra == 'quality'
-Requires-Dist: urllib3 (<=2.0.0) ; extra == 'quality'
+Requires-Dist: urllib3 <=2.0.0 ; extra == 'quality'
+Requires-Dist: isort >=5.5.4 ; extra == 'quality'
+Requires-Dist: ruff ==0.1.5 ; extra == 'quality'
+Requires-Dist: hf-doc-builder >=0.3.0 ; extra == 'quality'
 Provides-Extra: test
-Requires-Dist: Jinja2 ; extra == 'test'
-Requires-Dist: compel (==0.1.8) ; extra == 'test'
+Requires-Dist: compel ==0.1.8 ; extra == 'test'
+Requires-Dist: GitPython <3.1.19 ; extra == 'test'
 Requires-Dist: datasets ; extra == 'test'
-Requires-Dist: invisible-watermark (>=0.2.0) ; extra == 'test'
-Requires-Dist: k-diffusion (>=0.0.12) ; extra == 'test'
+Requires-Dist: Jinja2 ; extra == 'test'
+Requires-Dist: invisible-watermark >=0.2.0 ; extra == 'test'
+Requires-Dist: k-diffusion >=0.0.12 ; extra == 'test'
 Requires-Dist: librosa ; extra == 'test'
 Requires-Dist: omegaconf ; extra == 'test'
 Requires-Dist: parameterized ; extra == 'test'
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: pytest-timeout ; extra == 'test'
 Requires-Dist: pytest-xdist ; extra == 'test'
-Requires-Dist: requests-mock (==1.10.0) ; extra == 'test'
-Requires-Dist: safetensors (>=0.3.1) ; extra == 'test'
+Requires-Dist: requests-mock ==1.10.0 ; extra == 'test'
+Requires-Dist: safetensors >=0.3.1 ; extra == 'test'
+Requires-Dist: sentencepiece !=0.1.92,>=0.1.91 ; extra == 'test'
 Requires-Dist: scipy ; extra == 'test'
-Requires-Dist: sentencepiece (!=0.1.92,>=0.1.91) ; extra == 'test'
 Requires-Dist: torchvision ; extra == 'test'
-Requires-Dist: transformers (>=4.25.1) ; extra == 'test'
+Requires-Dist: transformers >=4.25.1 ; extra == 'test'
 Provides-Extra: torch
-Requires-Dist: accelerate (>=0.11.0) ; extra == 'torch'
-Requires-Dist: torch (>=1.4) ; extra == 'torch'
+Requires-Dist: torch >=1.4 ; extra == 'torch'
+Requires-Dist: accelerate >=0.11.0 ; extra == 'torch'
 Provides-Extra: training
-Requires-Dist: Jinja2 ; extra == 'training'
-Requires-Dist: accelerate (>=0.11.0) ; extra == 'training'
+Requires-Dist: accelerate >=0.11.0 ; extra == 'training'
 Requires-Dist: datasets ; extra == 'training'
-Requires-Dist: protobuf (<4,>=3.20.3) ; extra == 'training'
+Requires-Dist: protobuf <4,>=3.20.3 ; extra == 'training'
 Requires-Dist: tensorboard ; extra == 'training'
+Requires-Dist: Jinja2 ; extra == 'training'
+Requires-Dist: peft >=0.6.0 ; extra == 'training'
+
+<!---
+Copyright 2022 - The HuggingFace Team. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
 
 <p align="center">
     <br>
@@ -115,7 +133,10 @@ Requires-Dist: tensorboard ; extra == 'training'
         <img alt="GitHub release" src="https://static.pepy.tech/badge/diffusers/month">
     </a>
     <a href="CODE_OF_CONDUCT.md">
-        <img alt="Contributor Covenant" src="https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg">
+        <img alt="Contributor Covenant" src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg">
+    </a>
+    <a href="https://twitter.com/diffuserslib">
+        <img alt="X account" src="https://img.shields.io/twitter/url/https/twitter.com/diffuserslib.svg?style=social&label=Follow%20%40diffuserslib">
     </a>
 </p>
 
@@ -125,11 +146,11 @@ Requires-Dist: tensorboard ; extra == 'training'
 
 - State-of-the-art [diffusion pipelines](https://huggingface.co/docs/diffusers/api/pipelines/overview) that can be run in inference with just a few lines of code.
 - Interchangeable noise [schedulers](https://huggingface.co/docs/diffusers/api/schedulers/overview) for different diffusion speeds and output quality.
-- Pretrained [models](https://huggingface.co/docs/diffusers/api/models) that can be used as building blocks, and combined with schedulers, for creating your own end-to-end diffusion systems.
+- Pretrained [models](https://huggingface.co/docs/diffusers/api/models/overview) 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](https://pytorch.org/get-started/locally/) and [Flax](https://flax.readthedocs.io/en/latest/#installation), please refer to their official documentation.
+We recommend installing 🤗 Diffusers in a virtual environment from PyPI or Conda. For more details about installing [PyTorch](https://pytorch.org/get-started/locally/) and [Flax](https://flax.readthedocs.io/en/latest/#installation), please refer to their official documentation.
 
 ### PyTorch
 
@@ -159,7 +180,7 @@ Please refer to the [How to use Stable Diffusion in Apple Silicon](https://huggi
 
 ## 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](https://huggingface.co/models?library=diffusers&sort=downloads) for 4000+ checkpoints):
+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](https://huggingface.co/models?library=diffusers&sort=downloads) for 16000+ checkpoints):
 
 ```python
 from diffusers import DiffusionPipeline
@@ -176,14 +197,13 @@ You can also dig into the models and schedulers toolbox to build your own diffus
 from diffusers import DDPMScheduler, UNet2DModel
 from PIL import Image
 import torch
-import numpy as np
 
 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)).to("cuda")
+noise = torch.randn((1, 3, sample_size, sample_size), device="cuda")
 input = noise
 
 for t in scheduler.timesteps:
@@ -218,8 +238,7 @@ You can look out for [issues](https://github.com/huggingface/diffusers/issues) y
 - See [New model/pipeline](https://github.com/huggingface/diffusers/issues?q=is%3Aopen+is%3Aissue+label%3A%22New+pipeline%2Fmodel%22) to contribute exciting new diffusion models / diffusion pipelines
 - See [New scheduler](https://github.com/huggingface/diffusers/issues?q=is%3Aopen+is%3Aissue+label%3A%22New+scheduler%22)
 
-Also, say 👋 in our public Discord channel <a href="https://discord.gg/G7tWnz98XR"><img alt="Join us on Discord" src="https://img.shields.io/discord/823813159592001537?color=5865F2&logo=discord&logoColor=white"></a>. We discuss the hottest trends about diffusion models, help each other with contributions, personal projects or
-just hang out ☕.
+Also, say 👋 in our public Discord channel <a href="https://discord.gg/G7tWnz98XR"><img alt="Join us on Discord" src="https://img.shields.io/discord/823813159592001537?color=5865F2&logo=discord&logoColor=white"></a>. We discuss the hottest trends about diffusion models, help each other with contributions, personal projects or just hang out ☕.
 
 
 ## Popular Tasks & Pipelines
@@ -242,12 +261,12 @@ just hang out ☕.
   </tr>
   <tr>
     <td>Text-to-Image</td>
-    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/unclip">unclip</a></td>
+    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/unclip">unCLIP</a></td>
       <td><a href="https://huggingface.co/kakaobrain/karlo-v1-alpha"> kakaobrain/karlo-v1-alpha </a></td>
   </tr>
   <tr>
     <td>Text-to-Image</td>
-    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/if">DeepFloyd IF</a></td>
+    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/deepfloyd_if">DeepFloyd IF</a></td>
       <td><a href="https://huggingface.co/DeepFloyd/IF-I-XL-v1.0"> DeepFloyd/IF-I-XL-v1.0 </a></td>
   </tr>
   <tr>
@@ -257,12 +276,12 @@ just hang out ☕.
   </tr>
   <tr style="border-top: 2px solid black">
     <td>Text-guided Image-to-Image</td>
-    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/stable_diffusion/controlnet">Controlnet</a></td>
+    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/controlnet">ControlNet</a></td>
       <td><a href="https://huggingface.co/lllyasviel/sd-controlnet-canny"> lllyasviel/sd-controlnet-canny </a></td>
   </tr>
   <tr>
     <td>Text-guided Image-to-Image</td>
-    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/pix2pix">Instruct Pix2Pix</a></td>
+    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/pix2pix">InstructPix2Pix</a></td>
       <td><a href="https://huggingface.co/timbrooks/instruct-pix2pix"> timbrooks/instruct-pix2pix </a></td>
   </tr>
   <tr>
@@ -272,7 +291,7 @@ just hang out ☕.
   </tr>
   <tr style="border-top: 2px solid black">
     <td>Text-guided Image Inpainting</td>
-    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/stable_diffusion/inpaint">Stable Diffusion Inpaint</a></td>
+    <td><a href="https://huggingface.co/docs/diffusers/api/pipelines/stable_diffusion/inpaint">Stable Diffusion Inpainting</a></td>
       <td><a href="https://huggingface.co/runwayml/stable-diffusion-inpainting"> runwayml/stable-diffusion-inpainting </a></td>
   </tr>
   <tr style="border-top: 2px solid black">
@@ -303,9 +322,9 @@ just hang out ☕.
 - https://github.com/deep-floyd/IF
 - https://github.com/bentoml/BentoML
 - https://github.com/bmaltais/kohya_ss
-- +3000 other amazing GitHub repositories 💪
+- +7000 other amazing GitHub repositories 💪
 
-Thank you for using us ❤️
+Thank you for using us ❤️.
 
 ## Credits
 
@@ -330,5 +349,3 @@ We also want to thank @heejkoo for the very helpful overview of papers, code and
   howpublished = {\url{https://github.com/huggingface/diffusers}}
 }
 ```
-
-