# CogVideoXTransformer3DModel

A Diffusion Transformer model for 3D data from [CogVideoX](https://github.com/THUDM/CogVideo) was introduced in [CogVideoX: Text-to-Video Diffusion Models with An Expert Transformer](https://huggingface.co/papers/2408.06072) by Tsinghua University & ZhipuAI.

モデルは、以下のコードスニペットで読み込むことができます。

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

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

**パラメータ:**

num_attention_heads (`int`、デフォルトは`30`) : マルチヘッドアテンションで使用するヘッド数。

attention_head_dim (`int`、デフォルトは`64`) : 各ヘッドのチャネル数。

in_channels (`int`、デフォルトは`16`) : 入力におけるチャネル数。

out_channels (`int`、*任意*、デフォルトは`16`) : 出力のチャネル数。

flip_sin_to_cos (`bool`、デフォルトは`True`) : 時間埋め込みにおいて sin を cos に反転させるかどうか。

time_embed_dim (`int`、デフォルトは`512`) : タイムステップ埋め込みの出力次元数。

ofs_embed_dim (`int`、デフォルトは`512`) : CogVideoX-5b-I2Bのバージョン1.5で使用される"ofs"埋め込みの出力次元

text_embed_dim (`int`、デフォルトは`4096`) : テキストエンコーダーからのテキスト埋め込みの入力次元数。

num_layers (`int`、デフォルトは`30`) : 使用する Transformer ブロックの層数。

dropout (`float`、デフォルトは`0.0`) : 使用する dropout の確率。

attention_bias (`bool`、デフォルトは`True`) : 注意機構の投影層でバイアスを使用するかどうか。

sample_width (`int`、デフォルトは`90`) : 入力潜変数の幅。

sample_height (`int`、デフォルトは`60`) : 入力ラテンツの縦幅。

sample_frames (`int`、デフォルトは`49`) : 入力潜在変数のフレーム数です。CogVideoXはデフォルトおよび推奨設定において13の潜在フレームを一度に処理していたため、このパラメータは本来13であるべきところを誤って49に初期化されています。ただし、後方互換性を確保するため、正しい値に変更することはできません。K個の潜在フレームを持つtransformerを作成する場合、ここで渡すべき正しい値は((K - 1) * temporal_compression_ratio + 1)です。

patch_size (`int`、デフォルトは`2`) : パッチ埋め込み層で使用するパッチのサイズ。

temporal_compression_ratio (`int`、デフォルトは`4`) : 時間軸方向の圧縮率。`sample_frames`のドキュメントを参照してください。

max_text_seq_length (`int`、デフォルトは`226`) : 入力テキスト埋め込みの最大シーケンス長。

activation_fn (`str`、デフォルトは `"gelu-approximate"`) : feed-forward で使用する活性化関数。

timestep_activation_fn (`str`、デフォルトは`"silu"`) : タイムステップ埋め込みを生成する際に使用する活性化関数。

norm_elementwise_affine (`bool`、デフォルトは`True`) : 正規化レイヤーで要素ごとのアフィン変換を使用するかどうか。

norm_eps (`float`、デフォルトは`1e-5`) : 正規化層で使用するepsilon値。

spatial_interpolation_scale (`float`、デフォルトは`1.875`) : 空間次元全体にわたる3次元位置埋め込みに適用するスケーリング係数。

temporal_interpolation_scale (`float`、デフォルトは`1.0`) : 時間軸次元全体にわたる3次元位置埋め込みに適用するスケーリング係数。

[CogVideoX](https://github.com/THUDM/CogVideo)における動画類似データ向けのTransformerモデル。

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

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

**パラメータ:**

hidden_states (`torch.Tensor`、形状 `(batch_size, num_frames, channels, height, width)`) : 入力 `hidden_states`。

encoder_hidden_states (`torch.Tensor`、shape `(batch_size, sequence_len, embed_dims)`) : 使用する条件埋め込み（プロンプトなどの入力条件から計算される埋め込み）。

timestep (`torch.LongTensor`) : デノイジングステップを示すために使用されます。

timestep_cond (`torch.Tensor`, *任意*) : タイムステップ用の条件付き埋め込みです。指定された場合、これらの埋め込みは `self.time_embedding` レイヤーを通過したサンプルに加算され、最終的なタイムステップ埋め込みが得られます。

ofs (`torch.Tensor`, *任意*) : CogVideoX-5b-I2V で使用されるオフセット埋め込み。

image_rotary_emb (`tuple` of `torch.Tensor`, *任意*) : 事前計算された回転位置埋め込み。

attention_kwargs (`dict`, *任意*) : 指定された場合、[diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py) の `self.processor` で定義されている `AttentionProcessor` に渡される kwargs の辞書です。

return_dict (`bool`、*任意*、デフォルトは`True`) : プレーンなタプルではなく`~models.transformer_2d.Transformer2DModelOutput`を返すかどうか。

**戻り値:**

`return_dict` が True の場合、`~models.transformer_2d.Transformer2DModelOutput` が返され、それ以外の場合は、最初の要素がサンプルテンソルである `tuple` が返されます。

[CogVideoXTransformer3DModel](/docs/diffusers/main/ja/api/models/cogvideox_transformer3d#diffusers.CogVideoXTransformer3DModel)のforwardメソッドです。

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

```python
fuse_qkv_projections()
```

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

融合されたQKV投影を有効にします。自己注意（self-attention）モジュールでは、すべての投影行列（つまり、クエリ、キー、バリュー）が融合されます。相互注意（cross-attention）モジュールでは、キーとバリューの投影行列が融合されます。

> [!WARNING] > このAPIは🧪実験的です。

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

```python
unfuse_qkv_projections()
```

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

有効化されている場合、融合された QKV 投影を無効にします。

> [!WARNING] > このAPIは🧪実験的です。

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

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

**パラメータ:**

sample (`torch.Tensor`、shape は `(batch_size, num_channels, height, width)`、または [Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel) が離散型の場合 `(batch size, num_vector_embeds - 1, num_latent_pixels)`) : `encoder_hidden_states` 入力を条件とする隠れ状態の出力です。離散型の場合、ノイズ除去されていない潜在ピクセルの確率分布を返します。

[Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel)の出力です。