# Flux2Transformer2DModel

Um modelo Transformer para dados semelhantes a imagens do [Flux2](https://hf.co/black-forest-labs/FLUX.2-dev).

## Flux2Transformer2DModel[[diffusers.Flux2Transformer2DModel]]

#### diffusers.Flux2Transformer2DModel[[diffusers.Flux2Transformer2DModel]]

```python
diffusers.Flux2Transformer2DModel(patch_size: int = 1, in_channels: int = 128, out_channels: int | None = None, num_layers: int = 8, num_single_layers: int = 48, attention_head_dim: int = 128, num_attention_heads: int = 48, joint_attention_dim: int = 15360, timestep_guidance_channels: int = 256, mlp_ratio: float = 3.0, axes_dims_rope: tuple[int, ...] = (32, 32, 32, 32), rope_theta: int = 2000, eps: float = 1e-06, guidance_embeds: bool = True)
```

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

**Parâmetros:**

patch_size (`int`, padrão `1`) : Tamanho do patch para converter os dados de entrada em pequenos patches.

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

out_channels (`int`, *opcional*, padrão `None`) : O número de canais na saída. Se não for especificado, o padrão é `in_channels`.

num_layers (`int`, padrão `8`) : O número de blocos DiT de fluxo duplo a serem usados.

num_single_layers (`int`, padrão `48`) : O número de blocos DiT de fluxo único a serem usados.

attention_head_dim (`int`, padrão `128`) : O número de dimensões a serem usadas para cada cabeça de atenção.

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

joint_attention_dim (`int`, padrão `15360`) : O número de dimensões a serem usadas para a atenção conjunta (dimensão de incorporação/canal de `encoder_hidden_states`).

pooled_projection_dim (`int`, padrão `768`) : O número de dimensões a serem usadas para a projeção agregada.

guidance_embeds (`bool`, padrão `True`) : Se deve usar embeddings de orientação para a variante destilada por orientação do modelo.

axes_dims_rope (`tuple[int]`, padrão `(32, 32, 32, 32)`) : As dimensões a serem usadas para os embeddings posicionais rotativos.

O modelo Transformer introduzido no Flux 2.

Referência: https://blackforestlabs.ai/announcing-black-forest-labs/

#### forward[[diffusers.Flux2Transformer2DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: 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, return_dict: bool = True, kv_cache: Flux2KVCache | None = None, kv_cache_mode: str | None = None, num_ref_tokens: int = 0, ref_fixed_timestep: float = 0.0)
```

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

**Parâmetros:**

hidden_states (`torch.Tensor` de forma `(batch_size, image_sequence_length, in_channels)`) : `hidden_states` de entrada.

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

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

img_ids (`torch.Tensor`) : ids de posição de imagem usados para calcular os embeddings posicionais rotativos.

txt_ids (`torch.Tensor`) : ids de posição de texto usados para calcular os embeddings posicionais rotativos.

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

joint_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.

kv_cache (`Flux2KVCache`, *opcional*) : cache de KV para tokens da imagem de referência. Quando `kv_cache_mode` é "extract", um novo cache é criado e retornado. Quando "cached", o cache fornecido é usado para injetar K/V de referência durante a atenção.

kv_cache_mode (`str`, *opcional*) : Um dos valores "extract" (primeira etapa com tokens de referência) ou "cached" (etapas subsequentes usando K/V de referência em cache). Quando `None`, passagem de frente padrão sem cache de KV.

num_ref_tokens (`int`, padrão `0`) : Número de tokens de imagem de referência adicionados antes de `hidden_states` (usado apenas quando `kv_cache_mode="extract"`).

ref_fixed_timestep (`float`, padrão `0.0`) : Timestep fixo para modulação de tokens de referência (usado apenas quando `kv_cache_mode="extract"`).

**Retorna:**

Se `return_dict` for True, um `~models.transformer_2d.Transformer2DModelOutput` é retornado; caso contrário, uma `tuple` em que o primeiro elemento é o tensor da amostra. Quando `kv_cache_mode="extract"`, também retorna o `Flux2KVCache` preenchido.

O método forward do [Flux2Transformer2DModel](/docs/diffusers/main/pt/api/models/flux2_transformer#diffusers.Flux2Transformer2DModel).

## Flux2Transformer2DModelOutput[[diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput]]

#### diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput[[diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput]]

```python
diffusers.models.transformers.transformer_flux2.Flux2Transformer2DModelOutput(sample: torch.Tensor, kv_cache: Flux2KVCache | None = None)
```

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

**Parâmetros:**

sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)`) : Os estados ocultos de saída condicionados à entrada `encoder_hidden_states`.

kv_cache (`Flux2KVCache`, *opcional*) : O cache KV preenchido para os tokens da imagem de referência. Retornado apenas quando `kv_cache_mode="extract"`.

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