# DPMSolverMultistepScheduler

`DPMSolverMultistepScheduler`, Cheng Lu, Yuhao Zhou, Fan Bao, Jianfei Chen, Chongxuan Li ve Jun Zhu tarafından yazılan [DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps](https://huggingface.co/papers/2206.00927) ve [DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models](https://huggingface.co/papers/2211.01095) makalelerinden bir çok adımlı zamanlayıcıdır.

DPMSolver (ve geliştirilmiş sürüm DPMSolver++) difüzyon ODE'leri için yakınsama derecesi garantisi sunan hızlı, özel bir yüksek dereceli çözücüdür. Deneysel olarak, yalnızca 20 adımla DPMSolver örneklemesi yüksek kaliteli örnekler üretebilir ve 10 adımda bile oldukça iyi örnekler üretebilir.

## İpuçları

Rehber örneklemesi için `solver_order`'ın 2 olarak ayarlanması, koşulsuz örneklemesi için ise `solver_order=3` olarak ayarlanması önerilir.

[Imagen](https://huggingface.co/papers/2205.11487)'den dinik eşikleme desteklenmektedir ve piksel uzayında çalışan difüzyon modelleri için dinamik eşikleme kullanmak üzere hem `algorithm_type="dpmsolver++"` hem de `thresholding=True` değerlerini ayarlayabilirsiniz. Bu eşikleme yöntemi, Stable Diffusion gibi gizli uzayda çalışan difüzyon modelleri için uygun değildir.

DPMSolver ve DPM-Solver++'ın SDE varyantı da desteklenir, ancak yalnızca birinci ve ikinci dereceden çözücüler için. Bu, ters yönlü difüzyon SDE'si için hızlı bir SDE çözücüsüdür. İkinci dereceden `sde-dpmsolver++`'ın kullanılması önerilir.

## DPMSolverMultistepScheduler[[diffusers.DPMSolverMultistepScheduler]]

#### diffusers.DPMSolverMultistepScheduler[[diffusers.DPMSolverMultistepScheduler]]

```python
diffusers.DPMSolverMultistepScheduler(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, solver_order: int = 2, prediction_type: typing.Literal['epsilon', 'sample', 'v_prediction', 'flow_prediction'] = 'epsilon', thresholding: bool = False, dynamic_thresholding_ratio: float = 0.995, sample_max_value: float = 1.0, algorithm_type: typing.Literal['dpmsolver', 'dpmsolver++', 'sde-dpmsolver', 'sde-dpmsolver++'] = 'dpmsolver++', solver_type: typing.Literal['midpoint', 'heun'] = 'midpoint', lower_order_final: bool = True, euler_at_final: bool = False, use_karras_sigmas: bool = False, use_exponential_sigmas: bool = False, use_beta_sigmas: bool = False, use_lu_lambdas: bool = False, use_flow_sigmas: bool = False, flow_shift: float = 1.0, final_sigmas_type: typing.Literal['zero', 'sigma_min'] = 'zero', lambda_min_clipped: float = -inf, variance_type: typing.Optional[typing.Literal['learned', 'learned_range']] = None, timestep_spacing: typing.Literal['linspace', 'leading', 'trailing'] = 'linspace', steps_offset: int = 0, rescale_betas_zero_snr: bool = False, use_dynamic_shifting: bool = False, time_shift_type: typing.Literal['exponential'] = 'exponential')
```

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L123)

**Parametreler:**

num_train_timesteps (`int`, varsayılan 1000) : Modelin eğitileceği difüzyon adım sayısı.

beta_start (`float`, varsayılan 0.0001) : Çıkarımın başlangıç `beta` değeri.

beta_end (`float`, varsayılan 0.02) : Son `beta` değeri.

beta_schedule (`"linear"`, `"scaled_linear"` veya `"squaredcos_cap_v2"`, varsayılan olarak `"linear"`) : Beta zamanlaması, modelin adım atması için beta aralığını beta dizisine eşleyen bir haritalama.

trained_betas (`np.ndarray`, *isteğe bağlı*) : `beta_start` ve `beta_end` parametrelerini atlamak için beta dizisini doğrudan yapılandırıcıya iletin.

solver_order (`int`, varsayılan 2) : `1` veya `2` veya `3` olabilecek DPMSolver derecesi. Rehberli örneklemeler için `solver_order=2`, koşulsuz örneklemeler için ise `solver_order=3` kullanılması önerilir.

prediction_type (`"epsilon"`, `"sample"`, `"v_prediction"` veya `"flow_prediction"`, varsayılan olarak `"epsilon"`) : Zamanlayıcı işlevinin tahmin türü. `epsilon` difüzyon sürecinin gürültüsünü tahmin eder, `sample` gürültülü örneği doğrudan tahmin eder, `v_prediction` hızı tahmin eder ([Imagen Video](https://huggingface.co/papers/2210.02303) makalesinin 2.4 bölümüne bakın) ve `flow_prediction` akışı tahmin eder.

thresholding (`bool`, varsayılan `False`) : "Dinik eşikleme" yönteminin kullanılıp kullanılmayacağını belirtir. Bu, Stable Diffusion gibi gizli uzay difüzyon modelleri için uygun değildir.

dynamic_thresholding_ratio (`float`, varsayılan 0.995) : Dinamik eşikleme yöntemi için oran. Yalnızca `thresholding=True` olduğunda geçerlidir.

sample_max_value (`float`, varsayılan 1.0) : Dinamik eşikleme için eşik değeri. Yalnızca `thresholding=True` ve `algorithm_type="dpmsolver++"` olduğunda geçerlidir.

algorithm_type (`"dpmsolver"`, `"dpmsolver++"`, `"sde-dpmsolver"` veya `"sde-dpmsolver++"`, varsayılan olarak `"dpmsolver++"`) : Çözücü için algoritma türü. `dpmsolver` türü, [DPMSolver](https://huggingface.co/papers/2206.00927) makalesindeki algoritmaları, `dpmsolver++` türü ise [DPMSolver++](https://huggingface.co/papers/2211.01095) makalesindeki algoritmaları uygular. Stable Diffusion'daki gibi yönlendirilmiş örneklemeler için `dpmsolver++` veya `sde-dpmsolver++`'ın `solver_order=2` ile kullanılması önerilir.

solver_type (`"midpoint"` veya `"heun"`, varsayılan `"midpoint"`) : İkinci mertebe çözücü için çözücü türü. Çözücü türü, özellikle adım sayısı az olduğunda örnek kalitesini hafifçe etkiler. `midpoint` çözücülerinin kullanılması önerilir.

lower_order_final (`bool`, varsayılan `True`) : Son adımlarda düşük dereceli çözücülerin kullanılıp kullanılmayacağı. Yalnızca 15'ten az çıkarım adımı için geçerlidir. Bu, özellikle 10 ve altı adımlar için DPMSolver'ın 15'ten az adımlarda örneklemesini kararlı hale getirebilir.

euler_at_final (`bool`, varsayılan `False`) : Son adımda Euler yönteminin kullanılıp kullanılmayacağı. Sayısal kararlılık ile detay zenginliği arasında bir ödünleşimdir. Bu, DPMSolver'ın SDE varyantının örneklemesini, düşük sayıda çıkarım adımı için kararlı hale getirebilir, ancak bazen bulanıklığa yol açabilir.

use_karras_sigmas (`bool`, *isteğe bağlı*, varsayılan `False`) : Örnekleme sürecinde gürültü zamanlamasındaki adım boyutları için Karras sigmalarının kullanılıp kullanılmayacağını belirtir. `True` ise, sigmalar {σi} gürültü seviyeleri dizisine göre belirlenir.

use_exponential_sigmas (`bool`, *isteğe bağlı*, varsayılan `False`) : Örnekleme sürecinde gürültü zamanlamasındaki adım boyutları için üstel sigmaların kullanılıp kullanılmayacağını belirtir.

use_beta_sigmas (`bool`, *isteğe bağlı*, varsayılan `False`) : Örnekleme sürecinde gürültü zamanlamasında adım boyutları için beta sigmaların kullanılıp kullanılmayacağını belirtir. Daha fazla bilgi için [Beta Sampling is All You Need](https://huggingface.co/papers/2407.12173) makalesine bakın.

use_lu_lambdas (`bool`, *isteğe bağlı*, varsayılan `False`) : Örnekleme sürecindeki gürültü zamanlamasında, Lu'nun DPM-Solver'ı tarafından önerilen adım boyutları için uniform-logSNR kullanılıp kullanılmayacağını belirtir. `True` ise, sigmalar ve zaman adımları `lambda(t)` dizisine göre belirlenir.

use_flow_sigmas (`bool`, *isteğe bağlı*, varsayılan `False`) : Örnekleme sürecinde gürültü zamanlamasında adım boyutları için akış sigmalarının kullanılıp kullanılmayacağı.

flow_shift (`float`, *opsiyonel*, varsayılan 1.0) : Akış eşleştirmesi için zaman adımı zaman çizelgesinin kayma değeri.

final_sigmas_type (`"zero"` veya `"sigma_min"`, *isteğe bağlı*, varsayılan `"zero"`) : Örnekleme süreci sırasında gürültü zamanlaması için son `sigma` değeri. `"sigma_min"` ise, son sigma, eğitim zamanlamasındaki son sigma ile aynıdır. `"zero"` ise, son sigma 0 olarak ayarlanır.

lambda_min_clipped (`float`, varsayılan `-inf`) : Sayısal kararlılık için `lambda(t)`'nin minimum değerine uygulanan kırpma eşiği. Bu, kosinüs (`squaredcos_cap_v2`) gürültü zamanlaması için kritiktir.

variance_type (`"learned"` veya `"learned_range"`, *isteğe bağlı*) : Varyans tahmin eden difüzyon modelleri için `"learned"` veya `"learned_range"` olarak ayarlayın. Ayarlanırsa, modelin çıktısı tahmin edilen Gauss varyansını içerir.

timestep_spacing (`"linspace"`, `"leading"` veya `"trailing"`, varsayılan olarak `"linspace"`) : Zaman adımlarının ölçeklendirilme yöntemi. Daha fazla bilgi için [Common Diffusion Noise Schedules and Sample Steps are Flawed](https://huggingface.co/papers/2305.08891) makalesindeki Tablo 2'ye bakın.

steps_offset (`int`, varsayılan 0) : Bazı model ailelerinin gerektirdiği gibi, çıkarım adımlarına eklenen bir ofset.

rescale_betas_zero_snr (`bool`, varsayılan `False`) : Betaların sıfır terminal SNR'ye sahip olacak şekilde yeniden ölçeklenip ölçeklenmeyeceğini belirtir. Bu, modelin orta parlaklıktaki örneklerle sınırlı kalmak yerine çok parlak ve karanlık örnekler üretmesini sağlar. [`--offset_noise`](https://github.com/huggingface/diffusers/blob/74fd735eb073eb1d774b1ab4154a0876eb82f055/examples/dreambooth/train_dreambooth.py#L506) ile gevşek bir şekilde ilişkilidir.

use_dynamic_shifting (`bool`, varsayılan `False`) : Zaman adımı zaman çizelgesi için dinamik kaydırma kullanılıp kullanılmayacağı.

time_shift_type (`"exponential"`, varsayılan olarak `"exponential"`) : Dinamik kaydırma kullanılırken uygulanacak zaman kaydırma türü.

`DPMSolverMultistepScheduler`, difüzyon ODE'leri için hızlı ve özel yüksek dereceli bir çözücüdür.

Bu model [SchedulerMixin](/docs/diffusers/main/tr/api/schedulers/overview#diffusers.SchedulerMixin) ve [ConfigMixin](/docs/diffusers/main/tr/api/configuration#diffusers.ConfigMixin) sınıflarından devralır. Kütüphanenin tüm zamanlayıcılar için yükleme ve kaydetme gibi genel yöntemleri uyguladığı üst sınıf belgelendirmesini kontrol edin.

#### add_noise[[diffusers.DPMSolverMultistepScheduler.add_noise]]

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

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L1303)

**Parametreler:**

original_samples (`torch.Tensor`) : Gürültüsüz orijinal örnekler.

noise (`torch.Tensor`) : Örneklere eklenecek gürültü.

timesteps (`torch.IntTensor`) : Örneklerin gürültü eklenmesi için kullanılacak zaman adımları.

**Dönüş:** `torch.Tensor`

Gürültülü örnekler.

Belirtilen zaman adımlarındaki gürültü planına göre orijinal örneklerin gürültü ekleyin.

#### convert_model_output[[diffusers.DPMSolverMultistepScheduler.convert_model_output]]

```python
convert_model_output(model_output: Tensor, *args, sample: typing.Optional[torch.Tensor] = None, **kwargs)
```

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L749)

**Parametreler:**

model_output (`torch.Tensor`) : Öğrenen difüzyon modelinden gelen doğrudan çıktı.

sample (`torch.Tensor`, *isteğe bağlı*) : Difüzyon süreci tarafından oluşturulan bir örneğin mevcut bir örneği.

**Dönüş:** `torch.Tensor`

Dönüştürülen model çıktısı.

Model çıktısını, DPMSolver/DPMSolver++ algoritmasının gerektirdiği ilgili tipe dönüştürün. DPM-Solver, gürültü tahmin modelinin bir integralini ayrıklaştırmak için tasarlanmıştır ve DPM-Solver++, veri tahmin modelinin bir integralini ayrıklaştırmak için tasarlanmıştır.

> [!TIP] > Algoritma ve model tipi birbirinden bağımsızdır. Her ikisi için de DPMSolver veya DPMSolver++ kullanabilirsiniz
noise > tahmin ve veri tahmin modelleri.

#### dpm_solver_first_order_update[[diffusers.DPMSolverMultistepScheduler.dpm_solver_first_order_update]]

```python
dpm_solver_first_order_update(model_output: Tensor, *args, sample: typing.Optional[torch.Tensor] = None, noise: typing.Optional[torch.Tensor] = None, **kwargs)
```

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L847)

**Parametreler:**

model_output (`torch.Tensor`) : Öğrenen difüzyon modelinden gelen doğrudan çıktı.

sample (`torch.Tensor`, *isteğe bağlı*) : Difüzyon süreci tarafından oluşturulan bir örneğin mevcut bir örneği.

noise (`torch.Tensor`, *isteğe bağlı*) : Gürültü tensörü.

**Dönüş:** `torch.Tensor`

Önceki zaman adımındaki örnek tensör.

Birinci dereceden DPMSolver için tek adım (DDIM ile eşdeğer).

#### index_for_timestep[[diffusers.DPMSolverMultistepScheduler.index_for_timestep]]

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

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L1144)

**Parametreler:**

timestep (`int` veya `torch.Tensor`) : İndeksini bulmak istediğiniz zaman adımı.

schedule_timesteps (`torch.Tensor`, *isteğe bağlı*) : Aranacak zaman adımı zamanlaması. `None` ise `self.timesteps` kullanılır.

**Dönüş:** `int`

Zaman adımı planındaki zaman adımının indeksi.

Zamanlamadaki (schedule) belirli bir zaman adımının (timestep) indeksini bulun.

#### multistep_dpm_solver_second_order_update[[diffusers.DPMSolverMultistepScheduler.multistep_dpm_solver_second_order_update]]

```python
multistep_dpm_solver_second_order_update(model_output_list: list, *args, sample: typing.Optional[torch.Tensor] = None, noise: typing.Optional[torch.Tensor] = None, **kwargs)
```

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L921)

**Parametreler:**

model_output_list (`list[torch.Tensor]`) : Öğrenen difüzyon modelinin mevcut ve sonraki zaman adımlarındaki doğrudan çıktıları.

sample (`torch.Tensor`, *isteğe bağlı*) : Difüzyon süreci tarafından oluşturulan bir örneğin mevcut bir örneği.

noise (`torch.Tensor`, *isteğe bağlı*) : Stokastik (`sde-*`) çözücü varyantları tarafından kullanılan rastgele gürültü. `algorithm_type` bunlardan birine ayarlandığında zorunludur, aksi takdirde kullanılmaz.

**Dönüş:** `torch.Tensor`

Önceki zaman adımındaki örnek tensör.

İkinci mertebeden çok adımlı DPMSolver için tek adım.

#### multistep_dpm_solver_third_order_update[[diffusers.DPMSolverMultistepScheduler.multistep_dpm_solver_third_order_update]]

```python
multistep_dpm_solver_third_order_update(model_output_list: list, *args, sample: typing.Optional[torch.Tensor] = None, noise: typing.Optional[torch.Tensor] = None, **kwargs)
```

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L1047)

**Parametreler:**

model_output_list (`list[torch.Tensor]`) : Öğrenen difüzyon modelinin mevcut ve sonraki zaman adımlarındaki doğrudan çıktıları.

sample (`torch.Tensor`, *isteğe bağlı*) : Difüzyon süreci tarafından oluşturulan bir örneğin mevcut bir örneği.

noise (`torch.Tensor`, *isteğe bağlı*) : Gürültü tensörü.

**Dönüş:** `torch.Tensor`

Önceki zaman adımındaki örnek tensör.

Üçüncü dereceden çok adımlı DPMSolver için tek adım.

#### scale_model_input[[diffusers.DPMSolverMultistepScheduler.scale_model_input]]

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

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L1288)

