Skip to content

Commit 4295ee3

Browse files
authored
[docs] Adapters (#14842)
* lora * legacy adapters * ip adapter * controlnet * feedback
1 parent e0118ad commit 4295ee3

13 files changed

Lines changed: 389 additions & 386 deletions

‎docs/source/en/_toctree.yml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,10 @@
4343
title: IP-Adapter
4444
- local: using-diffusers/controlnet
4545
title: ControlNet
46-
- local: using-diffusers/t2i_adapter
47-
title: T2I-Adapter
4846
- local: using-diffusers/dreambooth
4947
title: DreamBooth
50-
- local: using-diffusers/textual_inversion_inference
51-
title: Textual inversion
48+
- local: using-diffusers/legacy_adapters
49+
title: Legacy adapters
5250
title: Adapters and personalization
5351
title: Inference
5452
- isExpanded: true

‎docs/source/en/api/loaders/textual_inversion.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Textual Inversion is a training method for personalizing models by learning new
1717
[`TextualInversionLoaderMixin`] provides a function for loading Textual Inversion embeddings from Diffusers and Automatic1111 into the text encoder and loading a special token to activate the embeddings.
1818

1919
> [!TIP]
20-
> To learn more about how to load Textual Inversion embeddings, see the [Textual Inversion](../../using-diffusers/textual_inversion_inference) loading guide.
20+
> To learn more about how to load Textual Inversion embeddings, see the [Textual Inversion](../../using-diffusers/legacy_adapters#textual-inversion) loading guide.
2121
2222
## TextualInversionLoaderMixin
2323

‎docs/source/en/api/pipelines/latent_consistency_models.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ image
458458

459459
### T2I-Adapter
460460

461-
[T2I-Adapter](../../using-diffusers/t2i_adapter) is an even more lightweight adapter than ControlNet, that provides an additional input to condition a pretrained model with. It is faster than ControlNet but the results may be slightly worse.
461+
[T2I-Adapter](../../using-diffusers/legacy_adapters#t2i-adapter) is an even more lightweight adapter than ControlNet, that provides an additional input to condition a pretrained model with. It is faster than ControlNet but the results may be slightly worse.
462462

463463
You can find additional T2I-Adapter checkpoints trained on other inputs in [TencentArc's](https://hf.co/TencentARC) repository.
464464

‎docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ image
426426
<img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/diffusers/sdxl-double-prompt.png" alt="generated image of an astronaut in a jungle in the style of a van gogh painting"/>
427427
</div>
428428

429-
The dual text-encoders also support textual inversion embeddings that need to be loaded separately as explained in the [textual inversion](../../../using-diffusers/textual_inversion_inference) guide.
429+
The dual text-encoders also support textual inversion embeddings that need to be loaded separately as explained in the [textual inversion](../../../using-diffusers/legacy_adapters#textual-inversion) guide.
430430

431431
## Optimizations
432432

‎docs/source/en/training/dreambooth.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ specific language governing permissions and limitations under the License.
1414

1515
[DreamBooth](https://huggingface.co/papers/2208.12242) is a training technique that updates the entire diffusion model by training on just a few images of a subject or style. It works by associating a special word in the prompt with the example images.
1616

17-
To load a trained checkpoint for inference, see [Load a DreamBooth adapter for inference](../using-diffusers/dreambooth).
17+
To load a trained checkpoint for inference, see [Load a DreamBooth model for inference](../using-diffusers/dreambooth).
1818

1919
If you're training on a GPU with limited vRAM, you should try enabling the `gradient_checkpointing` and `mixed_precision` parameters in the training command. You can also reduce your memory footprint by using memory-efficient attention with [xFormers](../optimization/xformers).
2020

@@ -550,4 +550,5 @@ Training the DeepFloyd IF model can be challenging, but here are some tips that
550550

551551
Congratulations on training your DreamBooth model! To learn more about how to use your new model, the following guide may be helpful:
552552

553-
- Learn how to [load a DreamBooth](../using-diffusers/dreambooth) model for inference if you trained your model with LoRA.
553+
- Learn how to [load a DreamBooth checkpoint](../using-diffusers/dreambooth) for inference.
554+
- If you trained with LoRA, see [LoRA for inference](../tutorials/using_peft_for_inference).

‎docs/source/en/training/text_inversion.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ specific language governing permissions and limitations under the License.
1414

1515
[Textual Inversion](https://hf.co/papers/2208.01618) is a training technique for personalizing image generation models with just a few example images of what you want it to learn. This technique works by learning and updating the text embeddings (the new embeddings are tied to a special word you must use in the prompt) to match the example images you provide.
1616

17-
For inference with trained embeddings, see [Textual inversion inference](../using-diffusers/textual_inversion_inference).
17+
For inference with trained embeddings, see [Textual inversion inference](../using-diffusers/legacy_adapters#textual-inversion).
1818

1919
If you're training on a GPU with limited vRAM, you should try enabling the `gradient_checkpointing` and `mixed_precision` parameters in the training command. You can also reduce your memory footprint by using memory-efficient attention with [xFormers](../optimization/xformers).
2020

@@ -205,4 +205,4 @@ image.save("cat-train.png")
205205

206206
Congratulations on training your own Textual Inversion model! 🎉 To learn more about how to use your new model, the following guides may be helpful:
207207

208-
- Learn how to [load Textual Inversion embeddings](../using-diffusers/textual_inversion_inference) and also use them as negative embeddings.
208+
- Learn how to [load Textual Inversion embeddings](../using-diffusers/legacy_adapters#textual-inversion) and also use them as negative embeddings.

0 commit comments

Comments
 (0)