# CosmosTransformer3DModel

Model Diffusion Transformer untuk data video 3D diperkenalkan dalam [Cosmos World Foundation Model Platform for Physical AI](https://huggingface.co/papers/2501.03575) oleh NVIDIA.

Model dapat dimuat dengan potongan kode berikut.

```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)
```

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

**Parameter:**

in_channels (`int`, defaultnya `16`) : Jumlah channel pada input.

out_channels (`int`, defaultnya `16`) : Jumlah channel pada output.

num_attention_heads (`int`, defaultnya `32`) : Jumlah kepala yang digunakan untuk multi-head attention.

attention_head_dim (`int`, defaultnya `128`) : Jumlah channel di setiap attention head.

num_layers (`int`, defaultnya `28`) : Jumlah lapisan blok transformer yang akan digunakan.

mlp_ratio (`float`, defaultnya `4.0`) : Rasio ukuran lapisan tersembunyi terhadap ukuran input dalam jaringan feedforward.

text_embed_dim (`int`, defaultnya `4096`) : Dimensi input dari embedding teks yang berasal dari text encoder.

adaln_lora_dim (`int`, defaultnya `256`) : Dimensi tersembunyi dari lapisan Adaptive LayerNorm LoRA.

max_size (`tuple[int, int, int]`, defaultnya `(128, 240, 240)`) : Ukuran maksimum tensor laten input pada dimensi temporal, tinggi, dan lebar.

patch_size (`tuple[int, int, int]`, defaultnya `(1, 2, 2)`) : Ukuran patch yang digunakan untuk mem-patchify tensor laten input pada dimensi temporal, tinggi, dan lebar.

rope_scale (`tuple[float, float, float]`, defaultnya `(2.0, 1.0, 1.0)`) : Faktor penskalaan yang digunakan untuk RoPE pada dimensi temporal, tinggi, dan lebar.

concat_padding_mask (`bool`, defaultnya `True`) : Apakah akan menggabungkan padding mask ke tensor laten input.

extra_pos_embed_type (`str`, *opsional*, defaultnya `learnable`) : Jenis embedding posisi tambahan yang akan digunakan. Bisa berupa `None` atau `learnable`.

controlnet_block_every_n (`int`, *opsional*) : Interval antar blok transformer yang harus menerima residual kontrol (misalnya, `7` untuk menyuntikkan setelah setiap blok ketujuh). Wajib untuk Cosmos Transfer2.5.

img_context_dim_in (`int`, *opsional*) : Dimensi dari vektor fitur konteks gambar input, yaitu D dalam [B, N, D].

img_context_num_tokens (`int`) : Jumlah token dalam vektor fitur konteks gambar, yaitu N dalam [B, N, D]. Jika `img_context_dim_in` tidak disediakan, maka parameter ini diabaikan.

img_context_dim_out (`int`) : Dimensi output dari lapisan proyeksi konteks gambar. Jika `img_context_dim_in` tidak disediakan, maka parameter ini diabaikan.

Model Transformer untuk data mirip video yang digunakan dalam [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)
```

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

**Parameter:**

hidden_states (`torch.Tensor` dengan bentuk `(batch_size, num_channels, num_frames, height, width)`) : Input `hidden_states`.

timestep (`torch.LongTensor`) : Digunakan untuk menunjukkan langkah denoising.

encoder_hidden_states (`torch.Tensor` dengan bentuk `(batch_size, sequence_len, embed_dims)`) : Embedding kondisional (embedding yang dihitung dari kondisi input seperti prompt) yang akan digunakan.

block_controlnet_hidden_states (`list` dari `torch.Tensor`, *opsional*) : Daftar tensor yang, jika ditentukan, akan ditambahkan ke residual blok transformer.

attention_mask (`torch.Tensor`, *opsional*) : Mask yang diterapkan pada `encoder_hidden_states` selama perhatian.

fps (`int`, *opsional*) : Frame per detik dari video input yang digunakan untuk menghitung rotary positional embeddings.

condition_mask (`torch.Tensor`, *opsional*) : Kanal mask yang digabungkan ke `hidden_states` untuk menunjukkan area kondisioning.

padding_mask (`torch.Tensor`, *opsional*) : Padding mask yang digabungkan ke `hidden_states` ketika `concat_padding_mask` diaktifkan.

return_dict (`bool`, *opsional*, defaultnya `True`) : Apakah akan mengembalikan `~models.transformer_2d.Transformer2DModelOutput` alih-alih tuple biasa.

**Mengembalikan:**

Jika `return_dict` bernilai True, sebuah `~models.transformer_2d.Transformer2DModelOutput` akan dikembalikan, selain itu sebuah `tuple` di mana elemen pertama adalah tensor sampel.

Metode forward dari [CosmosTransformer3DModel](/docs/diffusers/main/id/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)
```

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

**Parameter:**

sample (`torch.Tensor` dengan bentuk `(batch_size, num_channels, height, width)` atau `(batch size, num_vector_embeds - 1, num_latent_pixels)` jika [Transformer2DModel](/docs/diffusers/main/id/api/models/transformer2d#diffusers.Transformer2DModel) bersifat diskrit) : Output hidden states yang dikondisikan pada input `encoder_hidden_states`. Jika diskrit, mengembalikan distribusi probabilitas untuk piksel laten yang tidak berisik.

Output dari [Transformer2DModel](/docs/diffusers/main/id/api/models/transformer2d#diffusers.Transformer2DModel).