# DDIMInverseScheduler

`DDIMInverseScheduler`는 Jiaming Song, Chenlin Meng, Stefano Ermon의 [Denoising Diffusion Implicit Models](https://huggingface.co/papers/2010.02502)(DDIM)에서 역전된 스케줄러입니다. 구현은 주로 [Null-text Inversion for Editing Real Images using Guided Diffusion Models](https://huggingface.co/papers/2211.09794)의 DDIM 역전 정의에 기반합니다.

## DDIMInverseScheduler[[diffusers.DDIMInverseScheduler]]

#### diffusers.DDIMInverseScheduler[[diffusers.DDIMInverseScheduler]]

```python
diffusers.DDIMInverseScheduler(num_train_timesteps: int = 1000, beta_start: float = 0.0001, beta_end: float = 0.02, beta_schedule: typing.Literal['linear', 'scaled_linear', 'squaredcos_cap_v2'] = 'linear', trained_betas: numpy.ndarray | list[float] | None = None, clip_sample: bool = True, set_alpha_to_one: bool = True, steps_offset: int = 0, prediction_type: typing.Literal['epsilon', 'sample', 'v_prediction'] = 'epsilon', clip_sample_range: float = 1.0, timestep_spacing: typing.Literal['leading', 'trailing'] = 'leading', rescale_betas_zero_snr: bool = False, **kwargs)
```

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

**매개변수:**

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

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

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

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

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

clip_sample (`bool`, 기본값 `True`) : 수치적 안정성을 위해 예측된 샘플을 클리핑합니다.

clip_sample_range (`float`, 기본값 1.0) : 샘플 클리핑의 최대 크기입니다. `clip_sample=True`일 때만 유효합니다.

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

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

prediction_type (`str`, 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).

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

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

`DDIMInverseScheduler`는 [DDIMScheduler](/docs/diffusers/main/ko/api/schedulers/ddim#diffusers.DDIMScheduler)의 역 스케줄러입니다.

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

#### scale_model_input[[diffusers.DDIMInverseScheduler.scale_model_input]]

```python
scale_model_input(sample: Tensor, timestep: int | None = None)
```

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

**매개변수:**

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

timestep (`int`, *선택 사항*) : 확산 체인에서의 현재 시간 단계입니다.

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

스케일된 입력 샘플.

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

#### set_timesteps[[diffusers.DDIMInverseScheduler.set_timesteps]]

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

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

**매개변수:**

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

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

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

#### step[[diffusers.DDIMInverseScheduler.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_ddim_inverse.py#L311)

**매개변수:**

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

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

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

return_dict (`bool`, *선택 사항*, 기본값 `True`) : `~schedulers.scheduling_ddim_inverse.DDIMInverseSchedulerOutput` 또는 `tuple`을 반환할지 여부.

**반환값:** `~schedulers.scheduling_ddim_inverse.DDIMInverseSchedulerOutput` 또는 `tuple`

return_dict가 `True`인 경우 `~schedulers.scheduling_ddim_inverse.DDIMInverseSchedulerOutput`이 반환되고, 그렇지 않으면 첫 번째 요소가 샘플 텐서인 튜플이 반환됩니다.

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