**Parametreler:**

sample (`torch.Tensor`) : Girdi örneği.

**Dönüş:** `torch.Tensor`

Ölçeklendirilmiş bir girdi örneği.

Gürültüden arındırma modelinin girdisinin mevcut zaman adımına bağlı olarak ölçeklenmesi gereken zamanlayıcılarla değiştirilebilirliği sağlar.

#### set_begin_index[[diffusers.DPMSolverMultistepScheduler.set_begin_index]]

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

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L357)

**Parametreler:**

begin_index (`int`, varsayılan `0`) : Zamanlayıcının başlangıç indeksi.

Zamanlayıcının başlangıç indeksini ayarlar. Bu işlev, çıkarım (inference) öncesinde pipeline'dan çalıştırılmalıdır.

#### set_timesteps[[diffusers.DPMSolverMultistepScheduler.set_timesteps]]

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

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L367)

**Parametreler:**

num_inference_steps (`int`, *isteğe bağlı*) : Ön eğitilmiş bir modelle örnekler oluşturulurken kullanılan difüzyon adım sayısı.

device (`str` veya `torch.device`, *opsiyonel*) : Timestep'lerin taşınacağı cihaz. `None` ise timestep'ler taşınmaz.

mu (`float`, *isteğe bağlı*) : Dinamik zaman kaydırma için üstel. `use_dynamic_shifting` ve `"exponential"` değerine sahip bir `time_shift_type` gerektirir; iletildiğinde `flow_shift`, `exp(mu)` olarak ayarlanır.

