Buckets:

hf-doc-build
/

doc

Files

xet

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

mishig

3 days ago

preview code

download

raw

10.8 kB

# AutoencoderKLLTXVideo

O modelo de autoencoder variacional 3D (VAE) com perda KL usado no [LTX](https://huggingface.co/Lightricks/LTX-Video) foi introduzido pela Lightricks.

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

```python
from diffusers import AutoencoderKLLTXVideo
vae = AutoencoderKLLTXVideo.from_pretrained("Lightricks/LTX-Video", subfolder="vae", dtype=torch.float32).to("cuda")  # or "mps", "xpu", "cpu"
```

## AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

#### diffusers.AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

```python
diffusers.AutoencoderKLLTXVideo(in_channels: int = 3, out_channels: int = 3, latent_channels: int = 128, block_out_channels: tuple[int, ...] = (128, 256, 512, 512), down_block_types: tuple[str, ...] = ('LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D'), decoder_block_out_channels: tuple[int, ...] = (128, 256, 512, 512), layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), decoder_layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_inject_noise: tuple[bool, ...] = (False, False, False, False, False), downsample_type: tuple[str, ...] = ('conv', 'conv', 'conv', 'conv'), upsample_residual: tuple[bool, ...] = (False, False, False, False), upsample_factor: tuple[int, ...] = (1, 1, 1, 1), timestep_conditioning: bool = False, patch_size: int = 4, patch_size_t: int = 1, resnet_norm_eps: float = 1e-06, scaling_factor: float = 1.0, encoder_causal: bool = True, decoder_causal: bool = False, spatial_compression_ratio: int = None, temporal_compression_ratio: int = None)
```

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

**Parâmetros:**

in_channels (`int`, padrão `3`) : Número de canais de entrada.
out_channels (`int`, padrão `3`) : Número de canais de saída.

latent_channels (`int`, padrão `128`) : Número de canais latentes.
block_out_channels (`tuple[int, ...]`, padrão `(128, 256, 512, 512)`) : O número de canais de saída para cada bloco.
spatio_temporal_scaling (`tuple[bool, ...], defaults to `(True, True, True, False)` : Se um bloco deve ou não conter redução espaço-temporal.
layers_per_block (`tuple[int, ...]`, padrão `(4, 3, 3, 3, 4)`) : O número de camadas por bloco.
patch_size (`int`, padrão `4`) : O tamanho dos patches espaciais.

patch_size_t (`int`, padrão `1`) : O tamanho dos patches temporais.

resnet_norm_eps (`float`, padrão `1e-6`) : Valor de epsilon para as camadas de normalização do ResNet.

scaling_factor (`float`, *opcional*, padrão `1.0`) : 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 paper [High-Resolution Image Synthesis with Latent Diffusion Models](https://huggingface.co/papers/2112.10752).
encoder_causal (`bool`, padrão `True`) : Se o codificador deve se comportar de forma causal (quadros futuros dependem apenas de quadros passados) ou não.

decoder_causal (`bool`, padrão `False`) : Se o decodificador deve se comportar de forma causal (quadros futuros dependem apenas de quadros passados) ou não.
Um modelo VAE com perda KL para codificar imagens em latentes e decodificar representações latentes em imagens. Usado no [LTX](https://huggingface.co/Lightricks/LTX-Video).
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.AutoencoderKLLTXVideo.decode]]
```python
decode(z: Tensor, temb: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1281)
**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.
#### encode[[diffusers.AutoencoderKLLTXVideo.encode]]
```python
encode(x: Tensor, return_dict: bool = True)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1233)
**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.

#### enable_tiling[[diffusers.AutoencoderKLLTXVideo.enable_tiling]]

```python
enable_tiling(tile_sample_min_height: int | None = None, tile_sample_min_width: int | None = None, tile_sample_min_num_frames: int | None = None, tile_sample_stride_height: float | None = None, tile_sample_stride_width: float | None = None, tile_sample_stride_num_frames: float | None = None)
```

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

**Parâmetros:**

tile_sample_min_height (`int`, *opcional*) : A altura mínima necessária para que uma amostra seja separada em tiles ao longo da dimensão de altura.
tile_sample_min_width (`int`, *opcional*) : A largura mínima necessária para que uma amostra seja separada em tiles ao longo da dimensão de largura.

tile_sample_stride_height (`int`, *opcional*) : A quantidade mínima de sobreposição entre duas tiles verticais consecutivas. Isso garante que não haja artefatos de tiling produzidos ao longo da dimensão de altura.
tile_sample_stride_width (`int`, *opcional*) : O deslocamento entre duas tiles horizontais consecutivas. Isso garante que não haja artefatos de tiling produzidos ao longo da dimensão de largura.

Ativa a decodificação do VAE em blocos (tiled). Quando essa opção está ativada, o VAE divide o tensor de entrada em blocos 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.

#### forward[[diffusers.AutoencoderKLLTXVideo.forward]]

```python
forward(sample: Tensor, temb: typing.Optional[torch.Tensor] = None, 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_ltx.py#L1517)

**Parâmetros:**

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

temb (`torch.Tensor`, *opcional*) : Tensor opcional de incorporação de passo de tempo usado para condicionar o decodificador.

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.AutoencoderKLLTXVideo.tiled_decode]]

```python
tiled_decode(z: Tensor, temb: typing.Optional[torch.Tensor], return_dict: bool = True)
```

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

**Parâmetros:**

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

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 um lote de imagens usando um decodificador em mosaico.

#### tiled_encode[[diffusers.AutoencoderKLLTXVideo.tiled_encode]]

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

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

**Parâmetros:**

x (`torch.Tensor`) : Lote de entrada de vídeos.

**Retorna:** `torch.Tensor`

A representação latente dos vídeos codificados.

Codifique um lote de imagens usando um codificador em mosaico.

## AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]
#### diffusers.models.modeling_outputs.AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]
```python
diffusers.models.modeling_outputs.AutoencoderKLOutput(latent_dist: DiagonalGaussianDistribution)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L7)
**Parâmetros:**
latent_dist (`DiagonalGaussianDistribution`) : Saídas codificadas do `Encoder` representadas como a média e o logvar do `DiagonalGaussianDistribution`. O `DiagonalGaussianDistribution` permite amostrar latentes da distribuição.

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

## 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:: 10.8 kB
Xet hash:: 5e799604540d8ca340666d98a715a8a18e21955b15248785bb1b7fa02e24de7a

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

	# AutoencoderKLLTXVideo

	O modelo de autoencoder variacional 3D (VAE) com perda KL usado no [LTX](https://huggingface.co/Lightricks/LTX-Video) foi introduzido pela Lightricks.

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

	```python
	from diffusers import AutoencoderKLLTXVideo

	vae = AutoencoderKLLTXVideo.from_pretrained("Lightricks/LTX-Video", subfolder="vae", dtype=torch.float32).to("cuda") # or "mps", "xpu", "cpu"
	```

	## AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

	#### diffusers.AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

	```python
	diffusers.AutoencoderKLLTXVideo(in_channels: int = 3, out_channels: int = 3, latent_channels: int = 128, block_out_channels: tuple[int, ...] = (128, 256, 512, 512), down_block_types: tuple[str, ...] = ('LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D'), decoder_block_out_channels: tuple[int, ...] = (128, 256, 512, 512), layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), decoder_layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_inject_noise: tuple[bool, ...] = (False, False, False, False, False), downsample_type: tuple[str, ...] = ('conv', 'conv', 'conv', 'conv'), upsample_residual: tuple[bool, ...] = (False, False, False, False), upsample_factor: tuple[int, ...] = (1, 1, 1, 1), timestep_conditioning: bool = False, patch_size: int = 4, patch_size_t: int = 1, resnet_norm_eps: float = 1e-06, scaling_factor: float = 1.0, encoder_causal: bool = True, decoder_causal: bool = False, spatial_compression_ratio: int = None, temporal_compression_ratio: int = None)
	```

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

	Parâmetros:

	in_channels (`int`, padrão `3`) : Número de canais de entrada.

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

	latent_channels (`int`, padrão `128`) : Número de canais latentes.

	block_out_channels (`tuple[int, ...]`, padrão `(128, 256, 512, 512)`) : O número de canais de saída para cada bloco.

	spatio_temporal_scaling (`tuple[bool, ...], defaults to `(True, True, True, False)` : Se um bloco deve ou não conter redução espaço-temporal.

	layers_per_block (`tuple[int, ...]`, padrão `(4, 3, 3, 3, 4)`) : O número de camadas por bloco.

	patch_size (`int`, padrão `4`) : O tamanho dos patches espaciais.

	patch_size_t (`int`, padrão `1`) : O tamanho dos patches temporais.

	resnet_norm_eps (`float`, padrão `1e-6`) : Valor de epsilon para as camadas de normalização do ResNet.

	scaling_factor (`float`, opcional, padrão `1.0`) : 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 paper [High-Resolution Image Synthesis with Latent Diffusion Models](https://huggingface.co/papers/2112.10752).

	encoder_causal (`bool`, padrão `True`) : Se o codificador deve se comportar de forma causal (quadros futuros dependem apenas de quadros passados) ou não.

	decoder_causal (`bool`, padrão `False`) : Se o decodificador deve se comportar de forma causal (quadros futuros dependem apenas de quadros passados) ou não.

	Um modelo VAE com perda KL para codificar imagens em latentes e decodificar representações latentes em imagens. Usado no [LTX](https://huggingface.co/Lightricks/LTX-Video).

	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.AutoencoderKLLTXVideo.decode]]

	```python
	decode(z: Tensor, temb: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
	```

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

	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.

	#### encode[[diffusers.AutoencoderKLLTXVideo.encode]]

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

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

	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.

	#### enable_tiling[[diffusers.AutoencoderKLLTXVideo.enable_tiling]]

	```python
	enable_tiling(tile_sample_min_height: int \| None = None, tile_sample_min_width: int \| None = None, tile_sample_min_num_frames: int \| None = None, tile_sample_stride_height: float \| None = None, tile_sample_stride_width: float \| None = None, tile_sample_stride_num_frames: float \| None = None)
	```

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

	Parâmetros:

	tile_sample_min_height (`int`, opcional) : A altura mínima necessária para que uma amostra seja separada em tiles ao longo da dimensão de altura.

	tile_sample_min_width (`int`, opcional) : A largura mínima necessária para que uma amostra seja separada em tiles ao longo da dimensão de largura.

	tile_sample_stride_height (`int`, opcional) : A quantidade mínima de sobreposição entre duas tiles verticais consecutivas. Isso garante que não haja artefatos de tiling produzidos ao longo da dimensão de altura.

	tile_sample_stride_width (`int`, opcional) : O deslocamento entre duas tiles horizontais consecutivas. Isso garante que não haja artefatos de tiling produzidos ao longo da dimensão de largura.

	Ativa a decodificação do VAE em blocos (tiled). Quando essa opção está ativada, o VAE divide o tensor de entrada em blocos 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.

	#### forward[[diffusers.AutoencoderKLLTXVideo.forward]]

	```python
	forward(sample: Tensor, temb: typing.Optional[torch.Tensor] = None, 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_ltx.py#L1517)

	Parâmetros:

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

	temb (`torch.Tensor`, opcional) : Tensor opcional de incorporação de passo de tempo usado para condicionar o decodificador.

	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.AutoencoderKLLTXVideo.tiled_decode]]

	```python
	tiled_decode(z: Tensor, temb: typing.Optional[torch.Tensor], return_dict: bool = True)
	```

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

	Parâmetros:

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

	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 um lote de imagens usando um decodificador em mosaico.

	#### tiled_encode[[diffusers.AutoencoderKLLTXVideo.tiled_encode]]

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

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

	Parâmetros:

	x (`torch.Tensor`) : Lote de entrada de vídeos.

	Retorna: `torch.Tensor`

	A representação latente dos vídeos codificados.

	Codifique um lote de imagens usando um codificador em mosaico.

	## AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]

	#### diffusers.models.modeling_outputs.AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]

	```python
	diffusers.models.modeling_outputs.AutoencoderKLOutput(latent_dist: DiagonalGaussianDistribution)
	```

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

	Parâmetros:

	latent_dist (`DiagonalGaussianDistribution`) : Saídas codificadas do `Encoder` representadas como a média e o logvar do `DiagonalGaussianDistribution`. O `DiagonalGaussianDistribution` permite amostrar latentes da distribuição.

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

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