Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /pt /api /models /autoencoder_kl_hunyuanimage.md

mishig

3 days ago

preview code

download

raw

6.41 kB

# AutoencoderKLHunyuanImage

O modelo de autoencoder variacional (VAE) 2D com perda KL usado em [HunyuanImage2.1].

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

```python
from diffusers import AutoencoderKLHunyuanImage
vae = AutoencoderKLHunyuanImage.from_pretrained("hunyuanvideo-community/HunyuanImage-2.1-Diffusers", subfolder="vae", dtype=torch.bfloat16)
```

## AutoencoderKLHunyuanImage[[diffusers.AutoencoderKLHunyuanImage]]

#### diffusers.AutoencoderKLHunyuanImage[[diffusers.AutoencoderKLHunyuanImage]]

```python
diffusers.AutoencoderKLHunyuanImage(in_channels: int, out_channels: int, latent_channels: int, block_out_channels: tuple[int, ...], layers_per_block: int, spatial_compression_ratio: int, sample_size: int, scaling_factor: float = None, downsample_match_channel: bool = True, upsample_match_channel: bool = True)
```

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

Um modelo de VAE para imagens 2D com suporte a mosaico espacial.

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

#### decode[[diffusers.AutoencoderKLHunyuanImage.decode]]

```python
decode(z: Tensor, return_dict: bool = True)
```

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

**Parâmetros:**

z (`torch.Tensor`) : Lote de entrada de vetores latentes.

return_dict (`bool`, *opcional*, padrão `True`) : Se deve retornar um `~models.vae.DecoderOutput` em vez de uma tupla simples.
**Retorna:** `~models.vae.DecoderOutput` ou `tuple`
Se return_dict for True, um `~models.vae.DecoderOutput` é retornado; caso contrário, uma `tuple` simples é retornada.

Decodifique um lote de imagens.

#### enable_tiling[[diffusers.AutoencoderKLHunyuanImage.enable_tiling]]

```python
enable_tiling(tile_sample_min_size: int | None = None, tile_overlap_factor: float | None = None)
```

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

**Parâmetros:**

