# EDMEulerScheduler

Karras et al.의 [Elucidating the Design Space of Diffusion-Based Generative Models](https://huggingface.co/papers/2206.00364) 논문에서 제시한 Euler 스케줄러의 Karras 공식(Algorithm 2)입니다. 이는 20~30단계로 좋은 출력을 생성할 수 있는 빠른 스케줄러입니다. 해당 스케줄러는 [Katherine Crowson](https://github.com/crowsonkb/)의 원래 [k-diffusion](https://github.com/crowsonkb/k-diffusion/blob/481677d114f6ea445aa009cf5bd7a9cdee909e47/k_diffusion/sampling.py#L51) 구현을 기반으로 합니다.

## EDMEulerScheduler[[diffusers.EDMEulerScheduler]]

#### diffusers.EDMEulerScheduler[[diffusers.EDMEulerScheduler]]

```python
diffusers.EDMEulerScheduler(sigma_min: float = 0.002, sigma_max: float = 80.0, sigma_data: float = 0.5, sigma_schedule: typing.Literal['karras', 'exponential'] = 'karras', num_train_timesteps: int = 1000, prediction_type: typing.Literal['epsilon', 'v_prediction'] = 'epsilon', rho: float = 7.0, final_sigmas_type: typing.Literal['zero', 'sigma_min'] = 'zero')
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L49)

**매개변수:**

sigma_min (`float`, *선택 사항*, 기본값 `0.002`) : 시그마 스케줄의 최소 노이즈 크기입니다. EDM 논문 [1]에서는 0.002로 설정했으며, 적절한 범위는 [0, 10]입니다.

sigma_max (`float`, *선택 사항*, 기본값 `80.0`) : 시그마 스케줄의 최대 노이즈 크기입니다. EDM 논문 [1]에서는 80.0으로 설정했으며, 적절한 범위는 [0.2, 80.0]입니다.

sigma_data (`float`, *선택 사항*, 기본값 `0.5`) : 데이터 분포의 표준 편차입니다. EDM 논문 [1]에서는 0.5로 설정되어 있습니다.

sigma_schedule (`Literal["karras", "exponential"]`, *선택 사항*, 기본값은 `"karras"`) : `sigmas`를 계산할 시그마 스케줄입니다. 기본적으로 EDM 논문(https://huggingface.co/papers/2206.00364)에서 소개된 스케줄을 사용합니다. `"exponential"` 스케줄은 이 모델에 적용되었습니다: https://huggingface.co/stabilityai/cosxl.

num_train_timesteps (`int`, *선택 사항*, 기본값 `1000`) : 모델을 학습할 때 사용할 diffusion step 수입니다.

prediction_type (`Literal["epsilon", "v_prediction"]`, *선택 사항*, 기본값은 `"epsilon"`) : 스케줄러 함수의 예측 유형. `"epsilon"`은 확산 과정의 노이즈를 예측하고, `"v_prediction"`은 [Imagen Video](https://huggingface.co/papers/2210.02303) 논문 2.4절을 참조하세요.

rho (`float`, *선택 사항*, 기본값 `7.0`) : Karras sigma 스케줄을 계산하는 데 사용되는 rho 파라미터로, EDM 논문 [1]에서 7.0으로 설정되어 있습니다.

final_sigmas_type (`Literal["zero", "sigma_min"]`, *선택 사항*, 기본값은 `"zero"`) : 샘플링 과정에서 노이즈 스케줄의 최종 `sigma` 값입니다. `"sigma_min"`인 경우, 최종 sigma는 학습 스케줄의 마지막 sigma와 동일합니다. `"zero"`인 경우, 최종 sigma는 0으로 설정됩니다.

Karras et al. 2022 [1]에서 제시한 EDM 공식의 Euler 스케줄러를 구현합니다.

[1] Karras, Tero, et al. "Elucidating the Design Space of Diffusion-Based Generative Models." https://huggingface.co/papers/2206.00364

이 모델은 [SchedulerMixin](/docs/diffusers/main/ko/api/schedulers/overview#diffusers.SchedulerMixin)과 [ConfigMixin](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin)을 상속합니다. 로딩 및 저장과 같은 모든 스케줄러에 대해 라이브러리가 구현하는 일반적 메서드에 대해서는 상위 클래스 문서를 확인하세요.

#### add_noise[[diffusers.EDMEulerScheduler.add_noise]]

```python
add_noise(original_samples: Tensor, noise: Tensor, timesteps: Tensor)
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L536)

**매개변수:**

