diffusers/pr_13966/en/api/models/autoencoder_kl_hunyuanimage_refiner.md

AutoencoderKLHunyuanImageRefiner

The 3D variational autoencoder (VAE) model with KL loss used in HunyuanImage2.1 for its refiner pipeline.

The model can be loaded with the following code snippet.

from diffusers import AutoencoderKLHunyuanImageRefiner

vae = AutoencoderKLHunyuanImageRefiner.from_pretrained("hunyuanvideo-community/HunyuanImage-2.1-Refiner-Diffusers", subfolder="vae", torch_dtype=torch.bfloat16)

AutoencoderKLHunyuanImageRefiner[[diffusers.AutoencoderKLHunyuanImageRefiner]]

A VAE model with KL loss for encoding videos into latents and decoding latent representations into videos. Used for HunyuanImage-2.1 Refiner.

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

• 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.~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.

• 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_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.

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.

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

• 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.~models.vae.DecoderOutput or tupleIf return_dict is True, a ~models.vae.DecoderOutput is returned, otherwise a plain tuple is returned.

• 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.~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.

• x (torch.Tensor) -- Input batch of videos.torch.TensorThe latent representation of the encoded videos. Encode a batch of images using a tiled encoder.

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

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