mirror of
https://github.com/huggingface/diffusers.git
synced 2026-01-29 07:22:12 +03:00
edf36f5128
* Add ZImage LoRA support and integrate into ZImagePipeline * Add LoRA test for Z-Image * Move the LoRA test * Fix ZImage LoRA scale support and test configuration * Add ZImage LoRA test overrides for architecture differences - Override test_lora_fuse_nan to use ZImage's 'layers' attribute instead of 'transformer_blocks' - Skip block-level LoRA scaling test (not supported in ZImage) - Add required imports: numpy, torch_device, check_if_lora_correctly_set * Add ZImageLoraLoaderMixin to LoRA documentation * Use conditional import for peft.LoraConfig in ZImage tests * Override test_correct_lora_configs_with_different_ranks for ZImage ZImage uses 'attention.to_k' naming convention instead of 'attn.to_k', so the base test's module name search loop never finds a match. This override uses the correct naming pattern for ZImage architecture. * Add is_flaky decorator to ZImage LoRA tests initialise padding tokens * Skip ZImage LoRA test class entirely Skip the entire ZImageLoRATests class due to non-deterministic behavior from complex64 RoPE operations and torch.empty padding tokens. LoRA functionality works correctly with real models. Clean up removed: - Individual @unittest.skip decorators - @is_flaky decorator overrides for inherited methods - Custom test method overrides - Global torch deterministic settings - Unused imports (numpy, is_flaky, check_if_lora_correctly_set) --------- Co-authored-by: Sayak Paul <spsayakpaul@gmail.com> Co-authored-by: Γlvaro Somoza <asomoza@users.noreply.github.com>
125 lines
5.8 KiB
Markdown
125 lines
5.8 KiB
Markdown
<!--Copyright 2025 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.
|
|
-->
|
|
|
|
# LoRA
|
|
|
|
LoRA is a fast and lightweight training method that inserts and trains a significantly smaller number of parameters instead of all the model parameters. This produces a smaller file (~100 MBs) and makes it easier to quickly train a model to learn a new concept. LoRA weights are typically loaded into the denoiser, text encoder or both. The denoiser usually corresponds to a UNet ([`UNet2DConditionModel`], for example) or a Transformer ([`SD3Transformer2DModel`], for example). There are several classes for loading LoRA weights:
|
|
|
|
- [`StableDiffusionLoraLoaderMixin`] provides functions for loading and unloading, fusing and unfusing, enabling and disabling, and more functions for managing LoRA weights. This class can be used with any model.
|
|
- [`StableDiffusionXLLoraLoaderMixin`] is a [Stable Diffusion (SDXL)](../../api/pipelines/stable_diffusion/stable_diffusion_xl) version of the [`StableDiffusionLoraLoaderMixin`] class for loading and saving LoRA weights. It can only be used with the SDXL model.
|
|
- [`SD3LoraLoaderMixin`] provides similar functions for [Stable Diffusion 3](https://huggingface.co/blog/sd3).
|
|
- [`FluxLoraLoaderMixin`] provides similar functions for [Flux](https://huggingface.co/docs/diffusers/main/en/api/pipelines/flux).
|
|
- [`CogVideoXLoraLoaderMixin`] provides similar functions for [CogVideoX](https://huggingface.co/docs/diffusers/main/en/api/pipelines/cogvideox).
|
|
- [`Mochi1LoraLoaderMixin`] provides similar functions for [Mochi](https://huggingface.co/docs/diffusers/main/en/api/pipelines/mochi).
|
|
- [`AuraFlowLoraLoaderMixin`] provides similar functions for [AuraFlow](https://huggingface.co/fal/AuraFlow).
|
|
- [`LTXVideoLoraLoaderMixin`] provides similar functions for [LTX-Video](https://huggingface.co/docs/diffusers/main/en/api/pipelines/ltx_video).
|
|
- [`SanaLoraLoaderMixin`] provides similar functions for [Sana](https://huggingface.co/docs/diffusers/main/en/api/pipelines/sana).
|
|
- [`HunyuanVideoLoraLoaderMixin`] provides similar functions for [HunyuanVideo](https://huggingface.co/docs/diffusers/main/en/api/pipelines/hunyuan_video).
|
|
- [`Lumina2LoraLoaderMixin`] provides similar functions for [Lumina2](https://huggingface.co/docs/diffusers/main/en/api/pipelines/lumina2).
|
|
- [`WanLoraLoaderMixin`] provides similar functions for [Wan](https://huggingface.co/docs/diffusers/main/en/api/pipelines/wan).
|
|
- [`SkyReelsV2LoraLoaderMixin`] provides similar functions for [SkyReels-V2](https://huggingface.co/docs/diffusers/main/en/api/pipelines/skyreels_v2).
|
|
- [`CogView4LoraLoaderMixin`] provides similar functions for [CogView4](https://huggingface.co/docs/diffusers/main/en/api/pipelines/cogview4).
|
|
- [`AmusedLoraLoaderMixin`] is for the [`AmusedPipeline`].
|
|
- [`HiDreamImageLoraLoaderMixin`] provides similar functions for [HiDream Image](https://huggingface.co/docs/diffusers/main/en/api/pipelines/hidream)
|
|
- [`QwenImageLoraLoaderMixin`] provides similar functions for [Qwen Image](https://huggingface.co/docs/diffusers/main/en/api/pipelines/qwen).
|
|
- [`ZImageLoraLoaderMixin`] provides similar functions for [Z-Image](https://huggingface.co/docs/diffusers/main/en/api/pipelines/zimage).
|
|
- [`Flux2LoraLoaderMixin`] provides similar functions for [Flux2](https://huggingface.co/docs/diffusers/main/en/api/pipelines/flux2).
|
|
- [`LoraBaseMixin`] provides a base class with several utility methods to fuse, unfuse, unload, LoRAs and more.
|
|
|
|
> [!TIP]
|
|
> To learn more about how to load LoRA weights, see the [LoRA](../../tutorials/using_peft_for_inference) loading guide.
|
|
|
|
## LoraBaseMixin
|
|
|
|
[[autodoc]] loaders.lora_base.LoraBaseMixin
|
|
|
|
## StableDiffusionLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.StableDiffusionLoraLoaderMixin
|
|
|
|
## StableDiffusionXLLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.StableDiffusionXLLoraLoaderMixin
|
|
|
|
## SD3LoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.SD3LoraLoaderMixin
|
|
|
|
## FluxLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.FluxLoraLoaderMixin
|
|
|
|
## Flux2LoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.Flux2LoraLoaderMixin
|
|
|
|
## CogVideoXLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.CogVideoXLoraLoaderMixin
|
|
|
|
## Mochi1LoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.Mochi1LoraLoaderMixin
|
|
## AuraFlowLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.AuraFlowLoraLoaderMixin
|
|
|
|
## LTXVideoLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.LTXVideoLoraLoaderMixin
|
|
|
|
## SanaLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.SanaLoraLoaderMixin
|
|
|
|
## HunyuanVideoLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.HunyuanVideoLoraLoaderMixin
|
|
|
|
## Lumina2LoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.Lumina2LoraLoaderMixin
|
|
|
|
## CogView4LoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.CogView4LoraLoaderMixin
|
|
|
|
## WanLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.WanLoraLoaderMixin
|
|
|
|
## SkyReelsV2LoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.SkyReelsV2LoraLoaderMixin
|
|
|
|
## AmusedLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.AmusedLoraLoaderMixin
|
|
|
|
## HiDreamImageLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.HiDreamImageLoraLoaderMixin
|
|
|
|
## QwenImageLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.QwenImageLoraLoaderMixin
|
|
|
|
## ZImageLoraLoaderMixin
|
|
|
|
[[autodoc]] loaders.lora_pipeline.ZImageLoraLoaderMixin
|
|
|
|
## KandinskyLoraLoaderMixin
|
|
[[autodoc]] loaders.lora_pipeline.KandinskyLoraLoaderMixin
|
|
|
|
## LoraBaseMixin
|
|
|
|
[[autodoc]] loaders.lora_base.LoraBaseMixin |