# MochiTransformer3DModel

Genmo による [Mochi-1 Preview](https://huggingface.co/genmo/mochi-1-preview) で、3D ビデオ類似データ向けの Diffusion Transformer モデルが紹介されました。

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

```python
from diffusers import MochiTransformer3DModel

transformer = MochiTransformer3DModel.from_pretrained("genmo/mochi-1-preview", subfolder="transformer", dtype=torch.float16).to("cuda")  # or "mps", "xpu", "cpu"
```

## MochiTransformer3DModel[[diffusers.MochiTransformer3DModel]]

#### diffusers.MochiTransformer3DModel[[diffusers.MochiTransformer3DModel]]

```python
diffusers.MochiTransformer3DModel(patch_size: int = 2, num_attention_heads: int = 24, attention_head_dim: int = 128, num_layers: int = 48, pooled_projection_dim: int = 1536, in_channels: int = 12, out_channels: int | None = None, qk_norm: str = 'rms_norm', text_embed_dim: int = 4096, time_embed_dim: int = 256, activation_fn: str = 'swiglu', max_sequence_length: int = 256)
```

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

**パラメータ:**

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

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

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

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

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

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

qk_norm (`str`、デフォルトは`"rms_norm"`) : 使用する正規化レイヤー。

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

time_embed_dim (`int`、デフォルトは`256`) : 時間ステップ埋め込みの出力次元。

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

max_sequence_length (`int`、デフォルトは`256`) : 対応するテキスト埋め込みの最大シーケンス長。

[Mochi](https://huggingface.co/genmo/mochi-1-preview)で紹介された、動画のようなデータ向けの Transformer モデル。

#### forward[[diffusers.MochiTransformer3DModel.forward]]

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

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

**パラメータ:**

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

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

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

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

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`を返すかどうか。

**戻り値:** `torch.Tensor`

形状が`(batch_size, out_channels, num_frames, height, width)`のノイズ除去済み出力テンソル。

[MochiTransformer3DModel](/docs/diffusers/main/ja/api/models/mochi_transformer3d#diffusers.MochiTransformer3DModel)の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)の出力です。