Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /v0.43.0 /zh /api /models /autoencoder_kl_wan.md

mishig

2 days ago

preview code

download

raw

6.74 kB

# AutoencoderKLWan

阿里巴巴 Wan 团队在 [Wan 2.1](https://github.com/Wan-Video/Wan2.1) 中使用的带 KL 损失的 3D 变分自编码器（VAE）模型。

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

```python
from diffusers import AutoencoderKLWan
vae = AutoencoderKLWan.from_pretrained("Wan-AI/Wan2.1-T2V-1.3B-Diffusers", subfolder="vae", dtype=torch.float32)
```

## AutoencoderKLWan[[diffusers.AutoencoderKLWan]]

#### diffusers.AutoencoderKLWan[[diffusers.AutoencoderKLWan]]

```python
diffusers.AutoencoderKLWan(base_dim: int = 96, decoder_base_dim: int | None = None, z_dim: int = 16, dim_mult: list[int] = [1, 2, 4, 4], num_res_blocks: int = 2, attn_scales: list[float] = [], temperal_downsample: list[bool] = [False, True, True], dropout: float = 0.0, latents_mean: list[float] = [-0.7571, -0.7089, -0.9113, 0.1075, -0.1745, 0.9653, -0.1517, 1.5508, 0.4134, -0.0715, 0.5517, -0.3632, -0.1922, -0.9497, 0.2503, -0.2921], latents_std: list[float] = [2.8184, 1.4541, 2.3275, 2.6558, 1.2196, 1.7708, 2.6052, 2.0743, 3.2687, 2.1526, 2.8652, 1.5579, 1.6382, 1.1253, 2.8251, 1.916], is_residual: bool = False, in_channels: int = 3, out_channels: int = 3, patch_size: int | None = None, scale_factor_temporal: int | None = 4, scale_factor_spatial: int | None = 8)
```

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L964)

一个用于将视频编码为潜在表示并将潜在表示解码为视频的 VAE 模型，采用 KL 损失。在 [Wan 2.1] 中引入。

该模型继承自 [ModelMixin](/docs/diffusers/v0.43.0/zh/api/models/overview#diffusers.ModelMixin)。请查阅其父类文档，了解为所有模型实现的通用方法（例如下载或保存）。

#### decode[[diffusers.AutoencoderKLWan.decode]]

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

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1222)

**参数：**

z (`torch.Tensor`) : 输入的潜在向量批次。

return_dict (`bool`，*可选*，默认为 `True`)：是否返回 `~models.vae.DecoderOutput` 而不是普通元组。
**返回：** `~models.vae.DecoderOutput` 或 `tuple`
如果 return_dict 为 True，则返回 `~models.vae.DecoderOutput`，否则返回普通的 `tuple`。

解码一批图像。

#### enable_tiling[[diffusers.AutoencoderKLWan.enable_tiling]]

```python
enable_tiling(tile_sample_min_height: int | None = None, tile_sample_min_width: int | None = None, tile_sample_stride_height: float | None = None, tile_sample_stride_width: float | None = None)
```

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1097)

**参数：**

tile_sample_min_height (`int`, *可选*) : 样本在高度维度上被分割为多个图块所需的最小高度。
tile_sample_min_width (`int`, *可选*) : 将样本沿宽度维度分割为多个图块所需的最小宽度。

tile_sample_stride_height (`int`, *可选*) : 两个连续垂直瓦片之间的最小重叠量。这旨在确保在高度维度上不会产生瓦片拼接伪影。
tile_sample_stride_width (`int`, *可选*) : 两个相邻水平瓦片之间的步长。这用于确保在宽度维度上不会产生瓦片伪影。

启用分块 VAE 解码。启用此选项后，VAE 会将输入张量拆分为多个块，分步执行解码和编码。这有助于节省大量内存，并支持处理更大的图像。

#### encode[[diffusers.AutoencoderKLWan.encode]]

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

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1164)

**参数：**

x (`torch.Tensor`) : 输入图像批次。

return_dict (`bool`，*可选*，默认为 `True`)：是否返回 `~models.autoencoder_kl.AutoencoderKLOutput` 而不是普通元组。

