# HunyuanVideoTransformer3DModel

Модель Diffusion Transformer для 3D-видеоподобных данных была представлена в работе [HunyuanVideo: A Systematic Framework For Large Video Generative Models](https://huggingface.co/papers/2412.03603) от Tencent.

Модель можно загрузить с помощью следующего фрагмента кода.

```python
from diffusers import HunyuanVideoTransformer3DModel

transformer = HunyuanVideoTransformer3DModel.from_pretrained("hunyuanvideo-community/HunyuanVideo", subfolder="transformer", dtype=torch.bfloat16)
```

## HunyuanVideoTransformer3DModel[[diffusers.HunyuanVideoTransformer3DModel]]

#### diffusers.HunyuanVideoTransformer3DModel[[diffusers.HunyuanVideoTransformer3DModel]]

```python
diffusers.HunyuanVideoTransformer3DModel(in_channels: int = 16, out_channels: int = 16, num_attention_heads: int = 24, attention_head_dim: int = 128, num_layers: int = 20, num_single_layers: int = 40, num_refiner_layers: int = 2, mlp_ratio: float = 4.0, patch_size: int = 2, patch_size_t: int = 1, qk_norm: str = 'rms_norm', guidance_embeds: bool = True, text_embed_dim: int = 4096, pooled_projection_dim: int = 768, rope_theta: float = 256.0, rope_axes_dim: tuple[int, ...] = (16, 56, 56), image_condition_type: str | None = None)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_hunyuan_video.py#L841)

**Параметры:**

in_channels (`int`, по умолчанию `16`) : количество каналов на входе.

out_channels (`int`, по умолчанию `16`) : Количество каналов на выходе.

num_attention_heads (`int`, по умолчанию `24`) : Количество головок для использования в механизме внимания с несколькими головками.

attention_head_dim (`int`, по умолчанию `128`) : количество каналов в каждой голове.

num_layers (`int`, по умолчанию `20`) : Количество используемых слоёв dual-stream блоков.

num_single_layers (`int`, по умолчанию `40`) : Количество слоев однопоточных блоков, которые следует использовать.

num_refiner_layers (`int`, по умолчанию `2`) : Количество используемых блоков-рефинеров.

mlp_ratio (`float`, по умолчанию `4.0`) : Соотношение размера скрытого слоя к размеру входа в полносвязной сети.

patch_size (`int`, по умолчанию `2`) : Размер пространственных патчей, используемых в слое встраивания патчей.

patch_size_t (`int`, по умолчанию `1`) : Размер временных патчей, используемых в слое встраивания патчей.

qk_norm (`str`, по умолчанию `rms_norm`) : Нормализация, используемая для проекций запроса и ключа в слоях внимания.

guidance_embeds (`bool`, по умолчанию `True`) : Использовать ли направляющие эмбеддинги в модели.

text_embed_dim (`int`, по умолчанию `4096`) : Размерность входных текстовых эмбеддингов, полученных от текстового энкодера.

pooled_projection_dim (`int`, по умолчанию `768`) : размерность пул-проекции текстовых эмбеддингов.

rope_theta (`float`, по умолчанию `256.0`) : значение theta, используемое в слое RoPE.

rope_axes_dim (`tuple[int]`, по умолчанию `(16, 56, 56)`) : Размеры осей, используемых в слое RoPE.

image_condition_type (`str`, *необязательный*, по умолчанию `None`) : Тип используемого условного изображения. Если `None`, условное изображение не используется. Если `latent_concat`, изображение конкатенируется с латентным потоком. Если `token_replace`, изображение используется для замены токенов первого кадра в латентном потоке и применения условий.

Модель Transformer для видеоподобных данных, используемая в [HunyuanVideo](https://huggingface.co/tencent/HunyuanVideo).

#### forward[[diffusers.HunyuanVideoTransformer3DModel.forward]]

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_hunyuan_video.py#L994)

**Параметры:**

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_attention_mask (`torch.Tensor`) : Маска, применяемая к `encoder_hidden_states` во время внимания.

pooled_projections (`torch.Tensor` формы `(batch_size, projection_dim)`) : Векторы, полученные из эмбеддингов входных условий.

guidance (`torch.Tensor`, *необязательный*) : Встраивание масштаба руководства, используемое для вариантов модели, дистиллированных с помощью руководства.

attention_kwargs (`dict`, *необязательный*) : Словарь kwargs, который при указании передается в `AttentionProcessor`, определенный в `self.processor` в [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли `~models.transformer_2d.Transformer2DModelOutput` вместо обычного кортежа.

**Возвращает:**

Если `return_dict` равно True, возвращается `~models.transformer_2d.Transformer2DModelOutput`, иначе — `tuple`, первым элементом которого является тензор выборки.

Метод forward модели [HunyuanVideoTransformer3DModel](/docs/diffusers/main/ru/api/models/hunyuan_video_transformer_3d#diffusers.HunyuanVideoTransformer3DModel).

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

**Параметры:**

sample (`torch.Tensor` формы `(batch_size, num_channels, height, width)` или `(batch size, num_vector_embeds - 1, num_latent_pixels)`, если [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel) дискретный): выходные скрытые состояния, обусловленные входом `encoder_hidden_states`. Если модель дискретная, возвращает распределения вероятностей для ненашумленных латентных пикселей.

Вывод [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel).