# EulerDiscreteScheduler

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

## EulerDiscreteScheduler[[diffusers.EulerDiscreteScheduler]]

#### diffusers.EulerDiscreteScheduler[[diffusers.EulerDiscreteScheduler]]

```python
diffusers.EulerDiscreteScheduler(num_train_timesteps: int = 1000, beta_start: float = 0.0001, beta_end: float = 0.02, beta_schedule: str = 'linear', trained_betas: numpy.ndarray | list[float] | None = None, prediction_type: str = 'epsilon', interpolation_type: str = 'linear', use_karras_sigmas: bool | None = False, use_exponential_sigmas: bool | None = False, use_beta_sigmas: bool | None = False, sigma_min: float | None = None, sigma_max: float | None = None, timestep_spacing: typing.Literal['linspace', 'leading', 'trailing'] = 'linspace', timestep_type: typing.Literal['discrete', 'continuous'] = 'discrete', steps_offset: int = 0, rescale_betas_zero_snr: bool = False, final_sigmas_type: typing.Literal['zero', 'sigma_min'] = 'zero')
```

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

**매개변수:**

num_train_timesteps (`int`, 기본값 1000) : 모델을 학습하기 위한 diffusion step 수입니다.

beta_start (`float`, 기본값 0.0001) : 추론의 시작 `beta` 값입니다.

beta_end (`float`, 기본값 0.02) : 최종 `beta` 값.

beta_schedule (`Literal["linear", "scaled_linear", "squaredcos_cap_v2"]`, 기본값은 `"linear"`) : 베타 스케줄입니다. 베타 범위를 모델의 스테핑에 사용할 베타 시퀀스로 매핑합니다. `"linear"`, `"scaled_linear"`, 또는 `"squaredcos_cap_v2"` 중 하나를 선택합니다.

trained_betas (`np.ndarray`, *선택 사항*) : `beta_start`와 `beta_end`를 우회하여 베타 배열을 생성자에 직접 전달합니다.

