diffusers/pr_13888/en/api/models/autoencoder_kl_hunyuan_video15.md

AutoencoderKLHunyuanVideo15

The 3D variational autoencoder (VAE) model with KL loss used in HunyuanVideo1.5 by Tencent.

The model can be loaded with the following code snippet.

from diffusers import AutoencoderKLHunyuanVideo15

vae = AutoencoderKLHunyuanVideo15.from_pretrained("hunyuanvideo-community/HunyuanVideo-1.5-Diffusers-480p_t2v", subfolder="vae", dtype=torch.float32)

# make sure to enable tiling to avoid OOM
vae.enable_tiling()

AutoencoderKLHunyuanVideo15[[diffusers.AutoencoderKLHunyuanVideo15]]

diffusers.AutoencoderKLHunyuanVideo15[[diffusers.AutoencoderKLHunyuanVideo15]]

diffusers.AutoencoderKLHunyuanVideo15(in_channels: int = 3, out_channels: int = 3, latent_channels: int = 32, block_out_channels: tuple = (128, 256, 512, 1024, 1024), layers_per_block: int = 2, spatial_compression_ratio: int = 16, temporal_compression_ratio: int = 4, downsample_match_channel: bool = True, upsample_match_channel: bool = True, scaling_factor: float = 1.03682)

Source

A VAE model with KL loss for encoding videos into latents and decoding latent representations into videos. Used for HunyuanVideo-1.5.

This model inherits from ModelMixin. Check the superclass documentation for it's generic methods implemented for all models (such as downloading or saving).

decode[[diffusers.AutoencoderKLHunyuanVideo15.decode]]

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

Source

Parameters:

z (torch.Tensor) : Input batch of latent vectors.

return_dict (bool, optional, defaults to True) : Whether to return a ~models.vae.DecoderOutput instead of a plain tuple.

Returns: ~models.vae.DecoderOutput or tuple

If return_dict is True, a ~models.vae.DecoderOutput is returned, otherwise a plain tuple is returned.

Decode a batch of images.

encode[[diffusers.AutoencoderKLHunyuanVideo15.encode]]

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

Source

Parameters:

x (torch.Tensor) : Input batch of images.

return_dict (bool, optional, defaults to True) : Whether to return a ~models.autoencoder_kl.AutoencoderKLOutput instead of a plain tuple.

Returns:

The latent representations of the encoded videos. If return_dict is True, a ~models.autoencoder_kl.AutoencoderKLOutput is returned, otherwise a plain tuple is returned.

Encode a batch of images into latents.

enable_tiling[[diffusers.AutoencoderKLHunyuanVideo15.enable_tiling]]

enable_tiling(tile_sample_min_height: int | None = None, tile_sample_min_width: int | None = None, tile_latent_min_height: int | None = None, tile_latent_min_width: int | None = None, tile_overlap_factor: float | None = None)

Source

Parameters:

tile_sample_min_height (int, optional) : The minimum height required for a sample to be separated into tiles across the height dimension.

tile_sample_min_width (int, optional) : The minimum width required for a sample to be separated into tiles across the width dimension.

tile_latent_min_height (int, optional) : The minimum height required for a latent to be separated into tiles across the height dimension.

tile_latent_min_width (int, optional) : The minimum width required for a latent to be separated into tiles across the width dimension.

Enable tiled VAE decoding. When this option is enabled, the VAE will split the input tensor into tiles to compute decoding and encoding in several steps. This is useful for saving a large amount of memory and to allow processing larger images.

forward[[diffusers.AutoencoderKLHunyuanVideo15.forward]]

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

Source

Parameters:

sample (torch.Tensor) : Input sample.

sample_posterior (bool, optional, defaults to False) : Whether to sample from the posterior.

return_dict (bool, optional, defaults to True) : Whether or not to return a DecoderOutput instead of a plain tuple.

generator (torch.Generator, optional) : A torch.Generator to make sampling deterministic.

Returns: ~models.vae.DecoderOutput or tuple

If return_dict is True, a ~models.vae.DecoderOutput is returned, otherwise a plain tuple is returned.

tiled_decode[[diffusers.AutoencoderKLHunyuanVideo15.tiled_decode]]

tiled_decode(z: Tensor)

Source

Parameters:

z (torch.Tensor) : Input batch of latent vectors.

return_dict (bool, optional, defaults to True) : Whether or not to return a ~models.vae.DecoderOutput instead of a plain tuple.

Returns: ~models.vae.DecoderOutput or tuple

If return_dict is True, a ~models.vae.DecoderOutput is returned, otherwise a plain tuple is returned.

Decode a batch of images using a tiled decoder.

tiled_encode[[diffusers.AutoencoderKLHunyuanVideo15.tiled_encode]]

tiled_encode(x: Tensor)

Source

Parameters:

x (torch.Tensor) : Input batch of videos.

Returns: torch.Tensor

The latent representation of the encoded videos.

Encode a batch of images using a tiled encoder.

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

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

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

Source

Parameters:

sample (torch.Tensor of shape (batch_size, num_channels, height, width)) : The decoded output sample from the last layer of the model.

Output of decoding method.