Diffusers 文档

自动编码器KLCogVideoX

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始使用

AutoencoderKLCogVideoX

CogVideoX 中使用的具有 KL 损失的 3D 变分自动编码器 (VAE) 模型在 CogVideoX 中被提出,并在 CogVideoX: 带有专家 Transformer 的文本到视频扩散模型 中被清华大学和 ZhipuAI 介绍。

该模型可以使用以下代码片段加载。

from diffusers import AutoencoderKLCogVideoX

vae = AutoencoderKLCogVideoX.from_pretrained("THUDM/CogVideoX-2b", subfolder="vae", torch_dtype=torch.float16).to("cuda")

AutoencoderKLCogVideoX

class diffusers.AutoencoderKLCogVideoX

< >

( in_channels: int = 3 out_channels: int = 3 down_block_types: Tuple = ('CogVideoXDownBlock3D', 'CogVideoXDownBlock3D', 'CogVideoXDownBlock3D', 'CogVideoXDownBlock3D') up_block_types: Tuple = ('CogVideoXUpBlock3D', 'CogVideoXUpBlock3D', 'CogVideoXUpBlock3D', 'CogVideoXUpBlock3D') block_out_channels: Tuple = (128, 256, 256, 512) latent_channels: int = 16 layers_per_block: int = 3 act_fn: str = 'silu' norm_eps: float = 1e-06 norm_num_groups: int = 32 temporal_compression_ratio: float = 4 sample_height: int = 480 sample_width: int = 720 scaling_factor: float = 1.15258426 shift_factor: Optional = None latents_mean: Optional = None latents_std: Optional = None force_upcast: float = True use_quant_conv: bool = False use_post_quant_conv: bool = False )

参数

  • in_channels (int, 可选, 默认值 3) — 输入图像的通道数。
  • out_channels (int, 可选, 默认值 3) — 输出的通道数。
  • down_block_types (Tuple[str], 可选, 默认值 ("DownEncoderBlock2D",)) — 下采样块类型的元组。
  • up_block_types (Tuple[str], 可选, 默认值 ("UpDecoderBlock2D",)) — 上采样块类型的元组。
  • block_out_channels (Tuple[int], 可选, 默认值 (64,)) — 块输出通道的元组。
  • act_fn (str, 可选, 默认值 "silu") — 要使用的激活函数。
  • sample_size (int, 可选, 默认值 32) — 样本输入大小。
  • scaling_factor (float, 可选, 默认值 1.15258426) — 使用训练集的第一批计算的训练好的潜在空间的逐分量标准差。 这用于在训练扩散模型时将潜在空间缩放为具有单位方差。 在传递给扩散模型之前,使用公式 z = z * scaling_factor 对潜在空间进行缩放。 解码时,使用公式:z = 1 / scaling_factor * z 将潜在空间缩放到原始比例。 有关更多详细信息,请参阅 具有潜在扩散模型的高分辨率图像合成 论文的第 4.3.2 节和 D.1 节。
  • force_upcast (bool, 可选, 默认值 True) — 如果启用,它将强制 VAE 在高分辨率图像管道(例如 SD-XL)中以 float32 运行。VAE 可以微调/训练到较低的范围而不会损失太多精度,在这种情况下,force_upcast 可以设置为 False - 参见: https://huggingface.co/madebyollin/sdxl-vae-fp16-fix

具有 KL 损失的 VAE 模型,用于将图像编码为潜在变量,并将潜在表示解码为图像。在 CogVideoX 中使用。

此模型继承自 ModelMixin。查看超类文档以了解为所有模型实现的通用方法(例如下载或保存)。

wrapper

< >

( *args **kwargs )

wrapper

< >

( *args **kwargs )

disable_slicing

< >

( )

禁用切片 VAE 解码。如果之前启用了 enable_slicing,此方法将返回一步计算解码。

disable_tiling

< >

( )

禁用平铺 VAE 解码。如果之前启用了 enable_tiling,此方法将返回一步计算解码。

enable_slicing

< >

( )

启用切片 VAE 解码。启用此选项后,VAE 将将输入张量分成切片,以便分步计算解码。这有助于节省一些内存并允许更大的批次大小。

enable_tiling

< >

( tile_sample_min_height: Optional = None tile_sample_min_width: Optional = None tile_overlap_factor_height: Optional = None tile_overlap_factor_width: Optional = None )

参数

  • tile_sample_min_height (int, 可选) — 样本在高度方向上被分成平铺所需的最小高度。
  • tile_sample_min_width (int, 可选) — 样本在宽度方向上被分成平铺所需的最小宽度。
  • tile_overlap_factor_width (int, 可选) — 两个相邻水平瓦片之间的最小重叠量。这可以确保在宽度维度上不会出现瓦片伪影。必须介于 0 到 1 之间。设置更高的值可能会导致处理更多的瓦片,从而导致解码过程变慢。

启用分块 VAE 解码。当启用此选项时,VAE 将把输入张量分成瓦片,以分步计算解码和编码。这对节省大量内存并允许处理更大的图像很有用。

tiled_decode

< >

( z: Tensor return_dict: bool = True ) ~models.vae.DecoderOutputtuple

参数

  • z (torch.Tensor) — 输入潜伏向量批次。
  • return_dict (bool, 可选, 默认值为 True) — 是否返回 ~models.vae.DecoderOutput 而不是普通元组。

返回

~models.vae.DecoderOutputtuple

如果 return_dict 为 True,则返回 ~models.vae.DecoderOutput,否则返回普通 tuple

使用分块解码器解码一批图像。

tiled_encode

< >

( x: Tensor ) torch.Tensor

参数

  • x (torch.Tensor) — 输入视频批次。

返回

torch.Tensor

编码视频的潜在表示。

使用分块编码器编码一批图像。

当启用此选项时,VAE 将把输入张量分成瓦片,以分步计算编码。这有助于保持内存使用量与图像大小无关。分块编码的最终结果与非分块编码不同,因为每个瓦片使用不同的编码器。为了避免分块伪影,瓦片会重叠并混合在一起以形成平滑的输出。您仍然可能会看到瓦片大小的变化,但它们应该不那么明显。

AutoencoderKLOutput

class diffusers.models.modeling_outputs.AutoencoderKLOutput

< >

( latent_dist: DiagonalGaussianDistribution )

参数

  • latent_dist (DiagonalGaussianDistribution) — 编码的 Encoder 输出,表示为 DiagonalGaussianDistribution 的均值和对数方差。DiagonalGaussianDistribution 允许从分布中采样潜伏变量。

AutoencoderKL 编码方法的输出。

DecoderOutput

class diffusers.models.autoencoders.vae.DecoderOutput

< >

( sample: Tensor commit_loss: Optional = None )

参数

  • sample (torch.Tensor 形状为 (batch_size, num_channels, height, width)) — 模型最后一层解码后的输出样本。

解码方法的输出。

< > 在 GitHub 上更新