tile_sample_min_size (`int`, *opcional*) : O tamanho mínimo necessário para que uma amostra seja separada em tiles ao longo da dimensão espacial.
tile_overlap_factor (`float`, *opcional*) : O fator de sobreposição necessário para que um latente seja separado em tiles ao longo da dimensão espacial.
Ativa a decodificação do VAE em mosaicos espaciais. Quando esta opção está ativada, o VAE divide o tensor de entrada em mosaicos para calcular a decodificação e a codificação em várias etapas. Isso é útil para economizar uma grande quantidade de memória e permitir o processamento de imagens maiores.
#### encode[[diffusers.AutoencoderKLHunyuanImage.encode]]
```python
encode(x: Tensor, return_dict: bool = True)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_hunyuanimage.py#L499)
**Parâmetros:**
x (`torch.Tensor`) : Lote de entrada de imagens.
return_dict (`bool`, *opcional*, padrão `True`) : Se deve retornar um `~models.autoencoder_kl.AutoencoderKLOutput` em vez de uma tupla simples.
**Retorna:**
As representações latentes dos vídeos codificados. Se `return_dict` for True, um `~models.autoencoder_kl.AutoencoderKLOutput` é retornado; caso contrário, uma `tuple` simples é retornada.
Codifica um lote de imagens em latentes.
#### forward[[diffusers.AutoencoderKLHunyuanImage.forward]]
```python
forward(sample: Tensor, sample_posterior: bool = False, return_dict: bool = True, generator: typing.Optional[torch.Generator] = None)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_hunyuanimage.py#L667)
**Parâmetros:**
sample (`torch.Tensor`) : Amostra de entrada.
sample_posterior (`bool`, *opcional*, padrão `False`) : Se deve amostrar da posterior.
return_dict (`bool`, *opcional*, padrão `True`) : Se deve ou não retornar um `DecoderOutput` em vez de uma tupla simples.
generator (`torch.Generator`, *opcional*) : Um [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html) para tornar a amostragem determinística.
**Retorna:** `~models.vae.DecoderOutput` ou `tuple`
Se `return_dict` for True, um `~models.vae.DecoderOutput` é retornado; caso contrário, uma `tuple` simples é retornada.
#### tiled_decode[[diffusers.AutoencoderKLHunyuanImage.tiled_decode]]
```python
tiled_decode(z: Tensor, return_dict: bool = True)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_hunyuanimage.py#L622)
**Parâmetros:**
z (`torch.Tensor`) : Tensor latente de forma (B, C, H, W).
return_dict (`bool`, *opcional*, padrão `True`) : Se deve ou não retornar um `~models.vae.DecoderOutput` em vez de uma tupla simples.
**Retorna:** `~models.vae.DecoderOutput` ou `tuple`
Se return_dict for True, um `~models.vae.DecoderOutput` é retornado; caso contrário, uma `tuple` simples é retornada.
Decodifique o latente usando a estratégia de tesoura espacial.
#### tiled_encode[[diffusers.AutoencoderKLHunyuanImage.tiled_encode]]
```python
tiled_encode(x: Tensor)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_hunyuanimage.py#L582)
**Parâmetros:**
x (`torch.Tensor`) : Tensor de entrada com forma (B, C, T, H, W).
**Retorna:** `torch.Tensor`
A representação latente das imagens codificadas.
Codifique a entrada usando a estratégia de mosaico espacial.
## DecoderOutput[[diffusers.models.autoencoders.vae.DecoderOutput]]
#### diffusers.models.autoencoders.vae.DecoderOutput[[diffusers.models.autoencoders.vae.DecoderOutput]]
```python
diffusers.models.autoencoders.vae.DecoderOutput(sample: Tensor, commit_loss: typing.Optional[torch.FloatTensor] = None)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/vae.py#L49)
**Parâmetros:**
sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)`) : A amostra de saída decodificada da última camada do modelo.
Saída do método de decodificação.

Xet Storage Details

