# PixArt-Σ

![](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/diffusers/pixart/header_collage_sigma.jpg)

[PixArt-Σ: Weak-to-Strong Training of Diffusion Transformer for 4K Text-to-Image Generation](https://huggingface.co/papers/2403.04692) est de Junsong Chen, Jincheng Yu, Chongjian Ge, Lewei Yao, Enze Xie, Yue Wu, Zhongdao Wang, James Kwok, Ping Luo, Huchuan Lu et Zhenguo Li.

L'abstract de l'article est :

*Dans cet article, nous présentons PixArt-Σ, un modèle Diffusion Transformer (DiT) capable de générer directement des images en résolution 4K. PixArt-Σ représente une avancée significative par rapport à son prédécesseur, PixArt-α, offrant des images d’une fidélité nettement supérieure et un meilleur alignement avec les prompts texte. Une caractéristique clé de PixArt-Σ est son efficacité d’entraînement. En s’appuyant sur le pré-entraînement de base de PixArt-α, il évolue d’une ligne de base « plus faible » vers un modèle « plus fort » en intégrant des données de qualité supérieure, un processus que nous appelons « entraînement faible-vers-fort ». Les progrès de PixArt-Σ sont doubles : (1) Données d’entraînement de haute qualité : PixArt-Σ intègre des données d’images de qualité supérieure, associées à des légendes d’images plus précises et détaillées. (2) Compression efficace des jetons : nous proposons un module d’attention novateur au sein du cadre DiT qui compresse à la fois les clés et les valeurs, améliorant considérablement l’efficacité et facilitant la génération d’images en ultra-haute résolution. Grâce à ces améliorations, PixArt-Σ atteint une qualité d’image et une capacité d’adhésion aux prompts utilisateur supérieures, avec une taille de modèle nettement plus petite (0,6 milliard de paramètres) que les modèles de diffusion texte-vers-image existants, tels que SDXL (2,6 milliards de paramètres) et SD Cascade (5,1 milliards de paramètres). De plus, la capacité de PixArt-Σ à générer des images 4K soutient la création d’affiches et de fonds d’écran en haute résolution, renforçant efficacement la production de contenu visuel de haute qualité dans des industries telles que le cinéma et le jeu vidéo.*

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

Quelques notes sur ce pipeline :

* Il utilise un backbone Transformer (au lieu d'un UNet) pour le débruitage. Il présente donc une architecture similaire à celle de [DiT](https://hf.co/docs/transformers/model_doc/dit).
* Il a été entraîné à l'aide de conditions textuelles calculées à partir de T5. Cet aspect rend le pipeline plus performant pour suivre des prompts textuels complexes comportant des détails élaborés.
* Il excelle dans la génération d'images haute résolution avec différents rapports d'aspect. Pour obtenir les meilleurs résultats, les auteurs recommandent certaines plages de tailles, que l'on peut trouver [ici](https://github.com/PixArt-alpha/PixArt-sigma/blob/master/diffusion/data/datasets/utils.py).
* Il rivalise avec la qualité des systèmes de génération d’images à partir de texte les plus avancés (à la date de rédaction), tels que PixArt-α, Stable Diffusion XL, Playground V2.0 et DALL-E 3, tout en étant plus efficace qu’eux.
* Elle démontre la capacité à générer des images en très haute résolution, telles que 2048 px ou même 4K.
* Cela montre que les modèles de texte vers image peuvent passer d'un modèle faible à un modèle plus performant grâce à plusieurs améliorations (VAE, jeux de données, etc.).

> [!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 [PixArtSigmaPipeline](/docs/diffusers/v0.43.0/fr/api/pipelines/pixart_sigma#diffusers.PixArtSigmaPipeline) au modèle [SDXL refiner](./stable_diffusion/stable_diffusion_xl#base-to-refiner-model).

## Inférence avec moins de 8 Go de VRAM GPU

Exécutez le [PixArtSigmaPipeline](/docs/diffusers/v0.43.0/fr/api/pipelines/pixart_sigma#diffusers.PixArtSigmaPipeline) avec moins de 8 Go de VRAM GPU en chargeant l'encodeur de texte en précision 8 bits. Passons en revue un exemple complet.

Installez d'abord la bibliothèque [bitsandbytes](https://github.com/TimDettmers/bitsandbytes) :

```bash
pip install -U bitsandbytes
```

Chargez ensuite l'encodeur de texte en 8 bits :

```python
from transformers import T5EncoderModel
from diffusers import PixArtSigmaPipeline
import torch

text_encoder = T5EncoderModel.from_pretrained(
    "PixArt-alpha/PixArt-Sigma-XL-2-1024-MS",
    subfolder="text_encoder",
    load_in_8bit=True,
    device_map="auto",
)
pipe = PixArtSigmaPipeline.from_pretrained(
    "PixArt-alpha/PixArt-Sigma-XL-2-1024-MS",
    text_encoder=text_encoder,
    transformer=None,
    device_map="balanced"
)
```

Maintenant, utilisez `pipe` pour encoder un prompt :

```python
with torch.no_grad():
    prompt = "cute cat"
    prompt_embeds, prompt_attention_mask, negative_embeds, negative_prompt_attention_mask = pipe.encode_prompt(prompt)
```

Les embeddings de texte ayant été calculés, supprimez `text_encoder` et `pipe` de la mémoire et libérez de la VRAM GPU :

```python
import gc

def flush():
    gc.collect()
    torch.cuda.empty_cache()

del text_encoder
del pipe
flush()
```

Puis calculez les latents en utilisant les embeddings du prompt comme entrées :

```python
pipe = PixArtSigmaPipeline.from_pretrained(
    "PixArt-alpha/PixArt-Sigma-XL-2-1024-MS",
    text_encoder=None,
    dtype=torch.float16,
).to("cuda")  # or "mps", "xpu", "cpu"

latents = pipe(
    negative_prompt=None,
    prompt_embeds=prompt_embeds,
    negative_prompt_embeds=negative_embeds,
    prompt_attention_mask=prompt_attention_mask,
    negative_prompt_attention_mask=negative_prompt_attention_mask,
    num_images_per_prompt=1,
    output_type="latent",
).images

del pipe.transformer
flush()
```

> [!TIP]
> Remarquez qu'à l'initialisation de `pipe`, vous définissez `text_encoder` sur `None` afin qu'il ne soit pas chargé.

Une fois les latents calculés, passez-les au VAE pour les décoder en une image réelle :

```python
with torch.no_grad():
    image = pipe.vae.decode(latents / pipe.vae.config.scaling_factor, return_dict=False)[0]
image = pipe.image_processor.postprocess(image, output_type="pil")[0]
image.save("cat.png")
```

En supprimant les composants que vous n'utilisez pas et en vidant la VRAM du GPU, vous devriez pouvoir exécuter [PixArtSigmaPipeline](/docs/diffusers/v0.43.0/fr/api/pipelines/pixart_sigma#diffusers.PixArtSigmaPipeline) avec moins de 8 Go de VRAM GPU.

![](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/diffusers/pixart/8bits_cat.png)

Si vous souhaitez un rapport de votre utilisation de la mémoire, exécutez ce [script](https://gist.github.com/sayakpaul/3ae0f847001d342af27018a96f467e4e).

> [!WARNING]
> Les embeddings de texte calculés en 8 bits peuvent affecter la qualité des images générées en raison de la perte d'information dans l'espace de représentation causée par la précision réduite. Il est recommandé de comparer les sorties avec et sans 8 bits.

Lors du chargement du `text_encoder`, vous avez défini `load_in_8bit` sur `True`. Vous pouvez également spécifier `load_in_4bit` pour réduire encore davantage vos besoins en mémoire, à moins de 7 Go.

## PixArtSigmaPipeline[[diffusers.PixArtSigmaPipeline]]

#### diffusers.PixArtSigmaPipeline[[diffusers.PixArtSigmaPipeline]]

```python
diffusers.PixArtSigmaPipeline(tokenizer: T5Tokenizer, text_encoder: T5EncoderModel, vae: AutoencoderKL, transformer: PixArtTransformer2DModel, scheduler: KarrasDiffusionSchedulers)
```

[Source](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/pipelines/pixart_alpha/pipeline_pixart_sigma.py#L185)

**Paramètres :**

vae ([AutoencoderKL](/docs/diffusers/v0.43.0/fr/api/models/autoencoderkl#diffusers.AutoencoderKL)) : Modèle de Variational Auto-Encoder (VAE) pour encoder et décoder des images vers et depuis des représentations latentes.

text_encoder (`T5EncoderModel`) : encodeur de texte figé. PixArt-Alpha utilise [T5](https://huggingface.co/docs/transformers/model_doc/t5#transformers.T5EncoderModel), plus précisément la variante [t5-v1_1-xxl](https://huggingface.co/PixArt-alpha/PixArt-alpha/tree/main/t5-v1_1-xxl).

tokenizer (`T5Tokenizer`) : Tokenizer de la classe [T5Tokenizer](https://huggingface.co/docs/transformers/model_doc/t5#transformers.T5Tokenizer).

transformer ([PixArtTransformer2DModel](/docs/diffusers/v0.43.0/fr/api/models/pixart_transformer2d#diffusers.PixArtTransformer2DModel)) : Un `PixArtTransformer2DModel` conditionné par le texte pour débruyer les latents d'image encodés. Initialement publié sous le nom [`Transformer2DModel`](https://huggingface.co/PixArt-alpha/PixArt-Sigma-XL-2-1024-MS/blob/main/transformer/config.json#L2) dans la configuration, mais cette incohérence peut être ignorée.

scheduler ([SchedulerMixin](/docs/diffusers/v0.43.0/fr/api/schedulers/overview#diffusers.SchedulerMixin)) : Un scheduler à utiliser en combinaison avec `transformer` pour débruyer les latents d'image encodés.

Pipeline pour la génération d'images à partir de texte utilisant PixArt-Sigma.

Ce modèle hérite de [DiffusionPipeline](/docs/diffusers/v0.43.0/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.).

#### __appel__[[diffusers.PixArtSigmaPipeline.__call__]]

```python
__call__(prompt: str | list[str] = None, negative_prompt: str = '', num_inference_steps: int = 20, timesteps: list[int] = None, sigmas: list[float] = None, guidance_scale: float = 4.5, num_images_per_prompt: int | None = 1, height: int | None = None, width: int | None = None, eta: float = 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_attention_mask: typing.Optional[torch.Tensor] = None, negative_prompt_embeds: typing.Optional[torch.Tensor] = None, negative_prompt_attention_mask: typing.Optional[torch.Tensor] = None, output_type: str | None = 'pil', return_dict: bool = True, callback: typing.Optional[typing.Callable[[int, int, torch.Tensor], NoneType]] = None, callback_steps: int = 1, clean_caption: bool = True, use_resolution_binning: bool = True, max_sequence_length: int = 300, **kwargs)
```

[Source](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/pipelines/pixart_alpha/pipeline_pixart_sigma.py#L631)

**Paramètres :**

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

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`).

num_inference_steps (`int`, *facultatif*, valeur par défaut 100) : 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.

timesteps (`list[int]`, *facultatif*) : Étapes de temps personnalisées à utiliser pour le processus de débruitage avec les planificateurs qui prennent en charge un argument `timesteps` dans leur méthode `set_timesteps`. S'il n'est pas défini, le comportement par défaut lorsque `num_inference_steps` est passé sera utilisé. Doit être dans l'ordre décroissant.

sigmas (`list[float]`, *facultatif*) : Sigmas personnalisés à utiliser pour le processus de débruitage avec les planificateurs qui prennent en charge un argument `sigmas` dans leur méthode `set_timesteps`. S'ils ne sont pas définis, le comportement par défaut lorsque `num_inference_steps` est passé sera utilisé.

guidance_scale (`float`, *facultatif*, valeur par défaut 4,5) : Échelle de guidage telle que définie dans [Classifier-Free Diffusion Guidance](https://huggingface.co/papers/2207.12598). `guidance_scale` est défini comme `w` de l'équation 2. de [Imagen Paper](https://huggingface.co/papers/2205.11487). L'échelle de guidage est activée en définissant `guidance_scale > 1`. Une échelle de guidage plus élevée encourage la génération d'images étroitement liées au `prompt` texte, généralement au détriment de la qualité de l'image.

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

height (`int`, *facultatif*, par défaut self.unet.config.sample_size) : La hauteur en pixels de l'image générée.

width (`int`, *facultatif*, par défaut self.unet.config.sample_size) : La largeur en pixels de l'image générée.

eta (`float`, *facultatif*, valeur par défaut 0.0) : Correspond au paramètre eta (η) du papier DDIM : https://huggingface.co/papers/2010.02502. S'applique uniquement à [schedulers.DDIMScheduler](/docs/diffusers/v0.43.0/fr/api/schedulers/ddim#diffusers.DDIMScheduler), sera ignoré pour les autres.

generator (`torch.Generator` ou `list[torch.Generator]`, *facultatif*) : Un ou une liste de [générateurs torch](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 sera 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, *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`.

prompt_attention_mask (`torch.Tensor`, *facultatif*) : Masque d'attention pré-généré pour les embeddings de texte.

negative_prompt_embeds (`torch.Tensor`, *facultatif*) : Incrustations de texte négatif pré-générées. Pour PixArt-Sigma, ce prompt négatif doit être "". S'il n'est pas fourni, negative_prompt_embeds sera généré à partir de l'argument d'entrée `negative_prompt`.

negative_prompt_attention_mask (`torch.Tensor`, *facultatif*) : Masque d'attention pré-généré pour les embeddings de texte négatif.

output_type (`str`, *facultatif*, par défaut `"pil"`) : Le format de sortie de l'image générée. Choisissez entre [PIL](https://pillow.readthedocs.io/en/stable/) : `PIL.Image.Image` ou `np.array`.

return_dict (`bool`, *facultatif*, par défaut `True`) : Indique s'il faut retourner un `~pipelines.stable_diffusion.IFPipelineOutput` plutôt qu'un simple tuple.

callback (`Callable`, *facultatif*) : une fonction qui sera appelée toutes les `callback_steps` étapes pendant l'inférence. La fonction sera appelée avec les arguments suivants : `callback(step: int, timestep: int, latents: torch.Tensor)`.

callback_steps (`int`, *facultatif*, valeur par défaut 1) : La fréquence à laquelle la fonction `callback` sera appelée. Si non spécifié, le callback sera appelé à chaque étape.

clean_caption (`bool`, *facultatif*, valeur par défaut `True`) : Indique s'il faut nettoyer la légende avant de créer les embeddings. Nécessite l'installation de `beautifulsoup4` et `ftfy`. Si les dépendances ne sont pas installées, les embeddings seront créés à partir du prompt brut.

use_resolution_binning (`bool` par défaut `True`) : Si défini sur `True`, la hauteur et la largeur demandées sont d’abord mappées sur les résolutions les plus proches à l’aide de `ASPECT_RATIO_1024_BIN`. Après le décodage des latents produits en images, celles-ci sont redimensionnées pour revenir à la résolution demandée. Utile pour générer des images non carrées.

max_sequence_length (`int` par défaut 300) : Longueur maximale de la séquence à utiliser avec le `prompt`.

**Retourne :** [ImagePipelineOutput](/docs/diffusers/v0.43.0/fr/api/pipelines/consistency_models#diffusers.ImagePipelineOutput) ou `tuple`

Si `return_dict` est `True`, [ImagePipelineOutput](/docs/diffusers/v0.43.0/fr/api/pipelines/consistency_models#diffusers.ImagePipelineOutput) est retourné, sinon un `tuple` est retourné dont le premier élément est une liste contenant les images générées

Fonction appelée lors de l'appel du pipeline pour la génération.

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

>>> # You can replace the checkpoint id with "PixArt-alpha/PixArt-Sigma-XL-2-512-MS" too.
>>> pipe = PixArtSigmaPipeline.from_pretrained(
...     "PixArt-alpha/PixArt-Sigma-XL-2-1024-MS", torch_dtype=torch.float16
... )
>>> # Enable memory optimizations.
>>> # pipe.enable_model_cpu_offload()

>>> prompt = "A small cactus with a happy face in the Sahara desert."
>>> image = pipe(prompt).images[0]
```

#### encode_prompt[[diffusers.PixArtSigmaPipeline.encode_prompt]]

```python
encode_prompt(prompt: str | list[str], do_classifier_free_guidance: bool = True, negative_prompt: str = '', num_images_per_prompt: int = 1, device: typing.Optional[torch.device] = 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, clean_caption: bool = False, max_sequence_length: int = 300, **kwargs)
```

[Source](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/pipelines/pixart_alpha/pipeline_pixart_sigma.py#L247)

**Paramètres :**

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

negative_prompt (`str` ou `list[str]`, *facultatif*) : Le prompt à 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 la guidance n’est pas utilisée (c’est-à-dire ignoré si `guidance_scale` est inférieur à `1`). Pour PixArt-Alpha, cela doit être "".

do_classifier_free_guidance (`bool`, *facultatif*, par défaut `True`) : indique s'il faut utiliser le guidage sans classifieur ou non

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

device : (`torch.device`, *facultatif*) : le torch device sur lequel placer les embeddings résultants

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. Pour PixArt-Alpha, il doit s'agir des embeddings de la chaîne "".

clean_caption (`bool`, par défaut `False`) : Si `True`, la fonction prétraite et nettoie la légende fournie avant l'encodage.

max_sequence_length (`int`, par défaut 300) : Longueur maximale de séquence à utiliser pour le prompt.

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

