# Hunyuan-DiT
![chinese elements understanding](https://github.com/gnobitab/diffusers-hunyuan/assets/1157982/39b99036-c3cb-4f16-bb1a-40ec25eda573)

[Hunyuan-DiT : un puissant Diffusion Transformer multi-résolution doté d'une compréhension fine du chinois](https://huggingface.co/papers/2405.08748) de Tencent Hunyuan.

L'abstract de l'article est :

*Nous présentons Hunyuan-DiT, un transformateur de diffusion texte-vers-image doté d'une compréhension fine de l'anglais et du chinois. Pour construire Hunyuan-DiT, nous avons soigneusement conçu la structure du transformateur, l'encodeur de texte et l'encodage positionnel. Nous avons également construit de zéro un pipeline de données complet pour mettre à jour et évaluer les données en vue d'une optimisation itérative du modèle. Pour une compréhension linguistique fine, nous entraînons un grand modèle de langage multimodal afin d'affiner les légendes des images. Enfin, Hunyuan-DiT peut mener des dialogues multimodaux multi-tours avec les utilisateurs, générant et affinant des images en fonction du contexte. Grâce à notre protocole d'évaluation humaine holistique impliquant plus de 50 évaluateurs humains professionnels, Hunyuan-DiT établit un nouvel état de l'art dans la génération d'images à partir du chinois par rapport aux autres modèles open source.*

Vous pouvez trouver le code source original sur [Tencent/HunyuanDiT](https://github.com/Tencent/HunyuanDiT) et tous les points de contrôle disponibles sur [Tencent-Hunyuan](https://huggingface.co/Tencent-Hunyuan/HunyuanDiT).

**Points forts** : HunyuanDiT prend en charge la génération d'images à partir de texte en chinois/anglais et la génération multi-résolution.

HunyuanDiT comporte les éléments suivants :
* Il utilise un transformateur de diffusion comme architecture de base
* Il combine deux encodeurs de texte, un CLIP bilingue et un encodeur T5 multilingue

> [!TIP]
> Pensez à consulter le [guide des Schedulers](../../using-diffusers/schedulers) pour apprendre à explorer le compromis entre la vitesse et la qualité du scheduler, et à consulter la section [réutilisation des composants entre les pipelines](../../using-diffusers/loading#reusing-models-in-multiple-pipelines) pour apprendre à charger efficacement les mêmes composants dans plusieurs pipelines.

> [!TIP]
> Vous pouvez améliorer davantage la qualité de génération en transmettant l'image générée par `HungyuanDiTPipeline` au modèle [SDXL refiner](./stable_diffusion/stable_diffusion_xl#base-to-refiner-model).

## Optimisation

Vous pouvez optimiser le temps d'exécution et la consommation mémoire du pipeline avec torch.compile et le chunking feed-forward. Pour en savoir plus sur d'autres méthodes d'optimisation, consultez [Optimiser et mettre à l'échelle](../../optimization/overview#optimization-techniques).

### Inférence

Utilisez [`torch.compile`](../../optimization/fp16#torchcompile) pour réduire la latence d'inférence.

Tout d'abord, chargez le pipeline :

```python
from diffusers import HunyuanDiTPipeline
import torch

pipeline = HunyuanDiTPipeline.from_pretrained(
	"Tencent-Hunyuan/HunyuanDiT-Diffusers", dtype=torch.float16
).to("cuda")  # or "mps", "xpu", "cpu"
```

Puis modifiez la disposition mémoire des composants `transformer` et `vae` des pipelines en `torch.channels-last` :

```python
pipeline.transformer.to(memory_format=torch.channels_last)
pipeline.vae.to(memory_format=torch.channels_last)
```

Enfin, compilez les composants et exécutez l'inférence :

```python
pipeline.transformer = torch.compile(pipeline.transformer, mode="max-autotune", fullgraph=True)
pipeline.vae.decode = torch.compile(pipeline.vae.decode, mode="max-autotune", fullgraph=True)

image = pipeline(prompt="一个宇航员在骑马").images[0]
```

Les résultats du [benchmark](https://gist.github.com/sayakpaul/29d3a14905cfcbf611fe71ebd22e9b23) sur une machine A100 de 80 Go sont :

```bash
With torch.compile(): Average inference time: 12.470 seconds.
Without torch.compile(): Average inference time: 20.570 seconds.
```

### Optimisation de la mémoire

En chargeant l'encodeur de texte T5 en 8 bits, vous pouvez exécuter le pipeline avec moins de 6 Go de VRAM GPU. Consultez [ce script](https://gist.github.com/sayakpaul/3154605f6af05b98a41081aaba5ca43e) pour plus de détails.

De plus, vous pouvez utiliser la méthode [enable_forward_chunking()](/docs/diffusers/main/fr/api/models/hunyuan_transformer2d#diffusers.HunyuanDiT2DModel.enable_forward_chunking) pour réduire la consommation de mémoire. Le chunking des couches feed-forward exécute les couches feed-forward d'un bloc transformer dans une boucle plutôt que toutes d'un coup. Cela vous offre un compromis entre la consommation de mémoire et le temps d'inférence.

```diff
+ pipeline.transformer.enable_forward_chunking(chunk_size=1, dim=1)
```

## HunyuanDiTPipeline[[diffusers.HunyuanDiTPipeline]]

#### diffusers.HunyuanDiTPipeline[[diffusers.HunyuanDiTPipeline]]

```python
diffusers.HunyuanDiTPipeline(vae: AutoencoderKL, text_encoder: BertModel, tokenizer: BertTokenizer, transformer: HunyuanDiT2DModel, scheduler: DDPMScheduler, safety_checker: StableDiffusionSafetyChecker, feature_extractor: CLIPImageProcessorPil, requires_safety_checker: bool = True, text_encoder_2: transformers.models.t5.modeling_t5.T5EncoderModel | None = None, tokenizer_2: transformers.models.t5.tokenization_t5.T5Tokenizer | None = None)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/hunyuandit/pipeline_hunyuandit.py#L149)

**Paramètres :**

vae ([AutoencoderKL](/docs/diffusers/main/fr/api/models/autoencoderkl#diffusers.AutoencoderKL)) : modèle Variational Auto-Encoder (VAE) permettant d’encoder et de décoder des images vers et depuis des représentations latentes. Nous utilisons `sdxl-vae-fp16-fix`.

text_encoder (`~transformers.BertModel`, `~transformers.CLIPTextModel` | None) : encodeur de texte figé ([clip-vit-large-patch14](https://huggingface.co/openai/clip-vit-large-patch14)). HunyuanDiT utilise un [CLIP bilingue] affiné.

tokenizer (`~transformers.BertTokenizer`, `~transformers.CLIPTokenizer` | None) : Un `BertTokenizer` ou `CLIPTokenizer` pour tokeniser le texte.

transformer ([HunyuanDiT2DModel](/docs/diffusers/main/fr/api/models/hunyuan_transformer2d#diffusers.HunyuanDiT2DModel)) : Le modèle HunyuanDiT conçu par Tencent Hunyuan.

text_encoder_2 (`T5EncoderModel`) : l’encodeur mT5. Plus précisément, il s’agit de 't5-v1_1-xxl'.

tokenizer_2 (`T5Tokenizer`) : le tokeniseur de l'embedder mT5.

scheduler ([DDPMScheduler](/docs/diffusers/main/fr/api/schedulers/ddpm#diffusers.DDPMScheduler)) : un planificateur à utiliser en combinaison avec HunyuanDiT pour débruyer les latents d'image encodés.

Pipeline pour la génération d’images à partir de l’anglais ou du chinois à l’aide de HunyuanDiT.

Ce modèle hérite de [DiffusionPipeline](/docs/diffusers/main/fr/api/pipelines/overview#diffusers.DiffusionPipeline). Consultez la documentation de la classe parente pour les méthodes génériques que la bibliothèque implémente pour tous les pipelines (téléchargement ou sauvegarde, exécution sur un appareil particulier, etc.).

HunyuanDiT utilise deux encodeurs de texte : [mT5](https://huggingface.co/google/mt5-base) et [CLIP bilingue](fine-tuned by ourselves)

#### __appel__[[diffusers.HunyuanDiTPipeline.__call__]]

```python
__call__(prompt: str | list[str] = None, height: int | None = None, width: int | None = None, num_inference_steps: int | None = 50, guidance_scale: float | None = 5.0, negative_prompt: str | list[str] | None = None, num_images_per_prompt: int | None = 1, eta: float | None = 0.0, generator: typing.Union[torch.Generator, list[torch.Generator], NoneType] = None, latents: typing.Optional[torch.Tensor] = None, prompt_embeds: typing.Optional[torch.Tensor] = None, prompt_embeds_2: typing.Optional[torch.Tensor] = None, negative_prompt_embeds: typing.Optional[torch.Tensor] = None, negative_prompt_embeds_2: typing.Optional[torch.Tensor] = None, prompt_attention_mask: typing.Optional[torch.Tensor] = None, prompt_attention_mask_2: typing.Optional[torch.Tensor] = None, negative_prompt_attention_mask: typing.Optional[torch.Tensor] = None, negative_prompt_attention_mask_2: typing.Optional[torch.Tensor] = None, output_type: str | None = 'pil', return_dict: bool = True, callback_on_step_end: typing.Union[typing.Callable[[int, int], NoneType], diffusers.callbacks.PipelineCallback, diffusers.callbacks.MultiPipelineCallbacks, NoneType] = None, callback_on_step_end_tensor_inputs: list[str] = ['latents'], guidance_rescale: float = 0.0, original_size: tuple[int, int] | None = (1024, 1024), target_size: tuple[int, int] | None = None, crops_coords_top_left: tuple[int, int] = (0, 0), use_resolution_binning: bool = True)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/hunyuandit/pipeline_hunyuandit.py#L568)

**Paramètres :**

prompt (`str` ou `list[str]`, *facultatif*) : Le prompt ou les prompts pour guider la génération d’images. S’il n’est pas défini, vous devez passer `prompt_embeds`.

height (`int`) : La hauteur en pixels de l'image générée.

width (`int`) : La largeur en pixels de l'image générée.

num_inference_steps (`int`, *facultatif*, valeur par défaut 50) : Le nombre d'étapes de débruitage. Un plus grand nombre d'étapes de débruitage conduit généralement à une image de meilleure qualité, au prix d'une inférence plus lente. Ce paramètre est modulé par `strength`.

guidance_scale (`float`, *facultatif*, valeur par défaut 7,5) : Une valeur de guidance scale plus élevée encourage le modèle à générer des images étroitement liées au `prompt` texte, au détriment de la qualité de l'image. Le guidance scale est activé lorsque `guidance_scale > 1`.

negative_prompt (`str` ou `list[str]`, *facultatif*) : Le prompt ou les prompts pour guider ce qu'il ne faut pas inclure dans la génération d'image. S'il n'est pas défini, vous devez passer `negative_prompt_embeds` à la place. Ignoré lorsque la guidance n'est pas utilisée (`guidance_scale < 1`).

num_images_per_prompt (`int`, *facultatif*, valeur par défaut 1) : Le nombre d'images à générer par invite.

eta (`float`, *facultatif*, valeur par défaut 0.0) : Correspond au paramètre eta (η) de l'article [DDIM](https://huggingface.co/papers/2010.02502). S'applique uniquement au [DDIMScheduler](/docs/diffusers/main/fr/api/schedulers/ddim#diffusers.DDIMScheduler) et est ignoré par les autres planificateurs.

generator (`torch.Generator` ou `list[torch.Generator]`, *facultatif*) : Un [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html) pour rendre la génération déterministe.

latents (`torch.Tensor`, *facultatif*) : Latents bruités pré-générés, échantillonnés à partir d'une distribution gaussienne, à utiliser comme entrées pour la génération d'images. Peut être utilisé pour ajuster la même génération avec des prompts différents. S'il n'est pas fourni, un tenseur de latents est généré par échantillonnage à l'aide du `generator` aléatoire fourni.

prompt_embeds (`torch.Tensor`, *facultatif*) : Incrustations de texte pré-générées. Peut être utilisé pour ajuster facilement les entrées de texte (pondération des prompts). Si non fourni, les incrustations de texte sont générées à partir de l'argument d'entrée `prompt`.

prompt_embeds_2 (`torch.Tensor`, *facultatif*) : Incrustations de texte pré-générées. Peut être utilisé pour ajuster facilement les entrées de texte (pondération des prompts). Si non fourni, les incrustations de texte sont générées à partir de l'argument d'entrée `prompt`.

negative_prompt_embeds (`torch.Tensor`, *facultatif*) : Incrustations de texte négatif pré-générées. Peut être utilisé pour ajuster facilement les entrées de texte (pondération des prompts). Si non fourni, `negative_prompt_embeds` sont générés à partir de l'argument d'entrée `negative_prompt`.

negative_prompt_embeds_2 (`torch.Tensor`, *facultatif*) : Incrustations de texte négatif pré-générées. Peut être utilisé pour ajuster facilement les entrées de texte (pondération des prompts). Si non fourni, `negative_prompt_embeds` sont générés à partir de l'argument d'entrée `negative_prompt`.

prompt_attention_mask (`torch.Tensor`, *facultatif*) : Masque d'attention pour le prompt. Obligatoire lorsque `prompt_embeds` est transmis directement.

prompt_attention_mask_2 (`torch.Tensor`, *facultatif*) : Masque d'attention pour le prompt. Obligatoire lorsque `prompt_embeds_2` est transmis directement.

negative_prompt_attention_mask (`torch.Tensor`, *facultatif*) : Masque d'attention pour le prompt négatif. Requis lorsque `negative_prompt_embeds` est passé directement.

negative_prompt_attention_mask_2 (`torch.Tensor`, *facultatif*) : Masque d'attention pour le prompt négatif. Requis lorsque `negative_prompt_embeds_2` est passé directement.

output_type (`str`, *facultatif*, par défaut `"pil"`) : Le format de sortie de l'image générée. Choisissez entre `PIL.Image` ou `np.array`.

return_dict (`bool`, *facultatif*, par défaut `True`) : Indique s'il faut retourner un [StableDiffusionPipelineOutput](/docs/diffusers/main/fr/api/pipelines/stable_diffusion/img2img#diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput) plutôt qu'un simple tuple.

callback_on_step_end (`Callable[[int, int], None]`, `PipelineCallback`, `MultiPipelineCallbacks`, *facultatif*) : une fonction de rappel ou une liste de fonctions de rappel à appeler à la fin de chaque étape de débruitage.

callback_on_step_end_tensor_inputs (`list[str]`, *facultatif*) : Une liste d'entrées tensorielles qui doivent être transmises à la fonction de rappel. Si non définie, toutes les entrées tensorielles seront transmises.

guidance_rescale (`float`, *facultatif*, valeur par défaut 0.0) : Recalcule le bruit_cfg en fonction de `guidance_rescale`. Basé sur les résultats de [Common Diffusion Noise Schedules and Sample Steps are Flawed](https://huggingface.co/papers/2305.08891). Voir la section 3.4

original_size (`tuple[int, int]`, *facultatif*, valeur par défaut `(1024, 1024)`) : La taille originale de l'image. Utilisée pour calculer les identifiants de temps.

target_size (`tuple[int, int]`, *facultatif*) : La taille cible de l'image. Utilisée pour calculer les identifiants temporels.

crops_coords_top_left (`tuple[int, int]`, *facultatif*, valeur par défaut `(0, 0)`) : Les coordonnées du coin supérieur gauche de la zone recadrée. Utilisé pour calculer les identifiants de temps.

use_resolution_binning (`bool`, *facultatif*, valeur par défaut `True`) : Indique s'il faut utiliser le binage de résolution ou non. Si `True`, la résolution d'entrée sera mappée sur la résolution standard la plus proche. Les résolutions prises en charge sont 1024x1024, 1280x1280, 1024x768, 1152x864, 1280x960, 768x1024, 864x1152, 960x1280, 1280x768 et 768x1280. Il est recommandé de définir cette valeur sur `True`.

**Retourne :** [StableDiffusionPipelineOutput](/docs/diffusers/main/fr/api/pipelines/stable_diffusion/img2img#diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput) ou `tuple`

Si `return_dict` est `True`, [StableDiffusionPipelineOutput](/docs/diffusers/main/fr/api/pipelines/stable_diffusion/img2img#diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput) est renvoyé, sinon un `tuple` est renvoyé dont le premier élément est une liste des images générées et le deuxième élément est une liste de `bool` indiquant si l'image générée correspondante contient du contenu « not-safe-for-work » (nsfw).

La fonction d'appel du pipeline pour la génération avec HunyuanDiT.

Exemples :
```py
>>> import torch
>>> from diffusers import HunyuanDiTPipeline

>>> pipe = HunyuanDiTPipeline.from_pretrained(
...     "Tencent-Hunyuan/HunyuanDiT-Diffusers", torch_dtype=torch.float16
... )
>>> pipe.to("cuda")

>>> # You may also use English prompt as HunyuanDiT supports both English and Chinese
>>> # prompt = "An astronaut riding a horse"
>>> prompt = "一个宇航员在骑马"
>>> image = pipe(prompt).images[0]
```

#### encode_prompt[[diffusers.HunyuanDiTPipeline.encode_prompt]]

```python
encode_prompt(prompt: str, device: device = None, dtype: dtype = None, num_images_per_prompt: int = 1, do_classifier_free_guidance: bool = True, negative_prompt: str | None = None, prompt_embeds: typing.Optional[torch.Tensor] = None, negative_prompt_embeds: typing.Optional[torch.Tensor] = None, prompt_attention_mask: typing.Optional[torch.Tensor] = None, negative_prompt_attention_mask: typing.Optional[torch.Tensor] = None, max_sequence_length: int | None = None, text_encoder_index: int = 0)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/hunyuandit/pipeline_hunyuandit.py#L248)

**Paramètres :**

prompt (`str` ou `list[str]`, *facultatif*) : invite à encoder

device : (`torch.device`) : appareil torch

dtype (`torch.dtype`) : dtype torch

num_images_per_prompt (`int`) : nombre d'images à générer par invite

do_classifier_free_guidance (`bool`) : indique s'il faut utiliser le guidage sans classifieur ou non

negative_prompt (`str` ou `list[str]`, *facultatif*) : Le prompt ou les prompts à ne pas utiliser pour guider la génération d’image. S’il n’est pas défini, il faut passer `negative_prompt_embeds` à la place. Ignoré lorsque le guidage n’est pas utilisé (c’est-à-dire ignoré si `guidance_scale` est inférieur à `1`).

prompt_embeds (`torch.Tensor`, *facultatif*) : Incrustations de texte pré-générées. Peut être utilisé pour ajuster facilement les entrées de texte, *par ex.* pondération des prompts. Si non fourni, les incrustations de texte seront générées à partir de l'argument d'entrée `prompt`.

negative_prompt_embeds (`torch.Tensor`, *facultatif*) : Embeddings de texte négatif pré-générés. Peut être utilisé pour ajuster facilement les entrées de texte, *par exemple* le pondération des prompts. S'il n'est pas fourni, negative_prompt_embeds sera généré à partir de l'argument d'entrée `negative_prompt`.

prompt_attention_mask (`torch.Tensor`, *facultatif*) : Masque d'attention pour le prompt. Obligatoire lorsque `prompt_embeds` est transmis directement.

negative_prompt_attention_mask (`torch.Tensor`, *facultatif*) : Masque d'attention pour le prompt négatif. Requis lorsque `negative_prompt_embeds` est passé directement.

max_sequence_length (`int`, *facultatif*) : longueur maximale de la séquence à utiliser pour le prompt.

text_encoder_index (`int`, *facultatif*) : Index de l'encodeur de texte à utiliser. `0` pour clip et `1` pour T5.

Encode le prompt dans les états cachés de l'encodeur de texte.