Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /ru /api /models /autoencoderkl_ltx_video.md

mishig

1 day ago

preview code

download

raw

14.1 kB

# AutoencoderKLLTXVideo

Модель трёхмерного вариационного автоэнкодера (VAE) с потерей KL, используемая в [LTX](https://huggingface.co/Lightricks/LTX-Video), была представлена компанией Lightricks.

Модель можно загрузить с помощью следующего фрагмента кода.

```python
from diffusers import AutoencoderKLLTXVideo
vae = AutoencoderKLLTXVideo.from_pretrained("Lightricks/LTX-Video", subfolder="vae", dtype=torch.float32).to("cuda")  # or "mps", "xpu", "cpu"
```

## AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

#### diffusers.AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

```python
diffusers.AutoencoderKLLTXVideo(in_channels: int = 3, out_channels: int = 3, latent_channels: int = 128, block_out_channels: tuple[int, ...] = (128, 256, 512, 512), down_block_types: tuple[str, ...] = ('LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D'), decoder_block_out_channels: tuple[int, ...] = (128, 256, 512, 512), layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), decoder_layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_inject_noise: tuple[bool, ...] = (False, False, False, False, False), downsample_type: tuple[str, ...] = ('conv', 'conv', 'conv', 'conv'), upsample_residual: tuple[bool, ...] = (False, False, False, False), upsample_factor: tuple[int, ...] = (1, 1, 1, 1), timestep_conditioning: bool = False, patch_size: int = 4, patch_size_t: int = 1, resnet_norm_eps: float = 1e-06, scaling_factor: float = 1.0, encoder_causal: bool = True, decoder_causal: bool = False, spatial_compression_ratio: int = None, temporal_compression_ratio: int = None)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1035)

**Параметры:**

in_channels (`int`, по умолчанию `3`) : Количество входных каналов.
out_channels (`int`, по умолчанию `3`) : Количество выходных каналов.

latent_channels (`int`, по умолчанию `128`) : Количество латентных каналов.
block_out_channels (`tuple[int, ...]`, по умолчанию `(128, 256, 512, 512)`) : Количество выходных каналов для каждого блока.
spatio_temporal_scaling (`tuple[bool, ...], defaults to `(True, True, True, False)` : Whether a block should contain spatio-temporal downscaling or not.
layers_per_block (`tuple[int, ...]`, по умолчанию `(4, 3, 3, 3, 4)`) : Количество слоев в каждом блоке.
patch_size (`int`, по умолчанию `4`) : Размер пространственных патчей.

patch_size_t (`int`, по умолчанию `1`) : Размер временных патчей.

resnet_norm_eps (`float`, по умолчанию `1e-6`) : Значение эпсилона для слоёв нормализации в ResNet.

scaling_factor (`float`, *необязательный*, по умолчанию `1.0`) : Стандартное отклонение обученного латентного пространства, вычисленное покомпонентно на основе первой выборки обучающей выборки. Используется для масштабирования латентного пространства до единичной дисперсии при обучении диффузионной модели. Перед передачей в диффузионную модель латенты масштабируются по формуле `z = z * scaling_factor`. При декодировании латенты возвращаются к исходному масштабу по формуле: `z = 1 / scaling_factor * z`. Дополнительные сведения см. в разделах 4.3.2 и D.1 статьи [High-Resolution Image Synthesis with Latent Diffusion Models](https://huggingface.co/papers/2112.10752).
encoder_causal (`bool`, по умолчанию `True`) : Указывает, должен ли энкодер работать в каузальном режиме (будущие кадры зависят только от прошлых) или нет.

decoder_causal (`bool`, по умолчанию `False`) : Должен ли декодер работать в каузальном режиме (будущие кадры зависят только от прошлых) или нет.
Модель VAE с потерей KL для кодирования изображений в латенты и декодирования латентных представлений в изображения. Используется в [LTX](https://huggingface.co/Lightricks/LTX-Video).
Эта модель наследуется от [ModelMixin](/docs/diffusers/main/ru/api/models/overview#diffusers.ModelMixin). См. документацию суперкласса для его универсальных методов, реализованных для всех моделей (например, загрузка или сохранение).
#### decode[[diffusers.AutoencoderKLLTXVideo.decode]]
```python
decode(z: Tensor, temb: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```
[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1281)
**Параметры:**
z (`torch.Tensor`) : Входная партия латентных векторов.
return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли `~models.vae.DecoderOutput` вместо обычного кортежа.
**Возвращает:** `~models.vae.DecoderOutput` или `tuple`
Если return_dict равно True, возвращается `~models.vae.DecoderOutput`, иначе возвращается обычный `tuple`.
Декодировать пакет изображений.
#### encode[[diffusers.AutoencoderKLLTXVideo.encode]]
```python
encode(x: Tensor, return_dict: bool = True)
```
[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1233)
**Параметры:**
x (`torch.Tensor`) : Входная партия изображений.
return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли `~models.autoencoder_kl.AutoencoderKLOutput` вместо обычного кортежа.

**Возвращает:**

Латентные представления закодированных видео. Если `return_dict` равно True, возвращается `~models.autoencoder_kl.AutoencoderKLOutput`, в противном случае возвращается обычный `tuple`.

Кодирует пакет изображений в латенты.

#### enable_tiling[[diffusers.AutoencoderKLLTXVideo.enable_tiling]]

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1186)

**Параметры:**

tile_sample_min_height (`int`, *optional*) : минимальная высота, необходимая для того, чтобы образец был разделён на плитки по оси высоты.
tile_sample_min_width (`int`, *optional*) : Минимальная ширина, необходимая для того, чтобы образец был разделён на плитки по размерности ширины.

tile_sample_stride_height (`int`, *optional*) : Минимальное перекрытие между двумя последовательными вертикальными тайлами. Это необходимо для того, чтобы избежать артефактов тайлинга вдоль вертикальной оси.
tile_sample_stride_width (`int`, *optional*) : Шаг между двумя соседними горизонтальными тайлами. Это обеспечивает отсутствие артефактов тайлинга вдоль ширины.

Включает тайловое декодирование VAE. При включении этого параметра VAE разбивает входной тензор на тайлы для выполнения декодирования и кодирования в несколько шагов. Это полезно для экономии значительного объёма памяти и для обработки изображений большего размера.

#### forward[[diffusers.AutoencoderKLLTXVideo.forward]]

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1517)

**Параметры:**

sample (`torch.Tensor`) : Входящий образец.

temb (`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.AutoencoderKLLTXVideo.tiled_decode]]

```python
tiled_decode(z: Tensor, temb: typing.Optional[torch.Tensor], return_dict: bool = True)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1389)

**Параметры:**

z (`torch.Tensor`) : Входная партия латентных векторов.

return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли `~models.vae.DecoderOutput` вместо обычного кортежа.
**Возвращает:** `~models.vae.DecoderOutput` или `tuple`
Если return_dict равно True, возвращается `~models.vae.DecoderOutput`, иначе возвращается обычный `tuple`.

Декодирование пакета изображений с использованием тайлованного декодера.

#### tiled_encode[[diffusers.AutoencoderKLLTXVideo.tiled_encode]]

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

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1338)

**Параметры:**

x (`torch.Tensor`) : Входная партия видео.

**Возвращает:** `torch.Tensor`

Латентное представление закодированных видео.

Кодирует пакет изображений с использованием тайлованного энкодера.

## AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]
#### diffusers.models.modeling_outputs.AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]
```python
diffusers.models.modeling_outputs.AutoencoderKLOutput(latent_dist: DiagonalGaussianDistribution)
```
[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L7)
**Параметры:**
latent_dist (`DiagonalGaussianDistribution`) : Закодированные выходные данные `Encoder`, представленные в виде среднего и logvar распределения `DiagonalGaussianDistribution`. `DiagonalGaussianDistribution` позволяет извлекать латентные переменные из этого распределения.

Результат метода кодирования AutoencoderKL.

## 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/main/src/diffusers/models/autoencoders/vae.py#L49)

**Параметры:**

sample (`torch.Tensor` формы `(batch_size, num_channels, height, width)`) : Декодированный вывод из последнего слоя модели.

Результат метода декодирования.

Xet Storage Details

Size:: 14.1 kB
Xet hash:: f027c35c0f9d209343bdfd7c509b3a42a517dc94950c256225c97284fa5c83eb

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

	# AutoencoderKLLTXVideo

	Модель трёхмерного вариационного автоэнкодера (VAE) с потерей KL, используемая в [LTX](https://huggingface.co/Lightricks/LTX-Video), была представлена компанией Lightricks.

	Модель можно загрузить с помощью следующего фрагмента кода.

	```python
	from diffusers import AutoencoderKLLTXVideo

	vae = AutoencoderKLLTXVideo.from_pretrained("Lightricks/LTX-Video", subfolder="vae", dtype=torch.float32).to("cuda") # or "mps", "xpu", "cpu"
	```

	## AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

	#### diffusers.AutoencoderKLLTXVideo[[diffusers.AutoencoderKLLTXVideo]]

	```python
	diffusers.AutoencoderKLLTXVideo(in_channels: int = 3, out_channels: int = 3, latent_channels: int = 128, block_out_channels: tuple[int, ...] = (128, 256, 512, 512), down_block_types: tuple[str, ...] = ('LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D', 'LTXVideoDownBlock3D'), decoder_block_out_channels: tuple[int, ...] = (128, 256, 512, 512), layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), decoder_layers_per_block: tuple[int, ...] = (4, 3, 3, 3, 4), spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_spatio_temporal_scaling: tuple[bool, ...] = (True, True, True, False), decoder_inject_noise: tuple[bool, ...] = (False, False, False, False, False), downsample_type: tuple[str, ...] = ('conv', 'conv', 'conv', 'conv'), upsample_residual: tuple[bool, ...] = (False, False, False, False), upsample_factor: tuple[int, ...] = (1, 1, 1, 1), timestep_conditioning: bool = False, patch_size: int = 4, patch_size_t: int = 1, resnet_norm_eps: float = 1e-06, scaling_factor: float = 1.0, encoder_causal: bool = True, decoder_causal: bool = False, spatial_compression_ratio: int = None, temporal_compression_ratio: int = None)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1035)

	Параметры:

	in_channels (`int`, по умолчанию `3`) : Количество входных каналов.

	out_channels (`int`, по умолчанию `3`) : Количество выходных каналов.

	latent_channels (`int`, по умолчанию `128`) : Количество латентных каналов.

	block_out_channels (`tuple[int, ...]`, по умолчанию `(128, 256, 512, 512)`) : Количество выходных каналов для каждого блока.

	spatio_temporal_scaling (`tuple[bool, ...], defaults to `(True, True, True, False)` : Whether a block should contain spatio-temporal downscaling or not.

	layers_per_block (`tuple[int, ...]`, по умолчанию `(4, 3, 3, 3, 4)`) : Количество слоев в каждом блоке.

	patch_size (`int`, по умолчанию `4`) : Размер пространственных патчей.

	patch_size_t (`int`, по умолчанию `1`) : Размер временных патчей.

	resnet_norm_eps (`float`, по умолчанию `1e-6`) : Значение эпсилона для слоёв нормализации в ResNet.

	scaling_factor (`float`, необязательный, по умолчанию `1.0`) : Стандартное отклонение обученного латентного пространства, вычисленное покомпонентно на основе первой выборки обучающей выборки. Используется для масштабирования латентного пространства до единичной дисперсии при обучении диффузионной модели. Перед передачей в диффузионную модель латенты масштабируются по формуле `z = z * scaling_factor`. При декодировании латенты возвращаются к исходному масштабу по формуле: `z = 1 / scaling_factor * z`. Дополнительные сведения см. в разделах 4.3.2 и D.1 статьи [High-Resolution Image Synthesis with Latent Diffusion Models](https://huggingface.co/papers/2112.10752).

	encoder_causal (`bool`, по умолчанию `True`) : Указывает, должен ли энкодер работать в каузальном режиме (будущие кадры зависят только от прошлых) или нет.

	decoder_causal (`bool`, по умолчанию `False`) : Должен ли декодер работать в каузальном режиме (будущие кадры зависят только от прошлых) или нет.

	Модель VAE с потерей KL для кодирования изображений в латенты и декодирования латентных представлений в изображения. Используется в [LTX](https://huggingface.co/Lightricks/LTX-Video).

	Эта модель наследуется от [ModelMixin](/docs/diffusers/main/ru/api/models/overview#diffusers.ModelMixin). См. документацию суперкласса для его универсальных методов, реализованных для всех моделей (например, загрузка или сохранение).

	#### decode[[diffusers.AutoencoderKLLTXVideo.decode]]

	```python
	decode(z: Tensor, temb: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1281)

	Параметры:

	z (`torch.Tensor`) : Входная партия латентных векторов.

	return_dict (`bool`, необязательный, по умолчанию `True`) : Возвращать ли `~models.vae.DecoderOutput` вместо обычного кортежа.

	Возвращает: `~models.vae.DecoderOutput` или `tuple`

	Если return_dict равно True, возвращается `~models.vae.DecoderOutput`, иначе возвращается обычный `tuple`.

	Декодировать пакет изображений.

	#### encode[[diffusers.AutoencoderKLLTXVideo.encode]]

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

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1233)

	Параметры:

	x (`torch.Tensor`) : Входная партия изображений.

	return_dict (`bool`, необязательный, по умолчанию `True`) : Возвращать ли `~models.autoencoder_kl.AutoencoderKLOutput` вместо обычного кортежа.

	Возвращает:

	Латентные представления закодированных видео. Если `return_dict` равно True, возвращается `~models.autoencoder_kl.AutoencoderKLOutput`, в противном случае возвращается обычный `tuple`.

	Кодирует пакет изображений в латенты.

	#### enable_tiling[[diffusers.AutoencoderKLLTXVideo.enable_tiling]]

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

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1186)

	Параметры:

	tile_sample_min_height (`int`, optional) : минимальная высота, необходимая для того, чтобы образец был разделён на плитки по оси высоты.

	tile_sample_min_width (`int`, optional) : Минимальная ширина, необходимая для того, чтобы образец был разделён на плитки по размерности ширины.

	tile_sample_stride_height (`int`, optional) : Минимальное перекрытие между двумя последовательными вертикальными тайлами. Это необходимо для того, чтобы избежать артефактов тайлинга вдоль вертикальной оси.

	tile_sample_stride_width (`int`, optional) : Шаг между двумя соседними горизонтальными тайлами. Это обеспечивает отсутствие артефактов тайлинга вдоль ширины.

	Включает тайловое декодирование VAE. При включении этого параметра VAE разбивает входной тензор на тайлы для выполнения декодирования и кодирования в несколько шагов. Это полезно для экономии значительного объёма памяти и для обработки изображений большего размера.

	#### forward[[diffusers.AutoencoderKLLTXVideo.forward]]

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

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1517)

	Параметры:

	sample (`torch.Tensor`) : Входящий образец.

	temb (`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.AutoencoderKLLTXVideo.tiled_decode]]

	```python
	tiled_decode(z: Tensor, temb: typing.Optional[torch.Tensor], return_dict: bool = True)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1389)

	Параметры:

	z (`torch.Tensor`) : Входная партия латентных векторов.

	return_dict (`bool`, необязательный, по умолчанию `True`) : Возвращать ли `~models.vae.DecoderOutput` вместо обычного кортежа.

	Возвращает: `~models.vae.DecoderOutput` или `tuple`

	Если return_dict равно True, возвращается `~models.vae.DecoderOutput`, иначе возвращается обычный `tuple`.

	Декодирование пакета изображений с использованием тайлованного декодера.

	#### tiled_encode[[diffusers.AutoencoderKLLTXVideo.tiled_encode]]

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

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_ltx.py#L1338)

	Параметры:

	x (`torch.Tensor`) : Входная партия видео.

	Возвращает: `torch.Tensor`

	Латентное представление закодированных видео.

	Кодирует пакет изображений с использованием тайлованного энкодера.

	## AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]

	#### diffusers.models.modeling_outputs.AutoencoderKLOutput[[diffusers.models.modeling_outputs.AutoencoderKLOutput]]

	```python
	diffusers.models.modeling_outputs.AutoencoderKLOutput(latent_dist: DiagonalGaussianDistribution)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L7)

	Параметры:

	latent_dist (`DiagonalGaussianDistribution`) : Закодированные выходные данные `Encoder`, представленные в виде среднего и logvar распределения `DiagonalGaussianDistribution`. `DiagonalGaussianDistribution` позволяет извлекать латентные переменные из этого распределения.

	Результат метода кодирования AutoencoderKL.

	## 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/main/src/diffusers/models/autoencoders/vae.py#L49)

	Параметры:

	sample (`torch.Tensor` формы `(batch_size, num_channels, height, width)`) : Декодированный вывод из последнего слоя модели.

	Результат метода декодирования.