# PNDMScheduler

`PNDMScheduler`, 즉 확산 모델용 의사 수치 기법(pseudo numerical methods for diffusion models)은 Runge-Kutta 및 선형 다단계 방법과 같은 더 고급 ODE 적분 기법을 사용합니다. 원래 구현은 [crowsonkb/k-diffusion](https://github.com/crowsonkb/k-diffusion/blob/481677d114f6ea445aa009cf5bd7a9cdee909e47/k_diffusion/sampling.py#L181)에서 찾을 수 있습니다.

## PNDMScheduler[[diffusers.PNDMScheduler]]

#### diffusers.PNDMScheduler[[diffusers.PNDMScheduler]]

```python
diffusers.PNDMScheduler(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, skip_prk_steps: bool = False, set_alpha_to_one: bool = False, prediction_type: typing.Literal['epsilon', 'v_prediction'] = 'epsilon', timestep_spacing: typing.Literal['linspace', 'leading', 'trailing'] = 'leading', steps_offset: int = 0)
```

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

**매개변수:**

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

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

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

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

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

skip_prk_steps (`bool`, 기본값 `False`) : PLMS 단계 전에 필요하다고 원 논문에서 정의된 Runge-Kutta 단계를 스케줄러가 건너뛰도록 허용합니다.

set_alpha_to_one (`bool`, 기본값은 `False`) : 각 diffusion 단계는 해당 단계와 이전 단계의 alphas product 값을 사용합니다. 마지막 단계에는 이전 alpha가 없습니다. 이 옵션이 `True`인 경우 이전 alpha product는 `1`로 고정되고, 그렇지 않으면 step 0의 alpha 값을 사용합니다.

prediction_type (`"epsilon"` 또는 `"v_prediction"`, 기본값은 `"epsilon"`) : 스케줄러 함수의 예측 유형; `epsilon`(확산 과정의 노이즈를 예측) 또는 `v_prediction`([Imagen Video](https://huggingface.co/papers/2210.02303) 논문의 2.4절을 참조)를 사용할 수 있습니다.

timestep_spacing (`"linspace"`, `"leading"`, 또는 `"trailing"`, 기본값은 `"leading"`) : timesteps를 스케일링하는 방식. 자세한 내용은 [일반적인 확산 노이즈 스케줄과 샘플 스텝은 결함이 있다](https://huggingface.co/papers/2305.08891)의 Table 2를 참조하세요.

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

`PNDMScheduler`는 Runge-Kutta 및 선형 다단계 방법과 같은 확산 모델용 의사 수치 방법을 사용합니다.

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

#### add_noise[[diffusers.PNDMScheduler.add_noise]]

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

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

**매개변수:**

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

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

timesteps (`torch.IntTensor`) : 각 샘플의 노이즈 수준을 나타내는 timesteps.

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

노이즈가 포함된 샘플.

각 timestep의 노이즈 크기에 따라 원래 샘플에 노이즈를 추가합니다(이것은 forward diffusion process입니다).

#### scale_model_input[[diffusers.PNDMScheduler.scale_model_input]]

```python
scale_model_input(sample: Tensor, *args, **kwargs)
```

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

**매개변수:**

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

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

스케일된 입력 샘플.

현재 타임스텝에 따라 디노이징 모델 입력을 스케일링해야 하는 스케줄러와의 호환성을 보장합니다.

#### set_timesteps[[diffusers.PNDMScheduler.set_timesteps]]

```python
set_timesteps(num_inference_steps: int, device: typing.Union[str, torch.device] = None)
```

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

**매개변수:**

num_inference_steps (`int`) : 사전 학습된 모델로 샘플을 생성할 때 사용되는 확산 단계의 수.

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

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

#### step[[diffusers.PNDMScheduler.step]]

```python
step(model_output: Tensor, timestep: int, sample: Tensor, return_dict: bool = True)
```

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

**매개변수:**

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

timestep (`int`) : 확산 체인(diffusion chain)의 현재 이산 시간 단계(discrete timestep).

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

return_dict (`bool`, 기본값 `True`) : [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) 또는 `tuple`를 반환할지 여부.

**반환값:** [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) 또는 `tuple`

return_dict가 `True`인 경우 [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput)이 반환되고, 그렇지 않으면 첫 번째 요소가 샘플 텐서인 튜플이 반환됩니다.

이전 시간 단계의 샘플을 SDE를 역방향으로 적용하여 예측합니다. 이 함수는 학습된 모델의 출력(대부분 예측된 노이즈)으로부터 확산 과정을 전파하며, 내부 변수 `counter`에 따라 [step_prk()](/docs/diffusers/main/ko/api/schedulers/pndm#diffusers.PNDMScheduler.step_prk) 또는 [step_plms()](/docs/diffusers/main/ko/api/schedulers/pndm#diffusers.PNDMScheduler.step_plms)를 호출합니다.

#### step_plms[[diffusers.PNDMScheduler.step_plms]]

```python
step_plms(model_output: Tensor, timestep: int, sample: Tensor, return_dict: bool = True)
```

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

**매개변수:**

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

timestep (`int`) : 확산 체인(diffusion chain)의 현재 이산 시간 단계(discrete timestep).

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

return_dict (`bool`, 기본값 `True`) : [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) 또는 튜플을 반환할지 여부.

**반환값:** [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) 또는 `tuple`

return_dict가 `True`인 경우 [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput)이 반환되고, 그렇지 않으면 첫 번째 요소가 샘플 텐서인 튜플이 반환됩니다.

이전 시간 단계의 샘플을 SDE를 역방향으로 적용하여 예측합니다. 이 함수는 선형 다단계 방법을 사용하여 샘플을 전파합니다. 해를 근사하기 위해 포워드 패스를 여러 번 수행합니다.

#### step_prk[[diffusers.PNDMScheduler.step_prk]]

```python
step_prk(model_output: Tensor, timestep: int, sample: Tensor, return_dict: bool = True)
```

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

**매개변수:**

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

timestep (`int`) : 확산 체인(diffusion chain)의 현재 이산 시간 단계(discrete timestep).

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

return_dict (`bool`, 기본값 `True`) : [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) 또는 튜플을 반환할지 여부.

**반환값:** [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) 또는 `tuple`

return_dict가 `True`인 경우 [SchedulerOutput](/docs/diffusers/main/ko/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput)이 반환되고, 그렇지 않으면 첫 번째 요소가 샘플 텐서인 튜플이 반환됩니다.

이전 시간 단계의 샘플을 SDE를 역방향으로 적용하여 예측합니다. 이 함수는 Runge-Kutta 방법을 사용하여 샘플을 전파합니다. 미분 방정식의 해를 근사하기 위해 4회의 순전파를 수행합니다.

## SchedulerOutput[[diffusers.schedulers.scheduling_utils.SchedulerOutput]]

#### diffusers.schedulers.scheduling_utils.SchedulerOutput[[diffusers.schedulers.scheduling_utils.SchedulerOutput]]

```python
diffusers.schedulers.scheduling_utils.SchedulerOutput(prev_sample: Tensor)
```

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

**매개변수:**

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

스케줄러의 `step` 함수 출력을 위한 베이스 클래스.