prediction_type (`Literal["epsilon", "sample", "v_prediction"]`, defaults to `"epsilon"`, *optional*) : Prediction type of the scheduler function; can be `"epsilon"` (predicts the noise of the diffusion process), `"sample"` (directly predicts the noisy sample`) or `"v_prediction"` (see section 2.4 of [Imagen Video](https://huggingface.co/papers/2210.02303) paper).

interpolation_type (`Literal["linear", "log_linear"]`, 기본값 `"linear"`, *선택 사항*) : 스케줄러의 디노이징 단계에서 중간 시그마를 계산하기 위한 보간 유형입니다. `"linear"` 또는 `"log_linear"` 중 하나여야 합니다.

use_karras_sigmas (`bool`, *선택 사항*, 기본값 `False`) : 샘플링 과정에서 노이즈 스케줄의 단계 크기에 Karras sigmas를 사용할지 여부입니다. `True`인 경우, sigmas는 노이즈 레벨 {σi}의 시퀀스에 따라 결정됩니다.

use_exponential_sigmas (`bool`, *선택 사항*, 기본값 `False`) : 샘플링 과정에서 노이즈 스케줄의 스텝 크기에 지수 시그마를 사용할지 여부입니다.

use_beta_sigmas (`bool`, *optional*, defaults to `False`) : Whether to use beta sigmas for step sizes in the noise schedule during the sampling process. Refer to [Beta Sampling is All You Need](https://huggingface.co/papers/2407.12173) for more information.

sigma_min (`float`, *선택 사항*) : 노이즈 스케줄의 최소 sigma 값입니다. 제공되지 않으면 스케줄의 마지막 sigma 값이 기본값으로 사용됩니다.

sigma_max (`float`, *선택 사항*) : 노이즈 스케줄의 최대 시그마 값입니다. 제공되지 않으면 스케줄의 첫 번째 시그마 값이 기본값으로 사용됩니다.

timestep_spacing (`Literal["linspace", "leading", "trailing"]`, defaults to `"linspace"`) : The way the timesteps should be scaled. Refer to Table 2 of the [Common Diffusion Noise Schedules and Sample Steps are Flawed](https://huggingface.co/papers/2305.08891) for more information.

timestep_type (`Literal["discrete", "continuous"]`, 기본값은 `"discrete"`) : 사용할 timesteps의 유형입니다. `"discrete"` 또는 `"continuous"`를 사용할 수 있습니다.

steps_offset (`int`, 기본값 0) : 일부 모델 계열에서 요구하는 추론 단계에 추가되는 오프셋입니다.

rescale_betas_zero_snr (`bool`, 기본값 `False`) : 베타를 재조정하여 최종 SNR이 0이 되도록 할지 여부입니다. 이를 통해 모델은 중간 밝기의 샘플로 제한되는 대신 매우 밝고 어두운 샘플을 생성할 수 있습니다. [`--offset_noise`](https://github.com/huggingface/diffusers/blob/74fd735eb073eb1d774b1ab4154a0876eb82f055/examples/dreambooth/train_dreambooth.py#L506)와 느슨하게 관련이 있습니다.

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

Euler 스케줄러.

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

#### add_noise[[diffusers.EulerDiscreteScheduler.add_noise]]

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

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

**매개변수:**

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

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

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

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

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

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

#### get_velocity[[diffusers.EulerDiscreteScheduler.get_velocity]]

```python
get_velocity(sample: Tensor, noise: Tensor, timesteps: Tensor)
```

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

**매개변수:**

sample (`torch.Tensor`) : 속도를 계산할 입력 샘플.

noise (`torch.Tensor`) : 샘플에 해당하는 노이즈 텐서.

timesteps (`torch.Tensor`) : 속도를 계산할 타임스텝.

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

`sqrt(alpha_prod) * noise - sqrt(1 - alpha_prod) * sample`로 계산된 속도 예측입니다.

…

이 메서드는 v-prediction 모델에서 사용되는 속도 예측을 구현하며, 샘플과 노이즈의 선형 결합을 예측합니다.

#### index_for_timestep[[diffusers.EulerDiscreteScheduler.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_euler_discrete.py#L640)

**매개변수:**

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

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

**반환값:** `int`

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

…

#### scale_model_input[[diffusers.EulerDiscreteScheduler.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_euler_discrete.py#L326)

**매개변수:**

sample (`torch.Tensor`) : 스케일링할 입력 샘플.

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

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

`(sigma**2 + 1) ** 0.5`로 나눈 스케일링된 입력 샘플.

현재 timestep에 따라 denoising 모델 입력을 스케일링해야 하는 스케줄러와의 호환성을 보장합니다. Euler 알고리즘에 맞추기 위해 denoising 모델 입력을 `(sigma**2 + 1) ** 0.5`로 스케일링합니다.

#### set_begin_index[[diffusers.EulerDiscreteScheduler.set_begin_index]]

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

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

**매개변수:**

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

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

#### set_timesteps[[diffusers.EulerDiscreteScheduler.set_timesteps]]

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

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

**매개변수:**

num_inference_steps (`int`, *선택 사항*) : 사전 학습된 모델로 샘플을 생성할 때 사용되는 확산 단계 수입니다. `None`인 경우 `timesteps` 또는 `sigmas`를 제공해야 합니다.

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

timesteps (`list[int]`, *선택 사항*) : 임의의 timesteps 스케줄을 지원하기 위해 사용되는 사용자 지정 timesteps입니다. `None`인 경우, `timestep_spacing` 속성에 기반하여 timesteps가 생성됩니다. `timesteps`가 전달되면 `num_inference_steps`와 `sigmas`는 `None`이어야 하며, `timestep_spacing` 속성은 무시됩니다.

sigmas (`list[float]`, *선택 사항*) : 임의의 timesteps 스케줄을 지원하기 위해 사용되는 사용자 정의 sigmas입니다. `None`인 경우, 관련 스케줄러 속성에 기반하여 timesteps와 sigmas가 생성됩니다. `sigmas`가 전달되면 `num_inference_steps`와 `timesteps`는 `None`이어야 하며, timesteps는 사용자 정의 sigmas 스케줄에 기반하여 생성됩니다.

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

#### step[[diffusers.EulerDiscreteScheduler.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)
```

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

**매개변수:**

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`) : 확률성을 적용하기 위한 최소 timestep 임계값입니다. 이 값보다 큰 timestep에만 노이즈가 추가됩니다.

s_tmax (`float`, *선택 사항*, 기본값 `inf`) : 확률성을 적용할 최대 타임스텝 임계값입니다. 이 값보다 작은 타임스텝에만 노이즈가 추가됩니다.

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

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

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

**반환값:** [EulerDiscreteSchedulerOutput](/docs/diffusers/main/ko/api/schedulers/euler#diffusers.schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput) 또는 `tuple`

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

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

## EulerDiscreteSchedulerOutput[[diffusers.schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput]]

#### diffusers.schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput[[diffusers.schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput]]

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

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

**매개변수:**

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` 함수 출력을 위한 출력 클래스입니다.