**返回值：**

编码视频的潜在表示。如果 `return_dict` 为 True，则返回 `~models.autoencoder_kl.AutoencoderKLOutput`，否则返回普通的 `tuple`。

将一批图像编码为潜在表示。

#### forward[[diffusers.AutoencoderKLWan.forward]]

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

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1413)

**参数：**

sample (`torch.Tensor`) : 输入样本。

sample_posterior (`bool`，*可选*，默认为 `False`)：是否从后验分布中采样。
return_dict (`bool`，*可选*，默认为 `True`)：是否返回 `DecoderOutput` 而不是普通元组。

generator (`torch.Generator`，*可选*)：一个 [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html)，用于使采样过程具有确定性。

**返回：** `~models.vae.DecoderOutput` 或 `tuple`

如果 `return_dict` 为 True，则返回 `~models.vae.DecoderOutput`，否则返回普通的 `tuple`。

#### tiled_decode[[diffusers.AutoencoderKLWan.tiled_decode]]

```python
tiled_decode(z: Tensor, return_dict: bool = True)
```

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1335)

**参数：**

z (`torch.Tensor`) : 输入的潜在向量批次。

return_dict (`bool`，*可选*，默认为 `True`)：是否返回 `~models.vae.DecoderOutput` 而不是普通元组。
**返回：** `~models.vae.DecoderOutput` 或 `tuple`
如果 return_dict 为 True，则返回 `~models.vae.DecoderOutput`，否则返回普通的 `tuple`。

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

#### tiled_encode[[diffusers.AutoencoderKLWan.tiled_encode]]

```python
tiled_encode(x: Tensor)
```

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1263)

**参数：**

x (`torch.Tensor`) : 输入的视频批次。

**返回：** `torch.Tensor`

编码视频的潜在表示。

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

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

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

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

