# CogVideoXTransformer3DModel

[CogVideoX](https://github.com/THUDM/CogVideo)'ten 3D veriler için bir Diffusion Transformer modeli, Tsinghua University & ZhipuAI tarafından [CogVideoX: Text-to-Video Diffusion Models with An Expert Transformer](https://huggingface.co/papers/2408.06072) makalesinde tanıtılmıştır.

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

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

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

**Parametreler:**

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

attention_head_dim (`int`, varsayılan `64`) : Her baştaki kanal sayısı.

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

out_channels (`int`, *isteğe bağlı*, varsayılan `16`) : Çıktıdaki kanal sayısı.

flip_sin_to_cos (`bool`, varsayılan `True`) : Zaman gömümünde sin'in cos'a çevrilip çevrilmeyeceğini belirtir.

time_embed_dim (`int`, varsayılan `512`) : Zaman adımları gömme çıktısının boyutu.

ofs_embed_dim (`int`, varsayılan `512`) : CogVideoX-5b-I2B'nin 1.5 sürümünde kullanılan "ofs" gömme vektörlerinin çıktı boyutu

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

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

dropout (`float`, varsayılan `0.0`) : Kullanılacak dropout olasılığı.

attention_bias (`bool`, varsayılan `True`) : Dikkat projeksiyon katmanlarında sapma (bias) kullanılıp kullanılmayacağı.

sample_width (`int`, varsayılan `90`) : Girdi latentlerinin genişliği.

sample_height (`int`, varsayılan `60`) : Girdi latentlerinin yüksekliği.

sample_frames (`int`, varsayılan `49`) : Girdi latentlerindeki kare sayısı. Not: CogVideoX, varsayılan ve önerilen ayarlarında 13 latent kareyi birden işlemektedir; bu nedenle bu parametre 13 yerine yanlışlıkla 49 olarak başlatılmıştır. Ancak geriye dönük uyumluluğu sağlamak için doğru değere değiştirilemez. K latent kareli bir dönüştürücü oluşturmak için buraya geçirilmesi gereken doğru değer şudur: ((K - 1) * temporal_compression_ratio + 1).

patch_size (`int`, varsayılan `2`) : Yama gömme katmanında kullanılacak yamaların boyutu.

temporal_compression_ratio (`int`, varsayılan `4`) : Zaman boyutu boyunca sıkıştırma oranı. `sample_frames` belgelendirmesine bakın.

max_text_seq_length (`int`, varsayılan `226`) : Girdi metin gömme dizilerinin en uzun uzunluğu.

activation_fn (`str`, varsayılan `"gelu-approximate"`) : İleri beslemeli ağda kullanılacak aktivasyon fonksiyonu.

timestep_activation_fn (`str`, varsayılan `"silu"`) : Zaman adımları gömmelemelerini üretirken kullanılacak aktivasyon fonksiyonu.

norm_elementwise_affine (`bool`, varsayılan `True`) : Normalizasyon katmanlarında öge bazlı afin dönüşümün kullanılıp kullanılmayacağı.

norm_eps (`float`, varsayılan `1e-5`) : Normalizasyon katmanlarında kullanılacak epsilon değeri.

spatial_interpolation_scale (`float`, varsayılan `1.875`) : Uzamsal boyutlar boyunca 3B konumsal gömme uygulamalarında uygulanacak ölçekleme faktörü.

temporal_interpolation_scale (`float`, varsayılan `1.0`) : 3B konumsal gömme (positional embeddings) içinde zaman boyutları boyunca uygulanacak ölçekleme faktörü.

[CogVideoX](https://github.com/THUDM/CogVideo) içinde video benzeri veriler için bir Transformer modeli.

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

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

**Parametreler:**

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

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

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

timestep_cond (`torch.Tensor`, *isteğe bağlı*) : Zaman adımı için koşullu gömme. Sağlanırsa, gömmeler `self.time_embedding` katmanından geçirilen örneklerle toplanarak nihai zaman adımı gömmeleri elde edilir.

ofs (`torch.Tensor`, *isteğe bağlı*) : CogVideoX-5b-I2V'de kullanılan ofset gömme değerleri.

image_rotary_emb (`tuple` of `torch.Tensor`, *isteğe bağlı*) : Ön hesaplanmış döner konumsal gömme (embedding) değerleri.

attention_kwargs (`dict`, *isteğe bağlı*) : Belirtilirse, [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py) içinde `self.processor` altında tanımlanan `AttentionProcessor`'a iletilen bir kwargs sözlüğü.

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.

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

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

```python
fuse_qkv_projections()
```

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

Füzyonlu QKV projeksiyonlarını etkinleştirir. Kendi dikkat (self-attention) modülleri için tüm projeksiyon matrisleri (yani sorgu, anahtar, değer) füzyonlanır. Çapraz dikkat (cross-attention) modülleri için anahtar ve değer projeksiyon matrisleri füzyonlanır.

> [!WARNING] > Bu API 🧪 deneyseldir.

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

```python
unfuse_qkv_projections()
```

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

Etkinleştirilmişse birleşik QKV projeksiyonunu devre dışı bırakır.

> [!WARNING] > Bu API 🧪 deneyseldir.

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