# SkyReelsV2Transformer3DModel

Skywork AI 在 [SkyReels-V2](https://github.com/SkyworkAI/SkyReels-V2) 中介绍了一种用于 3D 类视频数据的 Diffusion Transformer 模型。

可以使用以下代码片段加载该模型。

```python
from diffusers import SkyReelsV2Transformer3DModel

transformer = SkyReelsV2Transformer3DModel.from_pretrained("Skywork/SkyReels-V2-DF-1.3B-540P-Diffusers", subfolder="transformer", dtype=torch.bfloat16)
```

## SkyReelsV2Transformer3DModel[[diffusers.SkyReelsV2Transformer3DModel]]

#### diffusers.SkyReelsV2Transformer3DModel[[diffusers.SkyReelsV2Transformer3DModel]]

```python
diffusers.SkyReelsV2Transformer3DModel(patch_size: tuple[int] = (1, 2, 2), num_attention_heads: int = 16, attention_head_dim: int = 128, in_channels: int = 16, out_channels: int = 16, text_dim: int = 4096, freq_dim: int = 256, ffn_dim: int = 8192, num_layers: int = 32, cross_attn_norm: bool = True, qk_norm: str | None = 'rms_norm_across_heads', eps: float = 1e-06, image_dim: int | None = None, added_kv_proj_dim: int | None = None, rope_max_seq_len: int = 1024, pos_embed_seq_len: int | None = None, inject_sample_info: bool = False, num_frame_per_block: int = 1)
```

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

**参数：**

patch_size (`tuple[int]`，默认为 `(1, 2, 2)`)：用于视频嵌入的 3D 补丁维度 (t_patch, h_patch, w_patch)。

num_attention_heads (`int`，默认为 `16`)：文本嵌入的固定长度。

attention_head_dim (`int`，默认为 `128`)：每个头中的通道数。

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

out_channels (`int`，默认为 `16`)：输出的通道数。

text_dim (`int`，默认为 `4096`)：文本嵌入的输入维度。

freq_dim (`int`，默认为 `256`)：正弦时间嵌入的维度。

ffn_dim (`int`，默认为 `8192`)：前馈网络中的中间维度。

num_layers (`int`，默认为 `32`)：要使用的 Transformer 块层数。

window_size (`tuple[int]`，默认为 `(-1, -1)`)：局部注意力的窗口大小（-1 表示全局注意力）。

cross_attn_norm (`bool`，默认为 `True`)：启用交叉注意力归一化。

qk_norm (`str`，*可选*，默认为 `"rms_norm_across_heads"`)：启用 query/key 归一化。

eps (`float`，默认值为 `1e-6`)：归一化层的 epsilon 值。

inject_sample_info (`bool`，默认为 `False`)：是否将样本信息注入模型。

image_dim (`int`, *可选*) : 图像嵌入的维度。

added_kv_proj_dim (`int`, *可选*) : 新增的键/值投影的维度。

rope_max_seq_len (`int`，默认为 `1024`)：旋转嵌入的最大序列长度。

pos_embed_seq_len (`int`, *可选*)：位置嵌入的序列长度。

用于基于 Wan 的 SkyReels-V2 模型中处理类视频数据的 Transformer 模型。

#### forward[[diffusers.SkyReelsV2Transformer3DModel.forward]]

```python
forward(hidden_states: Tensor, timestep: LongTensor, encoder_hidden_states: Tensor, encoder_hidden_states_image: typing.Optional[torch.Tensor] = None, enable_diffusion_forcing: bool = False, fps: typing.Optional[torch.Tensor] = None, return_dict: bool = True, attention_kwargs: dict[str, typing.Any] | None = None)
```

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

**参数：**

hidden_states (`torch.Tensor`，形状为 `(batch_size, num_channels, num_frames, height, width)`) : 输入 `hidden_states`。

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

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

encoder_hidden_states_image (`torch.Tensor`, *可选*) : 用于图像条件生成的条件图像嵌入。

enable_diffusion_forcing (`bool`，*可选*，默认为 `False`)：是否启用扩散强制（按块因果掩码）。

fps (`torch.Tensor`, *可选*) : FPS 条件嵌入。

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

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` 为 True，则返回 `~models.transformer_2d.Transformer2DModelOutput`，否则返回一个 `tuple`，其中第一个元素是样本张量。

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

## 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/v0.43.0/src/diffusers/models/modeling_outputs.py#L21)

**参数：**

sample (`torch.Tensor`，形状为 `(batch_size, num_channels, height, width)`；若 [Transformer2DModel](/docs/diffusers/v0.43.0/zh/api/models/transformer2d#diffusers.Transformer2DModel) 为离散模式，则为 `(batch size, num_vector_embeds - 1, num_latent_pixels)`)：以 `encoder_hidden_states` 输入为条件的隐藏状态输出。若为离散模式，则返回未加噪潜在像素的概率分布。

[Transformer2DModel](/docs/diffusers/v0.43.0/zh/api/models/transformer2d#diffusers.Transformer2DModel) 的输出。