# AuraFlowTransformer2DModel

[AuraFlow](https://blog.fal.ai/auraflow/)からの画像類似データ向けのTransformerモデルです。

## AuraFlowTransformer2DModel[[diffusers.AuraFlowTransformer2DModel]]

#### diffusers.AuraFlowTransformer2DModel[[diffusers.AuraFlowTransformer2DModel]]

```python
diffusers.AuraFlowTransformer2DModel(sample_size: int = 64, patch_size: int = 2, in_channels: int = 4, num_mmdit_layers: int = 4, num_single_dit_layers: int = 32, attention_head_dim: int = 256, num_attention_heads: int = 12, joint_attention_dim: int = 2048, caption_projection_dim: int = 3072, out_channels: int = 4, pos_embed_max_size: int = 1024)
```

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

**パラメータ:**

sample_size (`int`) : 潜在画像の幅です。これは位置埋め込みの数を学習するために使用されるため、トレーニング中は固定されます。

patch_size (`int`) : 入力データを小さなパッチに変換するためのパッチサイズ。

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

num_mmdit_layers (`int`、*optional*、デフォルトは 4) : 使用する MMDiT Transformer ブロックの層数。

num_single_dit_layers (`int`、*optional*、デフォルトは 32) : 使用する Transformer ブロックの層数です。これらのブロックは、画像とテキストの表現を連結して使用します。

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

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

joint_attention_dim (`int`, *任意*) : 使用する`encoder_hidden_states`の次元数。

caption_projection_dim (`int`) : `encoder_hidden_states`を投影する際に使用する次元数。

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

pos_embed_max_size (`int`、デフォルトは 1024) : 画像潜在変数から埋め込む最大位置数。

AuraFlow (https://blog.fal.ai/auraflow/) で紹介されている 2D Transformer モデルです。

#### forward[[diffusers.AuraFlowTransformer2DModel.forward]]

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

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

**パラメータ:**

hidden_states (`torch.FloatTensor`、shape `(batch size, channel, height, width)`) : 入力 `hidden_states`。

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

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

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

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

#### fuse_qkv_projections[[diffusers.AuraFlowTransformer2DModel.fuse_qkv_projections]]

```python
fuse_qkv_projections()
```

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

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

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

#### unfuse_qkv_projections[[diffusers.AuraFlowTransformer2DModel.unfuse_qkv_projections]]

```python
unfuse_qkv_projections()
```

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

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

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

