# Flux2Transformer2DModel

Un modèle Transformer pour des données de type image issu de [Flux2](https://hf.co/black-forest-labs/FLUX.2-dev).

## Flux2Transformer2DModel[[diffusers.Flux2Transformer2DModel]]

#### diffusers.Flux2Transformer2DModel[[diffusers.Flux2Transformer2DModel]]

```python
diffusers.Flux2Transformer2DModel(patch_size: int = 1, in_channels: int = 128, out_channels: int | None = None, num_layers: int = 8, num_single_layers: int = 48, attention_head_dim: int = 128, num_attention_heads: int = 48, joint_attention_dim: int = 15360, timestep_guidance_channels: int = 256, mlp_ratio: float = 3.0, axes_dims_rope: tuple[int, ...] = (32, 32, 32, 32), rope_theta: int = 2000, eps: float = 1e-06, guidance_embeds: bool = True)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_flux2.py#L1059)

**Paramètres :**

patch_size (`int`, par défaut `1`) : Taille des patches pour découper les données d'entrée en petits patches.

in_channels (`int`, par défaut `128`) : Le nombre de canaux dans l'entrée.

out_channels (`int`, *facultatif*, par défaut `None`) : Le nombre de canaux dans la sortie. S'il n'est pas spécifié, il est défini sur `in_channels` par défaut.

num_layers (`int`, par défaut `8`) : Le nombre de blocs DiT à double flux à utiliser.

num_single_layers (`int`, par défaut `48`) : Le nombre de blocs DiT à flux unique à utiliser.

attention_head_dim (`int`, par défaut `128`) : Le nombre de dimensions à utiliser pour chaque tête d'attention.

num_attention_heads (`int`, par défaut `48`) : Le nombre de têtes d'attention à utiliser.

joint_attention_dim (`int`, par défaut `15360`) : Le nombre de dimensions à utiliser pour l'attention conjointe (dimension d'incorporation/canal de `encoder_hidden_states`).

pooled_projection_dim (`int`, par défaut `768`) : Le nombre de dimensions à utiliser pour la projection agrégée.

guidance_embeds (`bool`, par défaut `True`) : Indique s'il faut utiliser des embeddings de guidance pour la variante du modèle distillée par guidance.

axes_dims_rope (`tuple[int]`, par défaut `(32, 32, 32, 32)`) : Les dimensions à utiliser pour les embeddings positionnels rotatifs.

Le modèle Transformer introduit dans Flux 2.

Référence : https://blackforestlabs.ai/announcing-black-forest-labs/

#### forward[[diffusers.Flux2Transformer2DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor = None, timestep: LongTensor = None, img_ids: Tensor = None, txt_ids: Tensor = None, guidance: Tensor = None, joint_attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True, kv_cache: Flux2KVCache | None = None, kv_cache_mode: str | None = None, num_ref_tokens: int = 0, ref_fixed_timestep: float = 0.0)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_flux2.py#L1225)

**Paramètres :**

hidden_states (`torch.Tensor` de forme `(batch_size, image_sequence_length, in_channels)`) : `hidden_states` d'entrée.

encoder_hidden_states (`torch.Tensor` de forme `(batch_size, text_sequence_length, joint_attention_dim)`) : Embeddings conditionnels (embeddings calculés à partir des conditions d'entrée, telles que les prompts) à utiliser.

timestep (`torch.LongTensor`) : Utilisé pour indiquer l'étape de débruitage.

img_ids (`torch.Tensor`) : Identifiants de position d'image utilisés pour calculer les embeddings positionnels rotatifs.

txt_ids (`torch.Tensor`) : Identifiants de position du texte utilisés pour calculer les embeddings positionnels rotatifs.

guidance (`torch.Tensor`, *facultatif*) : Embedding d'échelle de guidage utilisé pour les variantes du modèle distillées par guidage.

joint_attention_kwargs (`dict`, *facultatif*) : Un dictionnaire de kwargs qui, s'il est spécifié, est transmis à l'`AttentionProcessor` tel que défini sous `self.processor` dans [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

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

kv_cache (`Flux2KVCache`, *facultatif*) : cache KV pour les jetons de l’image de référence. Lorsque `kv_cache_mode` est "extract", un nouveau cache est créé et renvoyé. Lorsque "cached", le cache fourni est utilisé pour injecter les K/V de référence pendant l’attention.

kv_cache_mode (`str`, *facultatif*) : L'un des éléments « extract » (première étape avec des jetons de référence) ou « cached » (étapes suivantes utilisant les K/V de référence mis en cache). Lorsque `None`, passe avant standard sans mise en cache des KV.

num_ref_tokens (`int`, par défaut `0`) : Nombre de jetons d'image de référence ajoutés en préfixe à `hidden_states` (utilisé uniquement lorsque `kv_cache_mode="extract"`).

ref_fixed_timestep (`float`, par défaut `0.0`) : Pas de temps fixe pour la modulation des jetons de référence (utilisé uniquement lorsque `kv_cache_mode="extract"`).

**Retourne :**

Si `return_dict` est True, un `~models.transformer_2d.Transformer2DModelOutput` est renvoyé, sinon un `tuple` dont le premier élément est le tenseur d'échantillon. Lorsque `kv_cache_mode="extract"`, renvoie également le `Flux2KVCache` rempli.

La méthode forward du [Flux2Transformer2DModel](/docs/diffusers/main/fr/api/models/flux2_transformer#diffusers.Flux2Transformer2DModel).

## Flux2Transformer2DModelOutput[[diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput]]

#### diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput[[diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput]]

```python
diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput(sample: torch.Tensor, kv_cache: Flux2KVCache | None = None)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_flux2.py#L46)

**Paramètres :**

sample (`torch.Tensor` de forme `(batch_size, num_channels, height, width)`) : Les états cachés en sortie, conditionnés par l'entrée `encoder_hidden_states`.

kv_cache (`Flux2KVCache`, *facultatif*) : Le cache KV rempli pour les jetons de l'image de référence. N'est renvoyé que lorsque `kv_cache_mode="extract"`.

La sortie de [Flux2Transformer2DModel](/docs/diffusers/main/fr/api/models/flux2_transformer#diffusers.Flux2Transformer2DModel).