# LTXVideoTransformer3DModel

Lightricks 推出了一款用于 3D 数据的 Diffusion Transformer 模型，来自 [LTX](https://huggingface.co/Lightricks/LTX-Video)。

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

```python
from diffusers import LTXVideoTransformer3DModel

transformer = LTXVideoTransformer3DModel.from_pretrained("Lightricks/LTX-Video", subfolder="transformer", dtype=torch.bfloat16).to("cuda")  # or "mps", "xpu", "cpu"
```

## LTXVideoTransformer3DModel[[diffusers.LTXVideoTransformer3DModel]]

#### diffusers.LTXVideoTransformer3DModel[[diffusers.LTXVideoTransformer3DModel]]

```python
diffusers.LTXVideoTransformer3DModel(in_channels: int = 128, out_channels: int = 128, patch_size: int = 1, patch_size_t: int = 1, num_attention_heads: int = 32, attention_head_dim: int = 64, cross_attention_dim: int = 2048, num_layers: int = 28, activation_fn: str = 'gelu-approximate', qk_norm: str = 'rms_norm_across_heads', norm_elementwise_affine: bool = False, norm_eps: float = 1e-06, caption_channels: int = 4096, attention_bias: bool = True, attention_out_bias: bool = True)
```

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

**参数：**

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

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

patch_size (`int`，默认为 `1`)：在 patch embedding 层中使用的空间 patch 的大小。

patch_size_t (`int`，默认为 `1`)：在 patch embedding 层中使用的时序 patch 的大小。

num_attention_heads (`int`，默认为 `32`)：用于多头注意力的注意力头数量。

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

cross_attention_dim (`int`，默认为 `2048 `)：交叉注意力头的通道数。

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

activation_fn (`str`，默认为 `"gelu-approximate"`)：前馈网络中使用的激活函数。

qk_norm (`str`，默认为 `"rms_norm_across_heads"`)：要使用的归一化层。

用于 [LTX](https://huggingface.co/Lightricks/LTX-Video) 中类视频数据的 Transformer 模型。

#### forward[[diffusers.LTXVideoTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: LongTensor, encoder_attention_mask: Tensor, num_frames: int | None = None, height: int | None = None, width: int | None = None, rope_interpolation_scale: typing.Union[tuple[float, float, float], torch.Tensor, NoneType] = None, video_coords: typing.Optional[torch.Tensor] = None, attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True)
```

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

**参数：**

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

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

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

encoder_attention_mask (`torch.Tensor`) : 在注意力机制中应用于 `encoder_hidden_states` 的掩码。

num_frames (`int`, *可选*) : 用于计算旋转位置嵌入的视频帧数。

height (`int`，*可选*)：用于计算旋转位置嵌入的潜在表示的高度。

width (`int`, *可选*) : 用于计算旋转位置嵌入的潜在表示的宽度。

rope_interpolation_scale (`tuple`，由 `float` 或 `torch.Tensor` 组成，*可选*)：旋转位置嵌入所使用的插值比例。

video_coords (`torch.Tensor`，*可选*)：由旋转位置嵌入使用的预计算视频坐标。

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` 而不是普通元组。

**返回：** `torch.Tensor`

形状为 `(batch_size, sequence_length, out_channels)` 的去噪输出张量。

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

## 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) 的输出。