# VQModel

O modelo VQ-VAE foi introduzido em [Neural Discrete Representation Learning](https://huggingface.co/papers/1711.00937) por Aaron van den Oord, Oriol Vinyals e Koray Kavukcuoglu. O modelo é usado no 🤗 Diffusers para decodificar representações latentes em imagens. Diferentemente do [AutoencoderKL](/docs/diffusers/main/pt/api/models/autoencoderkl#diffusers.AutoencoderKL), o [VQModel](/docs/diffusers/main/pt/api/models/vq#diffusers.VQModel) opera em um espaço latente quantizado.

O resumo do artigo é:

*Aprender representações úteis sem supervisão continua sendo um desafio fundamental no aprendizado de máquina. Neste artigo, propomos um modelo generativo simples, porém poderoso, que aprende essas representações discretas. Nosso modelo, o Vector Quantised-Variational AutoEncoder (VQ-VAE), difere dos VAEs em dois aspectos principais: a rede codificadora produz códigos discretos, em vez de contínuos; e a priori é aprendida, em vez de ser estática. Para aprender uma representação latente discreta, incorporamos ideias da quantização vetorial (VQ). O uso do método VQ permite que o modelo evite problemas de "colapso posterior" — em que os latentes são ignorados quando pareados com um decodificador autoregressivo poderoso —, geralmente observados no framework VAE. Ao parear essas representações com uma priori autoregressiva, o modelo pode gerar imagens, vídeos e fala de alta qualidade, além de realizar conversão de falantes de alta qualidade e aprendizado não supervisionado de fonemas, fornecendo mais evidências da utilidade das representações aprendidas.*

## VQModel[[diffusers.VQModel]]

#### diffusers.VQModel[[diffusers.VQModel]]

```python
diffusers.VQModel(in_channels: int = 3, out_channels: int = 3, down_block_types: tuple[str, ...] = ('DownEncoderBlock2D',), up_block_types: tuple[str, ...] = ('UpDecoderBlock2D',), block_out_channels: tuple[int, ...] = (64,), layers_per_block: int = 1, act_fn: str = 'silu', latent_channels: int = 3, sample_size: int = 32, num_vq_embeddings: int = 256, norm_num_groups: int = 32, vq_embed_dim: int | None = None, scaling_factor: float = 0.18215, norm_type: str = 'group', mid_block_add_attention = True, lookup_from_codebook = False, force_upcast = False)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/vq_model.py#L40)

**Parâmetros:**

in_channels (int, *opcional*, padrão 3) : Número de canais na imagem de entrada.

out_channels (int,  *opcional*, padrão 3) : Número de canais na saída.

down_block_types (`tuple[str]`, *opcional*, padrão `("DownEncoderBlock2D",)`) : tupla de tipos de blocos de downsampling.

up_block_types (`tuple[str]`, *opcional*, padrão `("UpDecoderBlock2D",)`) : tupla de tipos de blocos de upsample.

block_out_channels (`tuple[int]`, *opcional*, padrão `(64,)`) : tupla de canais de saída dos blocos.

layers_per_block (`int`, *opcional*, padrão `1`) : Número de camadas por bloco.

act_fn (`str`, *opcional*, padrão `"silu"`) : A função de ativação a ser utilizada.

latent_channels (`int`, *opcional*, padrão `3`) : Número de canais no espaço latente.

sample_size (`int`, *opcional*, padrão `32`) : Tamanho da entrada de amostragem.

num_vq_embeddings (`int`, *opcional*, padrão `256`) : Número de vetores do codebook no VQ-VAE.

norm_num_groups (`int`, *opcional*, padrão `32`) : Número de grupos para as camadas de normalização.

vq_embed_dim (`int`, *opcional*) : Dimensão oculta dos vetores do codebook no VQ-VAE.

scaling_factor (`float`, *opcional*, padrão `0.18215`) : O desvio padrão componente a componente do espaço latente treinado, calculado usando o primeiro lote do conjunto de treinamento. Isso é usado para escalar o espaço latente para ter variância unitária ao treinar o modelo de difusão. Os latentes são escalados com a fórmula `z = z * scaling_factor` antes de serem passados para o modelo de difusão. Ao decodificar, os latentes são escalados de volta para a escala original com a fórmula: `z = 1 / scaling_factor * z`. Para mais detalhes, consulte as seções 4.3.2 e D.1 do artigo [High-Resolution Image Synthesis with Latent Diffusion Models](https://huggingface.co/papers/2112.10752).

norm_type (`str`, *opcional*, padrão `"group"`) : Tipo de camada de normalização a ser usada. Pode ser `"group"` ou `"spatial"`.

Um modelo VQ-VAE para decodificar representações latentes.

Este modelo herda de [ModelMixin](/docs/diffusers/main/pt/api/models/overview#diffusers.ModelMixin). Consulte a documentação da superclasse para seus métodos genéricos implementados para todos os modelos (como download ou salvamento).

#### forward[[diffusers.VQModel.forward]]

```python
forward(sample: Tensor, return_dict: bool = True)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/vq_model.py#L163)

**Parâmetros:**

sample (`torch.Tensor`) : Amostra de entrada.

return_dict (`bool`, *opcional*, padrão `True`) : Indica se deve ou não retornar um [models.autoencoders.vq_model.VQEncoderOutput](/docs/diffusers/main/pt/api/models/vq#diffusers.models.autoencoders.vq_model.VQEncoderOutput) em vez de uma tupla simples.

**Retorna:** [VQEncoderOutput](/docs/diffusers/main/pt/api/models/vq#diffusers.models.autoencoders.vq_model.VQEncoderOutput) ou `tuple`

Se return_dict for True, um [VQEncoderOutput](/docs/diffusers/main/pt/api/models/vq#diffusers.models.autoencoders.vq_model.VQEncoderOutput) é retornado; caso contrário, uma `tuple` simples é retornada.

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

## VQEncoderOutput[[diffusers.models.autoencoders.vq_model.VQEncoderOutput]]

#### diffusers.models.autoencoders.vq_model.VQEncoderOutput[[diffusers.models.autoencoders.vq_model.VQEncoderOutput]]

```python
diffusers.models.autoencoders.vq_model.VQEncoderOutput(latents: Tensor)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/vq_model.py#L28)

**Parâmetros:**

latents (`torch.Tensor` de forma `(batch_size, num_channels, height, width)`) : A amostra de saída codificada da última camada do modelo.

Saída do método de codificação do VQModel.