# CosmosTransformer3DModel

Un modelo Diffusion Transformer para datos de video 3D fue introducido en [Cosmos World Foundation Model Platform for Physical AI](https://huggingface.co/papers/2501.03575) por NVIDIA.

El modelo se puede cargar con el siguiente fragmento de código.

```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[int, int, int] = (128, 240, 240), patch_size: tuple[int, int, int] = (1, 2, 2), rope_scale: tuple[float, float, float] = (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)
```

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

**Parámetros:**

in_channels (`int`, por defecto `16`) : El número de canales en la entrada.

out_channels (`int`, por defecto `16`) : El número de canales en la salida.

num_attention_heads (`int`, por defecto `32`) : El número de cabezas a utilizar para la atención multi-cabeza.

attention_head_dim (`int`, por defecto `128`) : El número de canales en cada cabeza de atención.

num_layers (`int`, por defecto `28`) : El número de bloques de transformador a utilizar.

mlp_ratio (`float`, por defecto `4.0`) : La proporción entre el tamaño de la capa oculta y el tamaño de la entrada en la red feedforward.

text_embed_dim (`int`, por defecto `4096`) : Dimensión de entrada de las incrustaciones de texto del codificador de texto.

adaln_lora_dim (`int`, por defecto `256`) : La dimensión oculta de la capa Adaptive LayerNorm LoRA.

max_size (`tuple[int, int, int]`, por defecto `(128, 240, 240)`) : El tamaño máximo de los tensores latentes de entrada en las dimensiones temporal, de altura y de ancho.

patch_size (`tuple[int, int, int]`, por defecto `(1, 2, 2)`) : El tamaño de parche a utilizar para dividir en parches los tensores latentes de entrada en las dimensiones temporal, de altura y de ancho.

rope_scale (`tuple[float, float, float]`, por defecto `(2.0, 1.0, 1.0)`) : El factor de escala a utilizar para RoPE en las dimensiones temporal, de altura y de ancho.

concat_padding_mask (`bool`, por defecto `True`) : Si se debe concatenar la máscara de relleno a los tensores latentes de entrada.

extra_pos_embed_type (`str`, *opcional*, por defecto `learnable`) : El tipo de embeddings posicionales adicionales a utilizar. Puede ser `None` o `learnable`.

controlnet_block_every_n (`int`, *opcional*) : Intervalo entre bloques de transformador que deben recibir residuos de control (por ejemplo, `7` para inyectarlos después de cada séptimo bloque). Obligatorio para Cosmos Transfer2.5.

img_context_dim_in (`int`, *opcional*) : La dimensión del vector de características de contexto de la imagen de entrada, es decir, es la D en [B, N, D].

img_context_num_tokens (`int`) : El número de tokens en el vector de características del contexto de la imagen, es decir, es la N en [B, N, D]. Si no se proporciona `img_context_dim_in`, este parámetro se ignora.

img_context_dim_out (`int`) : La dimensión de salida de la capa de proyección del contexto de imagen. Si no se proporciona `img_context_dim_in`, este parámetro se ignora.

Un modelo Transformer para datos tipo video utilizado en [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)
```

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

**Parámetros:**

hidden_states (`torch.Tensor` de forma `(batch_size, num_channels, num_frames, height, width)`) : `hidden_states` de entrada.

timestep (`torch.LongTensor`) : Se utiliza para indicar el paso de desruido.

encoder_hidden_states (`torch.Tensor` de forma `(batch_size, sequence_len, embed_dims)`) : Embeddings condicionales (embeddings calculados a partir de las condiciones de entrada, como los prompts) a utilizar.

block_controlnet_hidden_states (`list` de `torch.Tensor`, *opcional*) : Una lista de tensores que, si se especifica, se añaden a los residuos de los bloques de transformador.

attention_mask (`torch.Tensor`, *opcional*) : Máscara aplicada a `encoder_hidden_states` durante la atención.

fps (`int`, *opcional*) : Cuadros por segundo del video de entrada utilizado para calcular los embeddings posicionales rotatorios.

condition_mask (`torch.Tensor`, *opcional*) : Canal de máscara concatenado a `hidden_states` para indicar la región de condicionamiento.

padding_mask (`torch.Tensor`, *opcional*) : Máscara de relleno concatenada a `hidden_states` cuando `concat_padding_mask` está habilitado.

return_dict (`bool`, *opcional*, valor predeterminado `True`) : Indica si se debe devolver un `~models.transformer_2d.Transformer2DModelOutput` en lugar de una tupla simple.

**Devuelve:**

Si `return_dict` es True, se devuelve un `~models.transformer_2d.Transformer2DModelOutput`; en caso contrario, se devuelve una `tuple` cuyo primer elemento es el tensor de la muestra.

El método forward del [CosmosTransformer3DModel](/docs/diffusers/main/es/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)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L21)

**Parámetros:**

sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)` o `(batch size, num_vector_embeds - 1, num_latent_pixels)` si [Transformer2DModel](/docs/diffusers/main/es/api/models/transformer2d#diffusers.Transformer2DModel) es discreto): las salidas de estados ocultos condicionadas a la entrada `encoder_hidden_states`. Si es discreto, devuelve distribuciones de probabilidad para los píxeles latentes sin ruido.

La salida de [Transformer2DModel](/docs/diffusers/main/es/api/models/transformer2d#diffusers.Transformer2DModel).