# HunyuanVideoTransformer3DModel

Tencent による [HunyuanVideo: A Systematic Framework For Large Video Generative Models](https://huggingface.co/papers/2412.03603) で、3D ビデオ類似データ向けの Diffusion Transformer モデルが紹介されました。

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

```python
from diffusers import HunyuanVideoTransformer3DModel

transformer = HunyuanVideoTransformer3DModel.from_pretrained("hunyuanvideo-community/HunyuanVideo", subfolder="transformer", dtype=torch.bfloat16)
```

## HunyuanVideoTransformer3DModel[[diffusers.HunyuanVideoTransformer3DModel]]

#### diffusers.HunyuanVideoTransformer3DModel[[diffusers.HunyuanVideoTransformer3DModel]]

```python
diffusers.HunyuanVideoTransformer3DModel(in_channels: int = 16, out_channels: int = 16, num_attention_heads: int = 24, attention_head_dim: int = 128, num_layers: int = 20, num_single_layers: int = 40, num_refiner_layers: int = 2, mlp_ratio: float = 4.0, patch_size: int = 2, patch_size_t: int = 1, qk_norm: str = 'rms_norm', guidance_embeds: bool = True, text_embed_dim: int = 4096, pooled_projection_dim: int = 768, rope_theta: float = 256.0, rope_axes_dim: tuple[int, ...] = (16, 56, 56), image_condition_type: str | None = None)
```

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

**パラメータ:**

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

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

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

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

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

num_single_layers (`int`、デフォルトは`40`) : 使用する単一ストリームブロックの層数。

num_refiner_layers (`int`、デフォルトは`2`) : 使用するリファイナブロックの層数。

mlp_ratio (`float`、デフォルトは`4.0`) : フィードフォワードネットワークにおける、隠れ層サイズと入力サイズの比率。

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

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

qk_norm (`str`、デフォルトは `rms_norm`) : attention レイヤーのクエリおよびキーの射影に使用する正規化。

guidance_embeds (`bool`、デフォルトは`True`) : モデルでガイダンス埋め込みを使用するかどうか。

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

pooled_projection_dim (`int`、デフォルトは`768`) : テキスト埋め込みのプーリング投影の次元数。

rope_theta (`float`、デフォルトは`256.0`) : RoPE層で使用するthetaの値。

rope_axes_dim (`tuple[int]`、デフォルトは`(16, 56, 56)`) : RoPE層で使用する軸の次元。

image_condition_type (`str`、*任意*、デフォルトは`None`) : 使用する画像条件付けの種類。`None`の場合、画像条件付けは使用されません。`latent_concat`の場合、画像は潜在ストリームに連結されます。`token_replace`の場合、画像は潜在ストリーム内の最初のフレームのトークンを置き換え、条件付けを適用するために使用されます。

[HunyuanVideo](https://huggingface.co/tencent/HunyuanVideo)で使用される、動画のようなデータ向けのTransformerモデル。

#### forward[[diffusers.HunyuanVideoTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, timestep: LongTensor, encoder_hidden_states: Tensor, encoder_attention_mask: Tensor, pooled_projections: Tensor, guidance: Tensor = None, attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True)
```

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

**パラメータ:**

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

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

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

encoder_attention_mask (`torch.Tensor`) : アテンション時に`encoder_hidden_states`に適用されるマスク。

pooled_projections (`torch.Tensor`、shape `(batch_size, projection_dim)`) : 入力条件の埋め込みから投影された埋め込み。

guidance (`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` が返されます。

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

## 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)の出力です。