# CogVideoXTransformer3DModel

Un modèle Diffusion Transformer pour des données 3D issu de [CogVideoX](https://github.com/THUDM/CogVideo) a été introduit dans [CogVideoX: Text-to-Video Diffusion Models with An Expert Transformer](https://huggingface.co/papers/2408.06072) par l'Université Tsinghua et ZhipuAI.

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

```python
from diffusers import CogVideoXTransformer3DModel

transformer = CogVideoXTransformer3DModel.from_pretrained("THUDM/CogVideoX-2b", subfolder="transformer", dtype=torch.float16).to("cuda")  # or "mps", "xpu", "cpu"
```

## CogVideoXTransformer3DModel[[diffusers.CogVideoXTransformer3DModel]]

#### diffusers.CogVideoXTransformer3DModel[[diffusers.CogVideoXTransformer3DModel]]

```python
diffusers.CogVideoXTransformer3DModel(num_attention_heads: int = 30, attention_head_dim: int = 64, in_channels: int = 16, out_channels: int | None = 16, flip_sin_to_cos: bool = True, freq_shift: int = 0, time_embed_dim: int = 512, ofs_embed_dim: int | None = None, text_embed_dim: int = 4096, num_layers: int = 30, dropout: float = 0.0, attention_bias: bool = True, sample_width: int = 90, sample_height: int = 60, sample_frames: int = 49, patch_size: int = 2, patch_size_t: int | None = None, temporal_compression_ratio: int = 4, max_text_seq_length: int = 226, activation_fn: str = 'gelu-approximate', timestep_activation_fn: str = 'silu', norm_elementwise_affine: bool = True, norm_eps: float = 1e-05, spatial_interpolation_scale: float = 1.875, temporal_interpolation_scale: float = 1.0, use_rotary_positional_embeddings: bool = False, use_learned_positional_embeddings: bool = False, patch_bias: bool = True)
```

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

**Paramètres :**

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

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

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

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

flip_sin_to_cos (`bool`, par défaut `True`) : Indique s'il faut inverser le sin en cos dans l'encodage temporel.

time_embed_dim (`int`, par défaut `512`) : Dimension de sortie des embeddings de pas de temps.

ofs_embed_dim (`int`, par défaut `512`) : Dimension de sortie des embeddings « ofs » utilisés dans CogVideoX-5b-I2B en version 1.5

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

num_layers (`int`, par défaut `30`) : Le nombre de blocs Transformer à utiliser.

dropout (`float`, par défaut `0.0`) : La probabilité de dropout à utiliser.

attention_bias (`bool`, par défaut `True`) : Indique s'il faut utiliser un biais dans les couches de projection d'attention.

sample_width (`int`, par défaut `90`) : La largeur des latents d'entrée.

sample_height (`int`, par défaut `60`) : La hauteur des latents d'entrée.

sample_frames (`int`, par défaut `49`) : Le nombre de frames dans les latents d’entrée. Notez que ce paramètre a été initialisé à tort à 49 au lieu de 13, car CogVideoX traitait 13 frames latentes à la fois dans ses réglages par défaut et recommandés, mais sa valeur ne peut pas être corrigée afin de garantir la rétrocompatibilité. Pour créer un transformer avec K frames latentes, la valeur correcte à passer ici est : ((K - 1) * temporal_compression_ratio + 1).

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

temporal_compression_ratio (`int`, par défaut `4`) : Le ratio de compression le long de la dimension temporelle. Consultez la documentation de `sample_frames`.

max_text_seq_length (`int`, par défaut `226`) : La longueur de séquence maximale des embeddings de texte en entrée.

activation_fn (`str`, par défaut `"gelu-approximate"`) : Fonction d'activation à utiliser dans le réseau de neurones à propagation avant.

timestep_activation_fn (`str`, par défaut `"silu"`) : Fonction d'activation à utiliser lors de la génération des embeddings de pas de temps.

norm_elementwise_affine (`bool`, par défaut `True`) : Indique s'il faut utiliser une transformation affine élément par élément dans les couches de normalisation.

norm_eps (`float`, par défaut `1e-5`) : La valeur epsilon à utiliser dans les couches de normalisation.

spatial_interpolation_scale (`float`, par défaut `1.875`) : Facteur d'échelle à appliquer aux embeddings positionnels 3D sur les dimensions spatiales.

temporal_interpolation_scale (`float`, par défaut `1.0`) : Facteur d'échelle à appliquer aux embeddings positionnels 3D le long des dimensions temporelles.

Un modèle Transformer pour des données de type vidéo dans [CogVideoX](https://github.com/THUDM/CogVideo).

#### forward[[diffusers.CogVideoXTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: typing.Union[int, float, torch.LongTensor], timestep_cond: typing.Optional[torch.Tensor] = None, ofs: typing.Union[int, float, torch.LongTensor, NoneType] = None, image_rotary_emb: tuple[torch.Tensor, torch.Tensor] | None = None, attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True)
```

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

**Paramètres :**

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

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.

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

timestep_cond (`torch.Tensor`, *facultatif*) : Incrustations conditionnelles pour le pas de temps. Si fournies, les incrustations seront additionnées aux échantillons passés par la couche `self.time_embedding` pour obtenir les incrustations finales du pas de temps.

ofs (`torch.Tensor`, *facultatif*) : Embeddings de décalage utilisés dans CogVideoX-5b-I2V.

image_rotary_emb (`tuple` de `torch.Tensor`, *facultatif*) : Incrustations positionnelles rotatives précalculées.

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 [CogVideoXTransformer3DModel](/docs/diffusers/main/fr/api/models/cogvideox_transformer3d#diffusers.CogVideoXTransformer3DModel).

#### fuse_qkv_projections[[diffusers.CogVideoXTransformer3DModel.fuse_qkv_projections]]

```python
fuse_qkv_projections()
```

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

Active les projections QKV fusionnées. Pour les modules d'auto-attention, toutes les matrices de projection (c'est-à-dire requête, clé, valeur) sont fusionnées. Pour les modules d'attention croisée, les matrices de projection des clés et des valeurs sont fusionnées.

> [!WARNING] > Cette API est 🧪 expérimentale.

#### unfuse_qkv_projections[[diffusers.CogVideoXTransformer3DModel.unfuse_qkv_projections]]

```python
unfuse_qkv_projections()
```

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

Désactive la projection QKV fusionnée si elle est activée.

> [!WARNING] > Cette API est 🧪 expérimentale.

## 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/main/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/main/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/main/fr/api/models/transformer2d#diffusers.Transformer2DModel).