# HunyuanVideoTransformer3DModel

Um modelo Diffusion Transformer para dados de vídeo 3D foi introduzido em [HunyuanVideo: A Systematic Framework For Large Video Generative Models](https://huggingface.co/papers/2412.03603) pela Tencent.

O modelo pode ser carregado com o seguinte trecho de código.

```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)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_hunyuan_video.py#L841)

**Parâmetros:**

in_channels (`int`, padrão `16`) : O número de canais na entrada.

out_channels (`int`, padrão `16`) : O número de canais na saída.

num_attention_heads (`int`, padrão `24`) : O número de cabeças a serem usadas para a atenção multi-cabeça.

attention_head_dim (`int`, padrão `128`) : O número de canais em cada head.

num_layers (`int`, padrão `20`) : O número de camadas de blocos dual-stream a serem usadas.

num_single_layers (`int`, padrão `40`) : O número de camadas de blocos de fluxo único a serem usadas.

num_refiner_layers (`int`, padrão `2`) : O número de camadas de blocos de refinamento a serem usadas.

mlp_ratio (`float`, padrão `4.0`) : A proporção do tamanho da camada oculta em relação ao tamanho da entrada na rede feedforward.

patch_size (`int`, padrão `2`) : O tamanho dos patches espaciais a serem usados na camada de incorporação de patches.

patch_size_t (`int`, padrão `1`) : O tamanho dos patches temporais a serem usados na camada de incorporação de patches.

qk_norm (`str`, padrão `rms_norm`) : A normalização a ser usada para as projeções de consulta e chave nas camadas de atenção.

guidance_embeds (`bool`, padrão `True`) : Se deve usar embeddings de orientação no modelo.

text_embed_dim (`int`, padrão `4096`) : Dimensão de entrada dos embeddings de texto do codificador de texto.

pooled_projection_dim (`int`, padrão `768`) : A dimensão da projeção agregada dos embeddings de texto.

rope_theta (`float`, padrão `256.0`) : O valor de theta a ser usado na camada RoPE.

rope_axes_dim (`tuple[int]`, padrão `(16, 56, 56)`) : As dimensões dos eixos a serem usados na camada RoPE.

image_condition_type (`str`, *opcional*, padrão `None`) : O tipo de condicionamento de imagem a ser usado. Se `None`, nenhum condicionamento de imagem é utilizado. Se `latent_concat`, a imagem é concatenada ao fluxo latente. Se `token_replace`, a imagem é usada para substituir os tokens do primeiro quadro no fluxo latente e aplicar o condicionamento.

Um modelo Transformer para dados semelhantes a vídeo usado no [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)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_hunyuan_video.py#L994)

**Parâmetros:**

hidden_states (`torch.Tensor` de forma `(batch_size, num_channels, num_frames, height, width)`) : `hidden_states` de entrada.

timestep (`torch.LongTensor`) : Usado para indicar o passo de desruidamento.

encoder_hidden_states (`torch.Tensor` de forma `(batch_size, sequence_len, embed_dims)`) : Embeddings condicionais (embeddings calculados a partir das condições de entrada, como prompts) a serem usados.

encoder_attention_mask (`torch.Tensor`) : Máscara aplicada a `encoder_hidden_states` durante a atenção.

pooled_projections (`torch.Tensor` de forma `(batch_size, projection_dim)`) : Embebimentos projetados a partir dos embebimentos das condições de entrada.

guidance (`torch.Tensor`, *opcional*) : Embedding de escala de orientação usado para variantes destiladas por orientação do modelo.

attention_kwargs (`dict`, *opcional*) : Um dicionário de kwargs que, se especificado, é passado para o `AttentionProcessor` conforme definido em `self.processor` em [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

return_dict (`bool`, *opcional*, padrão `True`) : Indica se deve retornar um `~models.transformer_2d.Transformer2DModelOutput` em vez de uma tupla simples.

**Retorna:**

Se `return_dict` for True, um `~models.transformer_2d.Transformer2DModelOutput` é retornado; caso contrário, uma `tuple` onde o primeiro elemento é o tensor da amostra.

O método forward do [HunyuanVideoTransformer3DModel](/docs/diffusers/main/pt/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)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L21)

**Parâmetros:**

sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)` ou `(batch size, num_vector_embeds - 1, num_latent_pixels)` se [Transformer2DModel](/docs/diffusers/main/pt/api/models/transformer2d#diffusers.Transformer2DModel) for discreto) : A saída dos estados ocultos condicionada à entrada `encoder_hidden_states`. Se discreto, retorna distribuições de probabilidade para os pixels latentes sem ruído.

A saída de [Transformer2DModel](/docs/diffusers/main/pt/api/models/transformer2d#diffusers.Transformer2DModel).