diffusers/pr_12229/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]]

class diffusers.AutoencoderKLHunyuanVideodiffusers.AutoencoderKLHunyuanVideohttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L628[{"name": "in_channels", "val": ": int = 3"}, {"name": "out_channels", "val": ": int = 3"}, {"name": "latent_channels", "val": ": int = 16"}, {"name": "down_block_types", "val": ": typing.Tuple[str, ...] = ('HunyuanVideoDownBlock3D', 'HunyuanVideoDownBlock3D', 'HunyuanVideoDownBlock3D', 'HunyuanVideoDownBlock3D')"}, {"name": "up_block_types", "val": ": typing.Tuple[str, ...] = ('HunyuanVideoUpBlock3D', 'HunyuanVideoUpBlock3D', 'HunyuanVideoUpBlock3D', 'HunyuanVideoUpBlock3D')"}, {"name": "block_out_channels", "val": ": typing.Tuple[int] = (128, 256, 512, 512)"}, {"name": "layers_per_block", "val": ": int = 2"}, {"name": "act_fn", "val": ": str = 'silu'"}, {"name": "norm_num_groups", "val": ": int = 32"}, {"name": "scaling_factor", "val": ": float = 0.476986"}, {"name": "spatial_compression_ratio", "val": ": int = 8"}, {"name": "temporal_compression_ratio", "val": ": int = 4"}, {"name": "mid_block_add_attention", "val": ": bool = True"}]

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_12229/src/diffusers/utils/accelerate_utils.py#L43[{"name": "*args", "val": ""}, {"name": "**kwargs", "val": ""}]

disable_slicingdiffusers.AutoencoderKLHunyuanVideo.disable_slicinghttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L781[]

Disable sliced VAE decoding. If enable_slicing was previously enabled, this method will go back to computing decoding in one step.

disable_tilingdiffusers.AutoencoderKLHunyuanVideo.disable_tilinghttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L767[]

Disable tiled VAE decoding. If enable_tiling was previously enabled, this method will go back to computing decoding in one step.

enable_slicingdiffusers.AutoencoderKLHunyuanVideo.enable_slicinghttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L774[]

Enable sliced VAE decoding. When this option is enabled, the VAE will split the input tensor in slices to compute decoding in several steps. This is useful to save some memory and allow larger batch sizes.

enable_tilingdiffusers.AutoencoderKLHunyuanVideo.enable_tilinghttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L727[{"name": "tile_sample_min_height", "val": ": typing.Optional[int] = None"}, {"name": "tile_sample_min_width", "val": ": typing.Optional[int] = None"}, {"name": "tile_sample_min_num_frames", "val": ": typing.Optional[int] = None"}, {"name": "tile_sample_stride_height", "val": ": typing.Optional[float] = None"}, {"name": "tile_sample_stride_width", "val": ": typing.Optional[float] = None"}, {"name": "tile_sample_stride_num_frames", "val": ": typing.Optional[float] = None"}]- 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.0

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.

forwarddiffusers.AutoencoderKLHunyuanVideo.forwardhttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L1074[{"name": "sample", "val": ": Tensor"}, {"name": "sample_posterior", "val": ": bool = False"}, {"name": "return_dict", "val": ": bool = True"}, {"name": "generator", "val": ": typing.Optional[torch._C.Generator] = None"}]- 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.0

tiled_decodediffusers.AutoencoderKLHunyuanVideo.tiled_decodehttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L949[{"name": "z", "val": ": Tensor"}, {"name": "return_dict", "val": ": bool = True"}]- 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.0~models.vae.DecoderOutput or tupleIf 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_encodediffusers.AutoencoderKLHunyuanVideo.tiled_encodehttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/autoencoder_kl_hunyuan_video.py#L899[{"name": "x", "val": ": Tensor"}]- x (torch.Tensor) -- Input batch of videos.0torch.TensorThe latent representation of the encoded videos. Encode a batch of images using a tiled encoder.

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

class diffusers.models.autoencoders.vae.DecoderOutputdiffusers.models.autoencoders.vae.DecoderOutputhttps://github.com/huggingface/diffusers/blob/vr_12229/src/diffusers/models/autoencoders/vae.py#L47[{"name": "sample", "val": ": Tensor"}, {"name": "commit_loss", "val": ": typing.Optional[torch.FloatTensor] = None"}]- sample (torch.Tensor of shape (batch_size, num_channels, height, width)) -- The decoded output sample from the last layer of the model.0

Output of decoding method.