original_samples (`torch.Tensor`) : 노이즈가 추가될 원래 샘플.

noise (`torch.Tensor`) : 원래 샘플에 추가할 노이즈 텐서.

timesteps (`torch.Tensor`) : 노이즈를 추가할 타임스텝으로, 스케줄에서 노이즈 레벨을 결정합니다.

**반환값:** `torch.Tensor`

timestep 스케줄에 따라 노이즈가 스케일링되어 추가된 노이즈 샘플.

지정된 timesteps의 noise schedule에 따라 원래 샘플에 노이즈를 추가합니다.

#### index_for_timestep[[diffusers.EDMEulerScheduler.index_for_timestep]]

```python
index_for_timestep(timestep: typing.Union[float, torch.Tensor], schedule_timesteps: typing.Optional[torch.Tensor] = None)
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L381)

**매개변수:**

timestep (`float` 또는 `torch.Tensor`) : 스케줄에서 찾을 타임스텝 값.

schedule_timesteps (`torch.Tensor`, *선택 사항*) : 검색할 timestep schedule입니다. `None`인 경우 `self.timesteps`를 사용합니다.

**반환값:** `int`

스케줄에서 timestep의 인덱스입니다. 가장 첫 번째 단계의 경우, 스케줄 중간에서 시작할 때(예: image-to-image) sigma를 건너뛰지 않도록 여러 매치가 존재하면 두 번째 인덱스를 반환합니다.

…

#### precondition_inputs[[diffusers.EDMEulerScheduler.precondition_inputs]]

```python
precondition_inputs(sample: Tensor, sigma: typing.Union[float, torch.Tensor])
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L177)

**매개변수:**

sample (`torch.Tensor`) : 전처리할 입력 샘플 텐서.

sigma (`float` 또는 `torch.Tensor`) : 현재 sigma(노이즈 레벨) 값.

**반환값:** `torch.Tensor`

스케일된 입력 샘플.

EDM 공식에 따라 입력 샘플을 스케일링하여 전처리합니다.

#### precondition_noise[[diffusers.EDMEulerScheduler.precondition_noise]]

```python
precondition_noise(sigma: typing.Union[float, torch.Tensor])
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L195)

**매개변수:**

sigma (`float` 또는 `torch.Tensor`) : 전처리할 시그마(노이즈 레벨) 값.

**반환값:** `torch.Tensor`

`0.25 * log(sigma)`로 계산된 사전 조건화 노이즈 값.

로그 변환을 적용하여 노이즈 레벨을 사전 처리합니다.

#### precondition_outputs[[diffusers.EDMEulerScheduler.precondition_outputs]]

```python
precondition_outputs(sample: Tensor, model_output: Tensor, sigma: typing.Union[float, torch.Tensor])
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L214)

**매개변수:**

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

model_output (`torch.Tensor`) : 학습된 diffusion 모델의 직접적인 출력입니다.

sigma (`float` 또는 `torch.Tensor`) : 현재 sigma(노이즈 레벨) 값.

**반환값:** `torch.Tensor`

skip connection과 output scaling을 결합하여 계산된 denoised sample.

EDM 공식에 따라 모델 출력을 사전 조건화합니다.

#### scale_model_input[[diffusers.EDMEulerScheduler.scale_model_input]]

```python
scale_model_input(sample: Tensor, timestep: typing.Union[float, torch.Tensor])
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L249)

**매개변수:**

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

timestep (`float` 또는 `torch.Tensor`) : diffusion chain의 현재 timestep.

**반환값:** `torch.Tensor`

스케일된 입력 샘플.

Euler 알고리즘에 맞게 denoising model 입력을 스케일링합니다. 현재 timestep에 따라 denoising model 입력을 스케일링해야 하는 스케줄러와의 호환성을 보장합니다.

#### set_begin_index[[diffusers.EDMEulerScheduler.set_begin_index]]

```python
set_begin_index(begin_index: int = 0)
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L167)

**매개변수:**

begin_index (`int`, 기본값 `0`) : 스케줄러의 시작 인덱스입니다.

… 스케줄러의 시작 인덱스를 설정합니다. 이 함수는 추론 전에 파이프라인에서 실행해야 합니다.

#### set_timesteps[[diffusers.EDMEulerScheduler.set_timesteps]]

