# CosmosTransformer3DModel

NVIDIA tarafından [Cosmos World Foundation Model Platform for Physical AI](https://huggingface.co/papers/2501.03575) makalesinde, 3D video benzeri veriler için bir Diffusion Transformer modeli tanıtılmıştır.

Model, aşağıdaki kod parçasıyla yüklenebilir.

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

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

**Parametreler:**

in_channels (`int`, varsayılan `16`) : Girdideki kanal sayısı.

out_channels (`int`, varsayılan `16`) : Çıktıdaki kanal sayısı.

num_attention_heads (`int`, varsayılan `32`) : Çok başlı dikkat için kullanılacak baş sayısı.

attention_head_dim (`int`, varsayılan `128`) : Her dikkat başlığındaki kanal sayısı.

num_layers (`int`, varsayılan `28`) : Kullanılacak transformer bloğu katman sayısı.

mlp_ratio (`float`, varsayılan `4.0`) : İleri beslemeli ağda gizli katman boyutunun giriş boyutuna oranı.

text_embed_dim (`int`, varsayılan `4096`) : Metin kodlayıcısından gelen metin gömme girdi boyutu.

adaln_lora_dim (`int`, varsayılan `256`) : Adaptive LayerNorm LoRA katmanının gizli boyutu.

max_size (`tuple[int, int, int]`, varsayılan `(128, 240, 240)`) : Girdi latent tensörlerinin zamansal, yükseklik ve genişlik boyutlarındaki maksimum boyutu.

patch_size (`tuple[int, int, int]`, varsayılan `(1, 2, 2)`) : Zaman, yükseklik ve genişlik boyutlarında girdi latent tensörlerini parçalama (patchify) işlemi için kullanılacak yama (patch) boyutu.

rope_scale (`tuple[float, float, float]`, varsayılan `(2.0, 1.0, 1.0)`) : RoPE için zaman, yükseklik ve genişlik boyutlarında kullanılacak ölçekleme çarpanı.

concat_padding_mask (`bool`, varsayılan `True`) : Dolgu maskesinin girdi latent tensörlerine birleştirilip birleştirilmeyeceğini belirtir.

extra_pos_embed_type (`str`, *isteğe bağlı*, varsayılan `learnable`) : Kullanılacak ek konumsal gömme türü. `None` veya `learnable` değerlerinden biri olabilir.

controlnet_block_every_n (`int`, *isteğe bağlı*) : Kontrol artıkları alması gereken transformer blokları arasındaki aralık (örneğin, her yedinci bloktan sonra enjekte etmek için `7`). Cosmos Transfer2.5 için zorunludur.

img_context_dim_in (`int`, *isteğe bağlı*) : Girdi görüntü bağlamı özellik vektörünün boyutu, yani [B, N, D] içindeki D'dir.

img_context_num_tokens (`int`) : Görsel bağlam özellik vektöründeki token sayısı, yani [B, N, D] içindeki N'dir. `img_context_dim_in` sağlanmazsa bu parametre yok sayılır.

img_context_dim_out (`int`) : Görüntü bağlam projeksiyon katmanının çıktı boyutu. `img_context_dim_in` sağlanmadıysa bu parametre yok sayılır.

[Cosmos](https://github.com/NVIDIA/Cosmos)'da video benzeri verilerde kullanılan bir Transformer modeli.

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

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

**Parametreler:**

hidden_states (`torch.Tensor`, şekli `(batch_size, num_channels, num_frames, height, width)`) : Girdi `hidden_states`.

timestep (`torch.LongTensor`) : Gürültü azaltma adımını belirtmek için kullanılır.

encoder_hidden_states (`torch.Tensor`, şekli `(batch_size, sequence_len, embed_dims)`) : Kullanılacak koşullu gömlemeler (giriş koşullarından, örneğin istemlerden hesaplanan gömlemeler).

block_controlnet_hidden_states (`list` of `torch.Tensor`, *opsiyonel*) : Belirtilirse, transformer bloklarının artıklarına eklenen tensörlerin listesi.

attention_mask (`torch.Tensor`, *isteğe bağlı*) : Dikkat sırasında `encoder_hidden_states`'e uygulanan maske.

fps (`int`, *isteğe bağlı*) : Döner konumsal gömme hesaplamalarında kullanılan giriş videosunun saniyedeki kare sayısı.

condition_mask (`torch.Tensor`, *isteğe bağlı*) : Koşullandırma bölgesini belirtmek için `hidden_states`'e birleştirilen maske kanalı.

padding_mask (`torch.Tensor`, *isteğe bağlı*) : `concat_padding_mask` etkinleştirildiğinde `hidden_states`'e birleştirilen dolgu maskesi.

return_dict (`bool`, *isteğe bağlı*, varsayılan `True`) : Düz bir tuple yerine `~models.transformer_2d.Transformer2DModelOutput` döndürülüp döndürülmediğini belirtir.

**Dönüş:**

`return_dict` True ise, `~models.transformer_2d.Transformer2DModelOutput` döndürülür, aksi takdirde ilk öğesi örnek tensörü olan bir `tuple` döndürülür.

[CosmosTransformer3DModel](/docs/diffusers/main/tr/api/models/cosmos_transformer3d#diffusers.CosmosTransformer3DModel) ileri yöntemi.

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

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

**Parametreler:**

sample (`torch.Tensor`, şekli `(batch_size, num_channels, height, width)` veya [Transformer2DModel](/docs/diffusers/main/tr/api/models/transformer2d#diffusers.Transformer2DModel) ayrık (discrete) ise `(batch size, num_vector_embeds - 1, num_latent_pixels)`) : `encoder_hidden_states` girdisine koşullu gizli durum (hidden states) çıktısı. Ayrık (discrete) ise, gürültüsü olmayan (unnoised) gizli (latent) pikseller için olasılık dağılımlarını döndürür.

[Transformer2DModel](/docs/diffusers/main/tr/api/models/transformer2d#diffusers.Transformer2DModel)'nin çıktısı.