Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /ko /api /models /autoencoderkl_allegro.md

mishig

about 15 hours ago

preview code

download

raw

8.1 kB

# AutoencoderKLAllegro

[Allegro](https://github.com/rhymes-ai/Allegro)에서 사용된 KL loss를 적용한 3D 변분 오토인코더(VAE) 모델은 RhymesAI의 [Allegro: Open the Black Box of Commercial-Level Video Generation Model](https://huggingface.co/papers/2410.15458)에서 소개되었습니다.

다음 코드 스니펫으로 모델을 로드할 수 있습니다.

```python
from diffusers import AutoencoderKLAllegro
vae = AutoencoderKLAllegro.from_pretrained("rhymes-ai/Allegro", subfolder="vae", dtype=torch.float32).to("cuda")  # or "mps", "xpu", "cpu"
```

## AutoencoderKLAllegro[[diffusers.AutoencoderKLAllegro]]

#### diffusers.AutoencoderKLAllegro[[diffusers.AutoencoderKLAllegro]]

```python
diffusers.AutoencoderKLAllegro(in_channels: int = 3, out_channels: int = 3, down_block_types: tuple = ('AllegroDownBlock3D', 'AllegroDownBlock3D', 'AllegroDownBlock3D', 'AllegroDownBlock3D'), up_block_types: tuple = ('AllegroUpBlock3D', 'AllegroUpBlock3D', 'AllegroUpBlock3D', 'AllegroUpBlock3D'), block_out_channels: tuple = (128, 256, 512, 512), temporal_downsample_blocks: tuple = (True, True, False, False), temporal_upsample_blocks: tuple = (False, True, True, False), latent_channels: int = 4, layers_per_block: int = 2, act_fn: str = 'silu', norm_num_groups: int = 32, temporal_compression_ratio: float = 4, sample_size: int = 320, scaling_factor: float = 0.13, force_upcast: bool = True)
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L676)

**매개변수:**

in_channels (int, 기본값 `3`) : 입력 이미지의 채널 수.
out_channels (int, 기본값 `3`) : 출력의 채널 수.

down_block_types (`tuple[str, ...]`, 기본값은 `("AllegroDownBlock3D", "AllegroDownBlock3D", "AllegroDownBlock3D", "AllegroDownBlock3D")`) : 사용할 다운 블록의 유형을 나타내는 문자열 튜플.

up_block_types (`tuple[str, ...]`, 기본값은 `("AllegroUpBlock3D", "AllegroUpBlock3D", "AllegroUpBlock3D", "AllegroUpBlock3D")`) : 사용할 업 블록의 유형을 나타내는 문자열 튜플.

block_out_channels (`tuple[int, ...]`, 기본값 `(128, 256, 512, 512)`) : 각 블록의 출력 채널 수를 나타내는 정수 튜플.

temporal_downsample_blocks (`tuple[bool, ...]`, 기본값은 `(True, True, False, False)`) : 시간적 다운샘플링을 활성화할 블록을 나타내는 불리언 튜플.

latent_channels (`int`, 기본값 `4`) : latents의 채널 수.
layers_per_block (`int`, 기본값 `2`) : 다운/업 블록당 resnet 또는 attention 또는 temporal convolution 레이어의 수.
act_fn (`str`, 기본값 `"silu"`) : 사용할 활성화 함수입니다.

norm_num_groups (`int`, 기본값 `32`) : 정규화 레이어에서 사용할 그룹 수.

temporal_compression_ratio (`int`, 기본값 `4`) : 샘플의 시간 차원이 압축되는 비율입니다.

sample_size (`int`, 기본값 `320`) : 기본 latent 크기입니다.
scaling_factor (`float`, 기본값 `0.13235`) : 학습 세트의 첫 번째 배치로 계산된 학습된 잠재 공간의 구성 요소별 표준 편차입니다. 이는 diffusion model을 학습할 때 잠재 공간의 분산을 1로 스케일링하는 데 사용됩니다. Latents는 diffusion model에 전달되기 전에 `z = z * scaling_factor` 공식으로 스케일링됩니다. 디코딩 시에는 `z = 1 / scaling_factor * z` 공식으로 latents를 원래 스케일로 되돌립니다. 자세한 내용은 [High-Resolution Image Synthesis with Latent Diffusion Models](https://huggingface.co/papers/2112.10752) 논문의 4.3.2절과 D.1절을 참조하세요.

force_upcast (`bool`, 기본값 `True`) : 활성화하면 SD-XL과 같은 고해상도 이미지 파이프라인에서 VAE가 float32로 실행되도록 강제합니다. VAE는 정밀도가 크게 손실되지 않는 범위 내에서 더 낮은 범위로 미세 조정/학습될 수 있으며, 이 경우 `force_upcast`를 `False`로 설정할 수 있습니다 - 참고: https://huggingface.co/madebyollin/sdxl-vae-fp16-fix

KL 손실을 사용하여 비디오를 잠재 변수로 인코딩하고 잠재 표현을 비디오로 디코딩하는 VAE 모델입니다. [Allegro](https://github.com/rhymes-ai/Allegro)에서 사용됩니다.

이 모델은 [ModelMixin](/docs/diffusers/main/ko/api/models/overview#diffusers.ModelMixin)에서 상속됩니다. 모든 모델에 대해 구현된 일반적 메서드(다운로드 또는 저장 등)에 대해서는 상위 클래스 문서를 확인하세요.

#### decode[[diffusers.AutoencoderKLAllegro.decode]]

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

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L843)

**매개변수:**

z (`torch.Tensor`) : 잠재 벡터의 입력 배치.

return_dict (`bool`, 기본값 `True`) : 일반 튜플 대신 `~models.vae.DecoderOutput`를 반환할지 여부.
**반환값:** `~models.vae.DecoderOutput` 또는 `tuple`
return_dict가 True이면 `~models.vae.DecoderOutput`가 반환되고, 그렇지 않으면 일반 `tuple`이 반환됩니다.

videos 배치의 디코딩을 수행합니다.

#### encode[[diffusers.AutoencoderKLAllegro.encode]]

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

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L806)

**매개변수:**

x (`torch.Tensor`) : 입력 비디오 배치.

return_dict (`bool`, 기본값 `True`) : 일반 튜플 대신 `~models.autoencoder_kl.AutoencoderKLOutput`을 반환할지 여부.

**반환값:**

인코딩된 비디오의 잠재 표현입니다. `return_dict`가 True이면 `~models.autoencoder_kl.AutoencoderKLOutput`이 반환되고, 그렇지 않으면 일반 `tuple`이 반환됩니다.

…

#### forward[[diffusers.AutoencoderKLAllegro.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/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L1041)

**매개변수:**

sample (`torch.Tensor`) : 입력 샘플.

sample_posterior (`bool`, *선택 사항*, 기본값 `False`) : 사후 분포에서 샘플링할지 여부.
return_dict (`bool`, *선택 사항*, 기본값 `True`) : 일반 튜플 대신 `DecoderOutput`를 반환할지 여부.

generator (`torch.Generator`, *선택 사항*) : PyTorch 난수 생성기.

**반환값:** `~models.vae.DecoderOutput` 또는 `tuple`

`return_dict`가 True이면 `~models.vae.DecoderOutput`가 반환되고, 그렇지 않으면 일반 `tuple`이 반환됩니다.

## 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`의 인코딩된 출력으로, `DiagonalGaussianDistribution`의 평균(mean)과 logvar로 표현됩니다. `DiagonalGaussianDistribution`을 사용하면 해당 분포에서 latents를 샘플링할 수 있습니다.

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`, shape `(batch_size, num_channels, height, width)`) : 모델의 마지막 레이어에서 디코딩된 출력 샘플.

디코딩 메서드의 출력.

Xet Storage Details

Size:: 8.1 kB
Xet hash:: 84767ccf40fd5ea9994bdd9607c493e2fd55f769b78ee747365a6fb732d66fa3

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

	# AutoencoderKLAllegro

	[Allegro](https://github.com/rhymes-ai/Allegro)에서 사용된 KL loss를 적용한 3D 변분 오토인코더(VAE) 모델은 RhymesAI의 [Allegro: Open the Black Box of Commercial-Level Video Generation Model](https://huggingface.co/papers/2410.15458)에서 소개되었습니다.

	다음 코드 스니펫으로 모델을 로드할 수 있습니다.

	```python
	from diffusers import AutoencoderKLAllegro

	vae = AutoencoderKLAllegro.from_pretrained("rhymes-ai/Allegro", subfolder="vae", dtype=torch.float32).to("cuda") # or "mps", "xpu", "cpu"
	```

	## AutoencoderKLAllegro[[diffusers.AutoencoderKLAllegro]]

	#### diffusers.AutoencoderKLAllegro[[diffusers.AutoencoderKLAllegro]]

	```python
	diffusers.AutoencoderKLAllegro(in_channels: int = 3, out_channels: int = 3, down_block_types: tuple = ('AllegroDownBlock3D', 'AllegroDownBlock3D', 'AllegroDownBlock3D', 'AllegroDownBlock3D'), up_block_types: tuple = ('AllegroUpBlock3D', 'AllegroUpBlock3D', 'AllegroUpBlock3D', 'AllegroUpBlock3D'), block_out_channels: tuple = (128, 256, 512, 512), temporal_downsample_blocks: tuple = (True, True, False, False), temporal_upsample_blocks: tuple = (False, True, True, False), latent_channels: int = 4, layers_per_block: int = 2, act_fn: str = 'silu', norm_num_groups: int = 32, temporal_compression_ratio: float = 4, sample_size: int = 320, scaling_factor: float = 0.13, force_upcast: bool = True)
	```

	[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L676)

	매개변수:

	in_channels (int, 기본값 `3`) : 입력 이미지의 채널 수.

	out_channels (int, 기본값 `3`) : 출력의 채널 수.

	down_block_types (`tuple[str, ...]`, 기본값은 `("AllegroDownBlock3D", "AllegroDownBlock3D", "AllegroDownBlock3D", "AllegroDownBlock3D")`) : 사용할 다운 블록의 유형을 나타내는 문자열 튜플.

	up_block_types (`tuple[str, ...]`, 기본값은 `("AllegroUpBlock3D", "AllegroUpBlock3D", "AllegroUpBlock3D", "AllegroUpBlock3D")`) : 사용할 업 블록의 유형을 나타내는 문자열 튜플.

	block_out_channels (`tuple[int, ...]`, 기본값 `(128, 256, 512, 512)`) : 각 블록의 출력 채널 수를 나타내는 정수 튜플.

	temporal_downsample_blocks (`tuple[bool, ...]`, 기본값은 `(True, True, False, False)`) : 시간적 다운샘플링을 활성화할 블록을 나타내는 불리언 튜플.

	latent_channels (`int`, 기본값 `4`) : latents의 채널 수.

	layers_per_block (`int`, 기본값 `2`) : 다운/업 블록당 resnet 또는 attention 또는 temporal convolution 레이어의 수.

	act_fn (`str`, 기본값 `"silu"`) : 사용할 활성화 함수입니다.

	norm_num_groups (`int`, 기본값 `32`) : 정규화 레이어에서 사용할 그룹 수.

	temporal_compression_ratio (`int`, 기본값 `4`) : 샘플의 시간 차원이 압축되는 비율입니다.

	sample_size (`int`, 기본값 `320`) : 기본 latent 크기입니다.

	scaling_factor (`float`, 기본값 `0.13235`) : 학습 세트의 첫 번째 배치로 계산된 학습된 잠재 공간의 구성 요소별 표준 편차입니다. 이는 diffusion model을 학습할 때 잠재 공간의 분산을 1로 스케일링하는 데 사용됩니다. Latents는 diffusion model에 전달되기 전에 `z = z * scaling_factor` 공식으로 스케일링됩니다. 디코딩 시에는 `z = 1 / scaling_factor * z` 공식으로 latents를 원래 스케일로 되돌립니다. 자세한 내용은 [High-Resolution Image Synthesis with Latent Diffusion Models](https://huggingface.co/papers/2112.10752) 논문의 4.3.2절과 D.1절을 참조하세요.

	force_upcast (`bool`, 기본값 `True`) : 활성화하면 SD-XL과 같은 고해상도 이미지 파이프라인에서 VAE가 float32로 실행되도록 강제합니다. VAE는 정밀도가 크게 손실되지 않는 범위 내에서 더 낮은 범위로 미세 조정/학습될 수 있으며, 이 경우 `force_upcast`를 `False`로 설정할 수 있습니다 - 참고: https://huggingface.co/madebyollin/sdxl-vae-fp16-fix

	KL 손실을 사용하여 비디오를 잠재 변수로 인코딩하고 잠재 표현을 비디오로 디코딩하는 VAE 모델입니다. [Allegro](https://github.com/rhymes-ai/Allegro)에서 사용됩니다.

	이 모델은 [ModelMixin](/docs/diffusers/main/ko/api/models/overview#diffusers.ModelMixin)에서 상속됩니다. 모든 모델에 대해 구현된 일반적 메서드(다운로드 또는 저장 등)에 대해서는 상위 클래스 문서를 확인하세요.

	#### decode[[diffusers.AutoencoderKLAllegro.decode]]

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

	[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L843)

	매개변수:

	z (`torch.Tensor`) : 잠재 벡터의 입력 배치.

	return_dict (`bool`, 기본값 `True`) : 일반 튜플 대신 `~models.vae.DecoderOutput`를 반환할지 여부.

	반환값: `~models.vae.DecoderOutput` 또는 `tuple`

	return_dict가 True이면 `~models.vae.DecoderOutput`가 반환되고, 그렇지 않으면 일반 `tuple`이 반환됩니다.

	videos 배치의 디코딩을 수행합니다.

	#### encode[[diffusers.AutoencoderKLAllegro.encode]]

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

	[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L806)

	매개변수:

	x (`torch.Tensor`) : 입력 비디오 배치.

	return_dict (`bool`, 기본값 `True`) : 일반 튜플 대신 `~models.autoencoder_kl.AutoencoderKLOutput`을 반환할지 여부.

	반환값:

	인코딩된 비디오의 잠재 표현입니다. `return_dict`가 True이면 `~models.autoencoder_kl.AutoencoderKLOutput`이 반환되고, 그렇지 않으면 일반 `tuple`이 반환됩니다.

	…

	#### forward[[diffusers.AutoencoderKLAllegro.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/main/src/diffusers/models/autoencoders/autoencoder_kl_allegro.py#L1041)

	매개변수:

	sample (`torch.Tensor`) : 입력 샘플.

	sample_posterior (`bool`, 선택 사항, 기본값 `False`) : 사후 분포에서 샘플링할지 여부.

	return_dict (`bool`, 선택 사항, 기본값 `True`) : 일반 튜플 대신 `DecoderOutput`를 반환할지 여부.

	generator (`torch.Generator`, 선택 사항) : PyTorch 난수 생성기.

	반환값: `~models.vae.DecoderOutput` 또는 `tuple`

	`return_dict`가 True이면 `~models.vae.DecoderOutput`가 반환되고, 그렇지 않으면 일반 `tuple`이 반환됩니다.

	## 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`의 인코딩된 출력으로, `DiagonalGaussianDistribution`의 평균(mean)과 logvar로 표현됩니다. `DiagonalGaussianDistribution`을 사용하면 해당 분포에서 latents를 샘플링할 수 있습니다.

	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`, shape `(batch_size, num_channels, height, width)`) : 모델의 마지막 레이어에서 디코딩된 출력 샘플.

	디코딩 메서드의 출력.