[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/vae.py#L49)

**参数：**

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

解码方法的输出。

Xet Storage Details

Size:: 6.74 kB
Xet hash:: 191f61e5cda15a27fab70b710abe5b8c1ce5cfb1cf580f5a94c94c5f10aac456

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# AutoencoderKLWan

	阿里巴巴 Wan 团队在 [Wan 2.1](https://github.com/Wan-Video/Wan2.1) 中使用的带 KL 损失的 3D 变分自编码器（VAE）模型。

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

	```python
	from diffusers import AutoencoderKLWan

	vae = AutoencoderKLWan.from_pretrained("Wan-AI/Wan2.1-T2V-1.3B-Diffusers", subfolder="vae", dtype=torch.float32)
	```

	## AutoencoderKLWan[[diffusers.AutoencoderKLWan]]

	#### diffusers.AutoencoderKLWan[[diffusers.AutoencoderKLWan]]

	```python
	diffusers.AutoencoderKLWan(base_dim: int = 96, decoder_base_dim: int \| None = None, z_dim: int = 16, dim_mult: list[int] = [1, 2, 4, 4], num_res_blocks: int = 2, attn_scales: list[float] = [], temperal_downsample: list[bool] = [False, True, True], dropout: float = 0.0, latents_mean: list[float] = [-0.7571, -0.7089, -0.9113, 0.1075, -0.1745, 0.9653, -0.1517, 1.5508, 0.4134, -0.0715, 0.5517, -0.3632, -0.1922, -0.9497, 0.2503, -0.2921], latents_std: list[float] = [2.8184, 1.4541, 2.3275, 2.6558, 1.2196, 1.7708, 2.6052, 2.0743, 3.2687, 2.1526, 2.8652, 1.5579, 1.6382, 1.1253, 2.8251, 1.916], is_residual: bool = False, in_channels: int = 3, out_channels: int = 3, patch_size: int \| None = None, scale_factor_temporal: int \| None = 4, scale_factor_spatial: int \| None = 8)
	```

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L964)

	一个用于将视频编码为潜在表示并将潜在表示解码为视频的 VAE 模型，采用 KL 损失。在 [Wan 2.1] 中引入。

	该模型继承自 [ModelMixin](/docs/diffusers/v0.43.0/zh/api/models/overview#diffusers.ModelMixin)。请查阅其父类文档，了解为所有模型实现的通用方法（例如下载或保存）。

	#### decode[[diffusers.AutoencoderKLWan.decode]]

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

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1222)

	参数：

	z (`torch.Tensor`) : 输入的潜在向量批次。

	return_dict (`bool`，可选，默认为 `True`)：是否返回 `~models.vae.DecoderOutput` 而不是普通元组。

	返回： `~models.vae.DecoderOutput` 或 `tuple`

	如果 return_dict 为 True，则返回 `~models.vae.DecoderOutput`，否则返回普通的 `tuple`。

	解码一批图像。

	#### enable_tiling[[diffusers.AutoencoderKLWan.enable_tiling]]

	```python
	enable_tiling(tile_sample_min_height: int \| None = None, tile_sample_min_width: int \| None = None, tile_sample_stride_height: float \| None = None, tile_sample_stride_width: float \| None = None)
	```

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1097)

	参数：

	tile_sample_min_height (`int`, 可选) : 样本在高度维度上被分割为多个图块所需的最小高度。

	tile_sample_min_width (`int`, 可选) : 将样本沿宽度维度分割为多个图块所需的最小宽度。

	tile_sample_stride_height (`int`, 可选) : 两个连续垂直瓦片之间的最小重叠量。这旨在确保在高度维度上不会产生瓦片拼接伪影。

	tile_sample_stride_width (`int`, 可选) : 两个相邻水平瓦片之间的步长。这用于确保在宽度维度上不会产生瓦片伪影。

	启用分块 VAE 解码。启用此选项后，VAE 会将输入张量拆分为多个块，分步执行解码和编码。这有助于节省大量内存，并支持处理更大的图像。

	#### encode[[diffusers.AutoencoderKLWan.encode]]

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

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1164)

	参数：

	x (`torch.Tensor`) : 输入图像批次。

	return_dict (`bool`，可选，默认为 `True`)：是否返回 `~models.autoencoder_kl.AutoencoderKLOutput` 而不是普通元组。

	返回值：

	编码视频的潜在表示。如果 `return_dict` 为 True，则返回 `~models.autoencoder_kl.AutoencoderKLOutput`，否则返回普通的 `tuple`。

	将一批图像编码为潜在表示。

	#### forward[[diffusers.AutoencoderKLWan.forward]]

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

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1413)

	参数：

	sample (`torch.Tensor`) : 输入样本。

	sample_posterior (`bool`，可选，默认为 `False`)：是否从后验分布中采样。

	return_dict (`bool`，可选，默认为 `True`)：是否返回 `DecoderOutput` 而不是普通元组。

	generator (`torch.Generator`，可选)：一个 [`torch.Generator`](https://pytorch.org/docs/stable/generated/torch.Generator.html)，用于使采样过程具有确定性。

	返回： `~models.vae.DecoderOutput` 或 `tuple`

	如果 `return_dict` 为 True，则返回 `~models.vae.DecoderOutput`，否则返回普通的 `tuple`。

	#### tiled_decode[[diffusers.AutoencoderKLWan.tiled_decode]]

	```python
	tiled_decode(z: Tensor, return_dict: bool = True)
	```

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1335)

	参数：

	z (`torch.Tensor`) : 输入的潜在向量批次。

	return_dict (`bool`，可选，默认为 `True`)：是否返回 `~models.vae.DecoderOutput` 而不是普通元组。

	返回： `~models.vae.DecoderOutput` 或 `tuple`

	如果 return_dict 为 True，则返回 `~models.vae.DecoderOutput`，否则返回普通的 `tuple`。

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

	#### tiled_encode[[diffusers.AutoencoderKLWan.tiled_encode]]

	```python
	tiled_encode(x: Tensor)
	```

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/autoencoder_kl_wan.py#L1263)

	参数：

	x (`torch.Tensor`) : 输入的视频批次。

	返回： `torch.Tensor`

	编码视频的潜在表示。

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

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

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

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

	[源代码](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/autoencoders/vae.py#L49)

	参数：

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

	解码方法的输出。