```python
set_timesteps(num_inference_steps: int = None, device: typing.Union[str, torch.device] = None, sigmas: typing.Union[list[float], torch.Tensor, NoneType] = None)
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L273)

**매개변수:**

num_inference_steps (`int`, *선택 사항*) : 사전 학습된 모델로 샘플을 생성할 때 사용되는 확산 단계 수입니다.

device (`str` 또는 `torch.device`, *선택 사항*) : timesteps를 이동할 대상 device입니다. `None`인 경우 timesteps는 이동되지 않습니다.

sigmas (`torch.Tensor | list[float]`, *선택 사항*) : 노이즈 제거 과정에 사용할 커스텀 시그마입니다. 정의되지 않은 경우, `num_inference_steps`가 전달될 때의 기본 동작이 사용됩니다.

추론 실행 전에 실행할 diffusion chain에 사용할 이산 timesteps를 설정합니다.

#### step[[diffusers.EDMEulerScheduler.step]]

```python
step(model_output: Tensor, timestep: typing.Union[float, torch.Tensor], sample: Tensor, s_churn: float = 0.0, s_tmin: float = 0.0, s_tmax: float = inf, s_noise: float = 1.0, generator: typing.Optional[torch.Generator] = None, return_dict: bool = True, pred_original_sample: typing.Optional[torch.Tensor] = None)
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L427)

**매개변수:**

model_output (`torch.Tensor`) : 학습된 diffusion 모델의 직접적인 출력입니다.

timestep (`float` 또는 `torch.Tensor`) : 확산 체인(diffusion chain)의 현재 이산 시간 단계(discrete timestep).

sample (`torch.Tensor`) : 확산 과정에서 생성된 샘플의 현재 인스턴스.

s_churn (`float`, *선택 사항*, 기본값 `0.0`) : 각 단계에 추가할 확률적 노이즈의 양입니다. 값이 높을수록 더 많은 노이즈가 추가됩니다.

s_tmin (`float`, *선택 사항*, 기본값 `0.0`) : 이 값보다 낮은 시그마 임계값 이하에서는 노이즈가 추가되지 않습니다.

s_tmax (`float`, *선택 사항*, 기본값 `float("inf")`) : 이 임계값을 초과하면 노이즈가 추가되지 않는 최대 시그마 값입니다.

s_noise (`float`, *선택 사항*, 기본값 `1.0`) : 샘플에 추가되는 노이즈의 스케일링 계수입니다.

generator (`torch.Generator`, *선택 사항*) : 재현성을 위한 난수 생성기.

return_dict (`bool`, *선택 사항*, 기본값 `True`) : [EDMEulerSchedulerOutput](/docs/diffusers/main/ko/api/schedulers/edm_euler#diffusers.schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput) 또는 tuple을 반환할지 여부.

pred_original_sample (`torch.Tensor`, *선택 사항*) : 이전 단계에서 예측된 노이즈 제거 샘플입니다. 제공되면 재계산을 건너뜁니다.

**반환값:** [EDMEulerSchedulerOutput](/docs/diffusers/main/ko/api/schedulers/edm_euler#diffusers.schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput) 또는 `tuple`

`return_dict`가 `True`인 경우 [EDMEulerSchedulerOutput](/docs/diffusers/main/ko/api/schedulers/edm_euler#diffusers.schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput)가 반환되고, 그렇지 않으면 첫 번째 요소가 이전 샘플 텐서, 두 번째 요소가 예측된 원래 샘플 텐서인 튜플이 반환됩니다.

이전 시간 단계의 샘플을 SDE를 역방향으로 적용하여 예측합니다. 이 함수는 학습된 모델의 출력(대부분 예측된 노이즈)으로부터 확산 과정을 전파합니다.

## EDMEulerSchedulerOutput[[diffusers.schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput]]

#### diffusers.schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput[[diffusers.schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput]]

```python
diffusers.schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput(prev_sample: Tensor, pred_original_sample: typing.Optional[torch.Tensor] = None)
```

[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_edm_euler.py#L32)

**매개변수:**

prev_sample (`torch.Tensor`, 이미지인 경우 shape는 `(batch_size, num_channels, height, width)`) : 이전 timestep의 계산된 샘플 `(x_{t-1})`. `prev_sample`은 denoising 루프에서 다음 모델 입력으로 사용해야 합니다.

pred_original_sample (`torch.Tensor`, 이미지인 경우 shape는 `(batch_size, num_channels, height, width)`) : 현재 timestep의 모델 출력에 기반한 예측된 노이즈 제거 샘플 `(x_{0})`. `pred_original_sample`은 진행 상황 미리보기 또는 가이던스에 사용할 수 있습니다.

스케줄러의 `step` 함수 출력을 위한 출력 클래스입니다.