# FluxTransformer2DModel

用于 [Flux](https://blackforestlabs.ai/announcing-black-forest-labs/) 中类图像数据的 Transformer 模型。

## FluxTransformer2DModel[[diffusers.FluxTransformer2DModel]]

#### diffusers.FluxTransformer2DModel[[diffusers.FluxTransformer2DModel]]

```python
diffusers.FluxTransformer2DModel(patch_size: int = 1, in_channels: int = 64, out_channels: int | None = None, num_layers: int = 19, num_single_layers: int = 38, attention_head_dim: int = 128, num_attention_heads: int = 24, joint_attention_dim: int = 4096, pooled_projection_dim: int = 768, guidance_embeds: bool = False, axes_dims_rope: tuple[int, int, int] = (16, 56, 56))
```

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_flux.py#L529)

**参数：**

patch_size (`int`，默认为 `1`)：用于将输入数据划分为小块的补丁大小。

in_channels (`int`，默认为 `64`)：输入中的通道数。

out_channels (`int`，*可选*，默认为 `None`)：输出中的通道数。如果未指定，则默认为 `in_channels`。

num_layers (`int`，默认为 `19`)：要使用的双流 DiT 块层数。

num_single_layers (`int`，默认为 `38`)：要使用的单流 DiT 块层数。

attention_head_dim (`int`，默认为 `128`)：每个注意力头使用的维度数。

num_attention_heads (`int`，默认为 `24`)：要使用的注意力头数量。

joint_attention_dim (`int`，默认为 `4096`)：用于联合注意力的维度数（即 `encoder_hidden_states` 的嵌入/通道维度）。

pooled_projection_dim (`int`，默认为 `768`)：用于池化投影的维度数。

guidance_embeds (`bool`，默认为 `False`)：是否使用引导嵌入（guidance embeddings）来支持模型的引导蒸馏变体。

axes_dims_rope (`tuple[int]`，默认为 `(16, 56, 56)`) : 用于旋转位置嵌入的维度。

Flux 中引入的 Transformer 模型。

参考：https://blackforestlabs.ai/announcing-black-forest-labs/

#### forward[[diffusers.FluxTransformer2DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor = None, pooled_projections: Tensor = None, timestep: LongTensor = None, img_ids: Tensor = None, txt_ids: Tensor = None, guidance: Tensor = None, joint_attention_kwargs: dict[str, typing.Any] | None = None, controlnet_block_samples = None, controlnet_single_block_samples = None, return_dict: bool = True, controlnet_blocks_repeat: bool = False)
```

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_flux.py#L670)

**参数：**

hidden_states (`torch.Tensor`，形状为 `(batch_size, image_sequence_length, in_channels)`) : 输入 `hidden_states`。

encoder_hidden_states (`torch.Tensor`，形状为 `(batch_size, text_sequence_length, joint_attention_dim)`)：要使用的条件嵌入（从输入条件（例如提示词）计算得出的嵌入）。

pooled_projections (`torch.Tensor`，形状为 `(batch_size, projection_dim)`)：由输入条件的嵌入投影得到的嵌入。

timestep ( `torch.LongTensor`) ：用于指示去噪步骤。

img_ids (`torch.Tensor`) : 用于计算旋转位置嵌入的图像位置 ID。

txt_ids (`torch.Tensor`) : 用于计算旋转位置嵌入的文本位置 ID。

guidance (`torch.Tensor`, *可选*) : 用于模型引导蒸馏变体的引导尺度嵌入。

controlnet_block_samples (`list` of `torch.Tensor`, *可选*) : 一个张量列表，如果指定，将被添加到 Transformer 块的残差中。

controlnet_single_block_samples (`list` of `torch.Tensor`, *可选*) : 一个张量列表，如果指定，将被添加到单个 Transformer 块的残差中。

controlnet_blocks_repeat (`bool`，*可选*，默认为 `False`)：是否在所有 transformer 块中重复使用 controlnet 块样本。

joint_attention_kwargs (`dict`, *可选*) : 一个 kwargs 字典，如果指定，将作为参数传递给 [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py) 中 `self.processor` 下定义的 `AttentionProcessor`。

return_dict (`bool`，*可选*，默认为 `True`)：是否返回 `~models.transformer_2d.Transformer2DModelOutput` 而不是普通元组。

**返回值：**

如果 `return_dict` 为 True，则返回 `~models.transformer_2d.Transformer2DModelOutput`，否则返回一个 `tuple`，其中第一个元素是样本张量。

[FluxTransformer2DModel](/docs/diffusers/v0.43.0/zh/api/models/flux_transformer#diffusers.FluxTransformer2DModel) 的前向方法。