# CosmosTransformer3DModel

Un modèle Diffusion Transformer pour des données vidéo 3D a été introduit dans [Cosmos World Foundation Model Platform for Physical AI](https://huggingface.co/papers/2501.03575) par NVIDIA.

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

```python
from diffusers import CosmosTransformer3DModel

transformer = CosmosTransformer3DModel.from_pretrained("nvidia/Cosmos-1.0-Diffusion-7B-Text2World", subfolder="transformer", dtype=torch.bfloat16)
```

## CosmosTransformer3DModel[[diffusers.CosmosTransformer3DModel]]

#### diffusers.CosmosTransformer3DModel[[diffusers.CosmosTransformer3DModel]]

```python
diffusers.CosmosTransformer3DModel(in_channels: int = 16, out_channels: int = 16, num_attention_heads: int = 32, attention_head_dim: int = 128, num_layers: int = 28, mlp_ratio: float = 4.0, text_embed_dim: int = 1024, adaln_lora_dim: int = 256, max_size: tuple = (128, 240, 240), patch_size: tuple = (1, 2, 2), rope_scale: tuple = (2.0, 1.0, 1.0), concat_padding_mask: bool = True, extra_pos_embed_type: str | None = 'learnable', use_crossattn_projection: bool = False, crossattn_proj_in_channels: int = 1024, encoder_hidden_states_channels: int = 1024, controlnet_block_every_n: int | None = None, img_context_dim_in: int | None = None, img_context_num_tokens: int = 256, img_context_dim_out: int = 2048)
```

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

**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 `32`) : 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 d'attention.

num_layers (`int`, par défaut `28`) : Le nombre de blocs de transformeurs à 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.

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

adaln_lora_dim (`int`, par défaut `256`) : La dimension cachée de la couche Adaptive LayerNorm LoRA.

max_size (`tuple[int, int, int]`, par défaut `(128, 240, 240)`) : La taille maximale des tenseurs latents d'entrée dans les dimensions temporelle, de hauteur et de largeur.

patch_size (`tuple[int, int, int]`, par défaut `(1, 2, 2)`) : La taille des patches à utiliser pour la patchification des tenseurs latents d'entrée dans les dimensions temporelle, de hauteur et de largeur.

rope_scale (`tuple[float, float, float]`, par défaut `(2.0, 1.0, 1.0)`) : Le facteur d'échelle à utiliser pour RoPE dans les dimensions temporelle, hauteur et largeur.

concat_padding_mask (`bool`, par défaut `True`) : Indique s'il faut concaténer le masque de bourrage aux tenseurs latents d'entrée.

extra_pos_embed_type (`str`, *facultatif*, par défaut `learnable`) : Le type d'incrustations positionnelles supplémentaires à utiliser. Peut être `None` ou `learnable`.

controlnet_block_every_n (`int`, *facultatif*) : Intervalle entre les blocs de transformer devant recevoir des résidus de contrôle (par exemple, `7` pour injecter après chaque septième bloc). Requis pour Cosmos Transfer2.5.

img_context_dim_in (`int`, *facultatif*) : La dimension du vecteur de caractéristiques du contexte de l'image d'entrée, c'est-à-dire qu'il s'agit du D dans [B, N, D].

img_context_num_tokens (`int`) : Le nombre de jetons dans le vecteur de caractéristiques du contexte de l'image, c'est-à-dire qu'il s'agit du N dans [B, N, D]. Si `img_context_dim_in` n'est pas fourni, ce paramètre est ignoré.

img_context_dim_out (`int`) : La dimension de sortie de la couche de projection du contexte d'image. Si `img_context_dim_in` n'est pas fourni, ce paramètre est ignoré.

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

#### forward[[diffusers.CosmosTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, timestep: Tensor, encoder_hidden_states: Tensor, block_controlnet_hidden_states: list[torch.Tensor] | None = None, attention_mask: typing.Optional[torch.Tensor] = None, fps: int | None = None, condition_mask: typing.Optional[torch.Tensor] = None, padding_mask: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```

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

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

block_controlnet_hidden_states (`list` de `torch.Tensor`, *facultatif*) : Une liste de tenseurs qui, si elle est spécifiée, est ajoutée aux résidus des blocs de transformeur.

attention_mask (`torch.Tensor`, *facultatif*) : Masque appliqué à `encoder_hidden_states` lors de l'attention.

fps (`int`, *facultatif*) : Nombre d'images par seconde de la vidéo d'entrée utilisé pour calculer les embeddings positionnels rotatifs.

condition_mask (`torch.Tensor`, *facultatif*) : Canal de masque concaténé à `hidden_states` pour indiquer la région de conditionnement.

padding_mask (`torch.Tensor`, *facultatif*) : Masque de bourrage concaténé à `hidden_states` lorsque `concat_padding_mask` est activé.

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

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