# SD3 Transformer モデル

[Stable Diffusion 3](https://hf.co/papers/2403.03206)で導入されたTransformerモデルです。その新しさは、MMDiT Transformerブロックにあります。

## SD3Transformer2DModel[[diffusers.SD3Transformer2DModel]]

#### diffusers.SD3Transformer2DModel[[diffusers.SD3Transformer2DModel]]

```python
diffusers.SD3Transformer2DModel(sample_size: int = 128, patch_size: int = 2, in_channels: int = 16, num_layers: int = 18, attention_head_dim: int = 64, num_attention_heads: int = 18, joint_attention_dim: int = 4096, caption_projection_dim: int = 1152, pooled_projection_dim: int = 2048, out_channels: int = 16, pos_embed_max_size: int = 96, dual_attention_layers: tuple[int, ...] = (), qk_norm: str | None = None)
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_sd3.py#L79)

**パラメータ:**

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

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

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

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

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

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

joint_attention_dim (`int`、デフォルトは`4096`) : 結合テキスト・画像アテンションに使用する埋め込み次元数。

caption_projection_dim (`int`、デフォルトは`1152`) : キャプション埋め込みの埋め込み次元数。

pooled_projection_dim (`int`、デフォルトは`2048`) : プールされたテキスト投影の埋め込み次元です。

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

pos_embed_max_size (`int`、デフォルトは`96`) : 位置埋め込みの最大潜在高さ/幅。

dual_attention_layers (`tuple[int, ...]`、デフォルトは`()`) : 使用するdual-stream transformerブロックの数。

qk_norm (`str`、*任意*、デフォルトは`None`) : attention層のqueryとkeyに使用する正規化。`None`の場合、正規化は使用されません。

[Stable Diffusion 3](https://huggingface.co/papers/2403.03206)で導入されたTransformerモデル。

#### enable_forward_chunking[[diffusers.SD3Transformer2DModel.enable_forward_chunking]]

```python
enable_forward_chunking(chunk_size: int | None = None, dim: int = 0)
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_sd3.py#L175)

**パラメータ:**

chunk_size (`int`, *optional*) : フィードフォワード層のチャンクサイズ。指定しない場合、`dim`次元の各テンソルに対してフィードフォワード層を個別に実行します。

dim (`int`、*optional*、デフォルトは`0`) : フィードフォワード計算をチャンク分割する次元です。dim=0（バッチ）またはdim=1（シーケンス長）のいずれかを選択します。

[フィードフォワードチャンク分割](https://huggingface.co/blog/reformer#2-chunked-feed-forward-layers)を使用するようにアテンションプロセッサを設定します。

#### forward[[diffusers.SD3Transformer2DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor = None, pooled_projections: Tensor = None, timestep: LongTensor = None, block_controlnet_hidden_states: list = None, joint_attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True, skip_layers: list[int] | None = None)
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_sd3.py#L248)

**パラメータ:**

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

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

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

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

block_controlnet_hidden_states (`list` of `torch.Tensor`) : 指定された場合、transformer ブロックの残差に追加されるテンソルのリストです。

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

skip_layers (`list` of `int`, *optional*) : フォワードパス中にスキップするレイヤーのインデックスのリスト。

**戻り値:**

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

[SD3Transformer2DModel](/docs/diffusers/v0.43.0/ja/api/models/sd3_transformer2d#diffusers.SD3Transformer2DModel)のforwardメソッド。

#### fuse_qkv_projections[[diffusers.SD3Transformer2DModel.fuse_qkv_projections]]

```python
fuse_qkv_projections()
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_sd3.py#L217)

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

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

#### unfuse_qkv_projections[[diffusers.SD3Transformer2DModel.unfuse_qkv_projections]]

```python
unfuse_qkv_projections()
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_sd3.py#L239)

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

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