Size:: 6.41 kB
Xet hash:: 7dee24fc3e5ee287f1e19ef664c48e9c190d1631bda95e402997c4319872a9c1

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# AutoencoderKLHunyuanImage

	O modelo de autoencoder variacional (VAE) 2D com perda KL usado em [HunyuanImage2.1].

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

	```python
	from diffusers import AutoencoderKLHunyuanImage

	vae = AutoencoderKLHunyuanImage.from_pretrained("hunyuanvideo-community/HunyuanImage-2.1-Diffusers", subfolder="vae", dtype=torch.bfloat16)
	```

	## AutoencoderKLHunyuanImage[[diffusers.AutoencoderKLHunyuanImage]]

	#### diffusers.AutoencoderKLHunyuanImage[[diffusers.AutoencoderKLHunyuanImage]]

	```python
	diffusers.AutoencoderKLHunyuanImage(in_channels: int, out_channels: int, latent_channels: int, block_out_channels: tuple[int, ...], layers_per_block: int, spatial_compression_ratio: int, sample_size: int, scaling_factor: float = None, downsample_match_channel: bool = True, upsample_match_channel: bool = True)
	```

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

	Um modelo de VAE para imagens 2D com suporte a mosaico espacial.

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

	#### decode[[diffusers.AutoencoderKLHunyuanImage.decode]]

	```python
	decode(z: Tensor, return_dict: bool = True)
	```

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

	Parâmetros:

	z (`torch.Tensor`) : Lote de entrada de vetores latentes.

	return_dict (`bool`, opcional, padrão `True`) : Se deve retornar um `~models.vae.DecoderOutput` em vez de uma tupla simples.

	Retorna: `~models.vae.DecoderOutput` ou `tuple`

	Se return_dict for True, um `~models.vae.DecoderOutput` é retornado; caso contrário, uma `tuple` simples é retornada.

	Decodifique um lote de imagens.

	#### enable_tiling[[diffusers.AutoencoderKLHunyuanImage.enable_tiling]]

	```python
	enable_tiling(tile_sample_min_size: int \| None = None, tile_overlap_factor: float \| None = None)
	```

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

	Parâmetros:

	tile_sample_min_size (`int`, opcional) : O tamanho mínimo necessário para que uma amostra seja separada em tiles ao longo da dimensão espacial.

	tile_overlap_factor (`float`, opcional) : O fator de sobreposição necessário para que um latente seja separado em tiles ao longo da dimensão espacial.

	Ativa a decodificação do VAE em mosaicos espaciais. Quando esta opção está ativada, o VAE divide o tensor de entrada em mosaicos para calcular a decodificação e a codificação em várias etapas. Isso é útil para economizar uma grande quantidade de memória e permitir o processamento de imagens maiores.

	#### encode[[diffusers.AutoencoderKLHunyuanImage.encode]]

	```python
	encode(x: Tensor, return_dict: bool = True)
	```

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

	Parâmetros:

	x (`torch.Tensor`) : Lote de entrada de imagens.

	return_dict (`bool`, opcional, padrão `True`) : Se deve retornar um `~models.autoencoder_kl.AutoencoderKLOutput` em vez de uma tupla simples.

	Retorna:

	As representações latentes dos vídeos codificados. Se `return_dict` for True, um `~models.autoencoder_kl.AutoencoderKLOutput` é retornado; caso contrário, uma `tuple` simples é retornada.

	Codifica um lote de imagens em latentes.

	#### forward[[diffusers.AutoencoderKLHunyuanImage.forward]]

	```python
	forward(sample: Tensor, sample_posterior: bool = False, return_dict: bool = True, generator: typing.Optional[torch.Generator] = None)
	```

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

	Parâmetros:

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

	sample_posterior (`bool`, opcional, padrão `False`) : Se deve amostrar da posterior.

	return_dict (`bool`, opcional, padrão `True`) : Se deve ou não retornar um `DecoderOutput` em vez de uma tupla simples.

	generator (`torch.Generator`, opcional) : Um [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html) para tornar a amostragem determinística.

	Retorna: `~models.vae.DecoderOutput` ou `tuple`

	Se `return_dict` for True, um `~models.vae.DecoderOutput` é retornado; caso contrário, uma `tuple` simples é retornada.

	#### tiled_decode[[diffusers.AutoencoderKLHunyuanImage.tiled_decode]]

	```python
	tiled_decode(z: Tensor, return_dict: bool = True)
	```

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

	Parâmetros:

	z (`torch.Tensor`) : Tensor latente de forma (B, C, H, W).

	return_dict (`bool`, opcional, padrão `True`) : Se deve ou não retornar um `~models.vae.DecoderOutput` em vez de uma tupla simples.

	Retorna: `~models.vae.DecoderOutput` ou `tuple`

	Se return_dict for True, um `~models.vae.DecoderOutput` é retornado; caso contrário, uma `tuple` simples é retornada.

	Decodifique o latente usando a estratégia de tesoura espacial.

	#### tiled_encode[[diffusers.AutoencoderKLHunyuanImage.tiled_encode]]

	```python
	tiled_encode(x: Tensor)
	```

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

	Parâmetros:

	x (`torch.Tensor`) : Tensor de entrada com forma (B, C, T, H, W).

	Retorna: `torch.Tensor`

	A representação latente das imagens codificadas.

	Codifique a entrada usando a estratégia de mosaico espacial.

	## DecoderOutput[[diffusers.models.autoencoders.vae.DecoderOutput]]

	#### diffusers.models.autoencoders.vae.DecoderOutput[[diffusers.models.autoencoders.vae.DecoderOutput]]

	```python
	diffusers.models.autoencoders.vae.DecoderOutput(sample: Tensor, commit_loss: typing.Optional[torch.FloatTensor] = None)
	```

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

	Parâmetros:

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

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