timesteps (`list[int]`, *isteğe bağlı*) : İsteğe bağlı zaman adımları zaman çizelgesini desteklemek için kullanılan özel zaman adımları. `None` ise, zaman adımları `timestep_spacing` özniteliğine dayanılarak oluşturulur. `timesteps` geçirilirse, `num_inference_steps` ve `sigmas` `None` olmalıdır ve `timestep_spacing` özniteliği yok sayılır.

Difüzyon zinciri için kullanılan ayrık zaman adımlarını ayarlar (çalıştırılmadan önce çıkarım yapılmalıdır).

#### adım[[diffusers.DPMSolverMultistepScheduler.step]]

```python
step(model_output: Tensor, timestep: typing.Union[int, torch.Tensor], sample: Tensor, generator: typing.Optional[torch.Generator] = None, variance_noise: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```

[Kaynak](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep.py#L1196)

**Parametreler:**

model_output (`torch.Tensor`) : Öğrenen difüzyon modelinden gelen doğrudan çıktı.

timestep (`int` veya `torch.Tensor`) : Difüzyon zincirindeki mevcut ayrık zaman adımı.

sample (`torch.Tensor`) : Difüzyon süreci tarafından oluşturulan bir örneğin mevcut bir örneği.

generator (`torch.Generator`, *isteğe bağlı*) : Rastgele sayı üreteci.

variance_noise (`torch.Tensor`, *isteğe bağlı*) : `generator` ile gürültü üretmek yerine, varyans için gürültüyü doğrudan sağlayarak alternatif oluşturur. `LEdits++` gibi yöntemler için faydalıdır.

return_dict (`bool`, varsayılan `True`) : [SchedulerOutput](/docs/diffusers/main/tr/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) mu yoksa `tuple` mu döndürüleceğini belirtir.

**Dönüş:** [SchedulerOutput](/docs/diffusers/main/tr/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) veya `tuple`

`return_dict` `True` ise [SchedulerOutput](/docs/diffusers/main/tr/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) döndürülür, aksi takdirde bir tuple döndürülür ve bu tuple'ın ilk öğesi örnek tensörüdür.

Önceki zaman adımından örneklemeyi SDE'yi tersine çevirerek tahmin edin. Bu fonksiyon, örneklemeyi çok adımlı DPMSolver ile ilerletir.

## 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)
```

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

**Parametreler:**

prev_sample (`torch.Tensor`, görüntüler için `(batch_size, num_channels, height, width)` boyutunda) : Önceki zaman adımının hesaplanan `(x_{t-1})` örneği. `prev_sample`, gürültü azaltma döngüsünde bir sonraki model girdisi olarak kullanılmalıdır.

Bir zamanlayıcının `step` işlevinin çıktısı için temel sınıf.

