# HunyuanVideoTransformer3DModel

Un modèle Diffusion Transformer pour des données vidéo 3D a été introduit dans [HunyuanVideo: A Systematic Framework For Large Video Generative Models](https://huggingface.co/papers/2412.03603) par Tencent.

Le modèle peut être chargé à l'aide du fragment de code suivant.

```python
from diffusers import HunyuanVideoTransformer3DModel

transformer = HunyuanVideoTransformer3DModel.from_pretrained("hunyuanvideo-community/HunyuanVideo", subfolder="transformer", dtype=torch.bfloat16)
```

## HunyuanVideoTransformer3DModel[[diffusers.HunyuanVideoTransformer3DModel]]

#### diffusers.HunyuanVideoTransformer3DModel[[diffusers.HunyuanVideoTransformer3DModel]]

```python
diffusers.HunyuanVideoTransformer3DModel(in_channels: int = 16, out_channels: int = 16, num_attention_heads: int = 24, attention_head_dim: int = 128, num_layers: int = 20, num_single_layers: int = 40, num_refiner_layers: int = 2, mlp_ratio: float = 4.0, patch_size: int = 2, patch_size_t: int = 1, qk_norm: str = 'rms_norm', guidance_embeds: bool = True, text_embed_dim: int = 4096, pooled_projection_dim: int = 768, rope_theta: float = 256.0, rope_axes_dim: tuple[int, ...] = (16, 56, 56), image_condition_type: str | None = None)
```

[Source](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_hunyuan_video.py#L841)

**Paramètres :**

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

out_channels (`int`, par défaut `16`) : Le nombre de canaux dans la sortie.

num_attention_heads (`int`, par défaut `24`) : Le nombre de têtes à utiliser pour l'attention multi-têtes.

attention_head_dim (`int`, par défaut `128`) : Le nombre de canaux dans chaque tête.

num_layers (`int`, par défaut `20`) : Le nombre de blocs dual-stream à utiliser.

num_single_layers (`int`, par défaut `40`) : Le nombre de blocs single-stream à utiliser.

num_refiner_layers (`int`, par défaut `2`) : Le nombre de blocs de raffinement à utiliser.

mlp_ratio (`float`, par défaut `4.0`) : Le ratio de la taille de la couche cachée par rapport à la taille de l'entrée dans le réseau feedforward.

patch_size (`int`, par défaut `2`) : La taille des patches spatiaux à utiliser dans la couche d'encodage de patches.

patch_size_t (`int`, par défaut `1`) : La taille des patches temporels à utiliser dans la couche d'encodage de patches.

qk_norm (`str`, par défaut `rms_norm`) : La normalisation à utiliser pour les projections de requête et de clé dans les couches d'attention.

guidance_embeds (`bool`, par défaut `True`) : Indique s'il faut utiliser les embeddings de guidance dans le modèle.

text_embed_dim (`int`, par défaut `4096`) : Dimension d'entrée des embeddings de texte issus de l'encodeur de texte.

pooled_projection_dim (`int`, par défaut `768`) : La dimension de la projection agrégée des embeddings de texte.

rope_theta (`float`, par défaut `256.0`) : La valeur de theta à utiliser dans la couche RoPE.

rope_axes_dim (`tuple[int]`, par défaut `(16, 56, 56)`) : Les dimensions des axes à utiliser dans la couche RoPE.

image_condition_type (`str`, *facultatif*, valeur par défaut `None`) : Le type de conditionnement d'image à utiliser. Si `None`, aucun conditionnement d'image n'est utilisé. Si `latent_concat`, l'image est concaténée au flux latent. Si `token_replace`, l'image est utilisée pour remplacer les jetons de la première image du flux latent et appliquer le conditionnement.

Un modèle Transformer pour des données de type vidéo utilisé dans [HunyuanVideo](https://huggingface.co/tencent/HunyuanVideo).

#### forward[[diffusers.HunyuanVideoTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, timestep: LongTensor, encoder_hidden_states: Tensor, encoder_attention_mask: Tensor, pooled_projections: Tensor, guidance: Tensor = None, attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True)
```

[Source](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_hunyuan_video.py#L994)

**Paramètres :**

hidden_states (`torch.Tensor` de forme `(batch_size, num_channels, num_frames, height, width)`) : `hidden_states` d'entrée.

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

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

encoder_attention_mask (`torch.Tensor`) : Masque appliqué à `encoder_hidden_states` lors de l'attention.

pooled_projections (`torch.Tensor` de forme `(batch_size, projection_dim)`) : Embeddings projetés à partir des embeddings des conditions d'entrée.

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

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.

**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.

La méthode forward du [HunyuanVideoTransformer3DModel](/docs/diffusers/v0.43.0/fr/api/models/hunyuan_video_transformer_3d#diffusers.HunyuanVideoTransformer3DModel).

## Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]

#### diffusers.models.modeling_outputs.Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]

```python
diffusers.models.modeling_outputs.Transformer2DModelOutput(sample: torch.Tensor)
```

[Source](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/modeling_outputs.py#L21)

**Paramètres :**

sample (`torch.Tensor` de forme `(batch_size, num_channels, height, width)` ou `(batch size, num_vector_embeds - 1, num_latent_pixels)` si [Transformer2DModel](/docs/diffusers/v0.43.0/fr/api/models/transformer2d#diffusers.Transformer2DModel) est discret) : Les états cachés en sortie, conditionnés par l'entrée `encoder_hidden_states`. Si discret, renvoie les distributions de probabilité pour les pixels latents non bruités.

La sortie de [Transformer2DModel](/docs/diffusers/v0.43.0/fr/api/models/transformer2d#diffusers.Transformer2DModel).