diffusers/pr_11739/en/api/models/autoencoder_kl_hunyuan_video.md

AutoencoderKLHunyuanVideo

The 3D variational autoencoder (VAE) model with KL loss used in HunyuanVideo, which was introduced in HunyuanVideo: A Systematic Framework For Large Video Generative Models by Tencent.

The model can be loaded with the following code snippet.

from diffusers import AutoencoderKLHunyuanVideo

vae = AutoencoderKLHunyuanVideo.from_pretrained("hunyuanvideo-community/HunyuanVideo", subfolder="vae", torch_dtype=torch.float16)

AutoencoderKLHunyuanVideo[[diffusers.AutoencoderKLHunyuanVideo]]

diffusers.AutoencoderKLHunyuanVideo[[diffusers.AutoencoderKLHunyuanVideo]]

Source

A VAE model with KL loss for encoding videos into latents and decoding latent representations into videos. Introduced in HunyuanVideo.

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

wrapperdiffusers.AutoencoderKLHunyuanVideo.decodehttps://github.com/huggingface/diffusers/blob/vr_11739/src/diffusers/utils/accelerate_utils.py#L43[{"name": "*args", "val": ""}, {"name": "**kwargs", "val": ""}]

enable_tiling[[diffusers.AutoencoderKLHunyuanVideo.enable_tiling]]

Source

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.

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_sample_min_num_frames (int, optional) : The minimum number of frames required for a sample to be separated into tiles across the frame dimension.

tile_sample_stride_height (int, optional) : The minimum amount of overlap between two consecutive vertical tiles. This is to ensure that there are no tiling artifacts produced across the height dimension.

tile_sample_stride_width (int, optional) : The stride between two consecutive horizontal tiles. This is to ensure that there are no tiling artifacts produced across the width dimension.

tile_sample_stride_num_frames (int, optional) : The stride between two consecutive frame tiles. This is to ensure that there are no tiling artifacts produced across the frame dimension.

forward[[diffusers.AutoencoderKLHunyuanVideo.forward]]

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.

tiled_decode[[diffusers.AutoencoderKLHunyuanVideo.tiled_decode]]

Source

Decode a batch of images using a tiled decoder.

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.

tiled_encode[[diffusers.AutoencoderKLHunyuanVideo.tiled_encode]]

Source

Encode a batch of images using a tiled encoder.

Parameters:

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

Returns:

torch.Tensor

The latent representation of the encoded videos.

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

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

Source

Output of decoding method.

Parameters:

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