# EDMDPMSolverMultistepScheduler

`EDMDPMSolverMultistepScheduler` — это [формулировка Карраса](https://huggingface.co/papers/2206.00364) для `DPMSolverMultistepScheduler`, многошагового планировщика из статей [DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps](https://huggingface.co/papers/2206.00927) и [DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models](https://huggingface.co/papers/2211.01095) авторов Cheng Lu, Yuhao Zhou, Fan Bao, Jianfei Chen, Chongxuan Li и Jun Zhu.

DPMSolver (а также улучшенная версия DPMSolver++) — это быстрый специализированный решатель высокого порядка для диффузионных ОДУ с гарантией порядка сходимости. На практике сэмплирование DPMSolver всего за 20 шагов позволяет получать образцы высокого качества, а при 10 шагах результат всё ещё остаётся достаточно хорошим.

## EDMDPMSolverMultistepScheduler[[diffusers.EDMDPMSolverMultistepScheduler]]

#### diffusers.EDMDPMSolverMultistepScheduler[[diffusers.EDMDPMSolverMultistepScheduler]]

```python
diffusers.EDMDPMSolverMultistepScheduler(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', 'sample', 'v_prediction'] = 'epsilon', rho: float = 7.0, solver_order: int = 2, thresholding: bool = False, dynamic_thresholding_ratio: float = 0.995, sample_max_value: float = 1.0, algorithm_type: typing.Literal['dpmsolver++', 'sde-dpmsolver++'] = 'dpmsolver++', solver_type: typing.Literal['midpoint', 'heun'] = 'midpoint', lower_order_final: bool = True, euler_at_final: bool = False, final_sigmas_type: typing.Literal['zero', 'sigma_min'] = 'zero')
```

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L28)

**Параметры:**

sigma_min (`float`, *optional*, по умолчанию 0.002) : Минимальная величина шума в расписании сигм. В статье EDM [1] это значение было установлено в 0.002; разумный диапазон — [0, 10].

sigma_max (`float`, *optional*, по умолчанию 80.0) : Максимальная величина шума в расписании сигм. В статье EDM [1] это значение установлено в 80.0; разумный диапазон — [0.2, 80.0].

sigma_data (`float`, *optional*, по умолчанию 0.5) : Стандартное отклонение распределения данных. В статье EDM [1] это значение установлено в 0.5.

sigma_schedule (`str`, *optional*, по умолчанию `karras`) : Расписание сигм для вычисления `sigmas`. По умолчанию используется расписание, предложенное в статье EDM (https://huggingface.co/papers/2206.00364). Другое допустимое значение — "exponential". Экспоненциальное расписание было включено в эту модель: https://huggingface.co/stabilityai/cosxl.

num_train_timesteps (`int`, по умолчанию 1000) : Количество шагов диффузии для обучения модели.

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).

rho (`float`, *optional*, по умолчанию 7.0) : Параметр rho в расписании сигм Karras. В статье EDM [1] он был установлен в 7.0.

solver_order (`int`, по умолчанию 2) : Порядок DPMSolver, который может быть `1` или `2` или `3`. Рекомендуется использовать `solver_order=2` для управляемого сэмплирования и `solver_order=3` для безусловного сэмплирования.

thresholding (`bool`, по умолчанию `False`) : Использовать ли метод «динамического порога». Этот метод не подходит для моделей диффузии в латентном пространстве, таких как Stable Diffusion.

dynamic_thresholding_ratio (`float`, по умолчанию 0.995) : Коэффициент для метода динамического порогового значения. Действительно только при `thresholding=True`.

sample_max_value (`float`, по умолчанию 1.0) : Пороговое значение для динамического порогового срабатывания. Действительно только при `thresholding=True` и `algorithm_type="dpmsolver++"`.

algorithm_type (`str`, по умолчанию `dpmsolver++`) : Тип алгоритма для решателя; может быть `dpmsolver++` или `sde-dpmsolver++`. Тип `dpmsolver++` реализует алгоритмы из статьи [DPMSolver++](https://huggingface.co/papers/2211.01095). Рекомендуется использовать `dpmsolver++` или `sde-dpmsolver++` с `solver_order=2` для направленного сэмплирования, как в Stable Diffusion.

solver_type (`str`, по умолчанию `midpoint`) : Тип решателя для решателя второго порядка; может быть `midpoint` или `heun`. Тип решателя незначительно влияет на качество выборки, особенно при малом числе шагов. Рекомендуется использовать решатели `midpoint`.

lower_order_final (`bool`, по умолчанию `True`) : Использовать ли решатели низшего порядка на последних шагах. Действительно только для < 15 шагов инференса. Это может стабилизировать сэмплирование DPMSolver для шагов < 15, особенно для шагов <= 10.

euler_at_final (`bool`, по умолчанию `False`) : Использовать ли метод Эйлера на последнем шаге. Это компромисс между численной стабильностью и детализацией. Это может стабилизировать сэмплинг SDE-варианта DPMSolver при малом количестве шагов инференса, но иногда приводит к размыванию.

final_sigmas_type (`str`, по умолчанию `"zero"`) : Значение `sigma` в конце расписания шума в процессе выборки. Если указано `"sigma_min"`, конечное значение sigma совпадает с последним значением sigma в расписании обучения. Если указано `zero`, конечное значение sigma устанавливается в 0.

Реализует DPMSolverMultistepScheduler в формулировке EDM, представленной в работе Karras et al. 2022 [1]. `EDMDPMSolverMultistepScheduler` — это быстрый специализированный решатель высокого порядка для диффузионных ОДУ.

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

Эта модель наследуется от [SchedulerMixin](/docs/diffusers/v0.43.0/ru/api/schedulers/overview#diffusers.SchedulerMixin) и [ConfigMixin](/docs/diffusers/v0.43.0/ru/api/configuration#diffusers.ConfigMixin). Общие методы, которые библиотека реализует для всех планировщиков, такие как загрузка и сохранение, описаны в документации суперкласса.

#### add_noise[[diffusers.EDMDPMSolverMultistepScheduler.add_noise]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L808)

**Параметры:**

original_samples (`torch.Tensor`) : исходные образцы, к которым будет добавлен шум.

noise (`torch.Tensor`) : тензор шума, который нужно добавить к исходным образцам.

timesteps (`torch.Tensor`) : Шаги, на которых добавляется шум, определяющие уровень шума по расписанию.

**Возвращает:** `torch.Tensor`

Шумовые образцы с добавленным шумом, масштабированным в соответствии с расписанием шагов времени.

Добавьте шум к исходным образцам в соответствии с расписанием шума на указанных временных шагах.

#### convert_model_output[[diffusers.EDMDPMSolverMultistepScheduler.convert_model_output]]

```python
convert_model_output(model_output: Tensor, sample: Tensor)
```

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L471)

**Параметры:**

model_output (`torch.Tensor`) : Прямой вывод из обученной диффузионной модели.

sample (`torch.Tensor`) : Текущая инстанция сэмпла, созданная процессом диффузии.

**Возвращает:** `torch.Tensor`

Вывод сконвертированной модели.

Преобразуйте выход модели в соответствующий тип, необходимый для алгоритма DPMSolver/DPMSolver++. DPM-Solver предназначен для дискретизации интеграла модели предсказания шума, а DPM-Solver++ — для дискретизации интеграла модели предсказания данных.

> [!TIP] > Алгоритм и тип модели разделены. Вы можете использовать как DPMSolver, так и DPMSolver++ для обоих
noise > prediction и модели предсказания данных.

#### dpm_solver_first_order_update[[diffusers.EDMDPMSolverMultistepScheduler.dpm_solver_first_order_update]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L502)

**Параметры:**

model_output (`torch.Tensor`) : Прямой вывод из обученной диффузионной модели.

sample (`torch.Tensor`) : Текущая инстанция сэмпла, созданная процессом диффузии.

noise (`torch.Tensor`, *необязательный*) : Тензор шума, который нужно добавить к исходным образцам.

**Возвращает:** `torch.Tensor`

Тензор выборки на предыдущем шаге.

Один шаг для DPMSolver первого порядка (эквивалентен DDIM).

#### index_for_timestep[[diffusers.EDMDPMSolverMultistepScheduler.index_for_timestep]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L673)

**Параметры:**

timestep (`int` или `torch.Tensor`) : Шаг времени, для которого нужно найти индекс.

schedule_timesteps (`torch.Tensor`, *необязательный*) : Расписание временных шагов, в котором выполняется поиск. Если `None`, используется `self.timesteps`.

**Возвращает:** `int`

Индекс шага времени в расписании.

Найдите индекс для заданного шага в расписании.

#### multistep_dpm_solver_second_order_update[[diffusers.EDMDPMSolverMultistepScheduler.multistep_dpm_solver_second_order_update]]

```python
multistep_dpm_solver_second_order_update(model_output_list: typing.List[torch.Tensor], sample: Tensor, noise: typing.Optional[torch.Tensor] = None)
```

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L545)

**Параметры:**

model_output_list (`list[torch.Tensor]`) : Прямые выходы обученной диффузионной модели на текущих и последующих временных шагах.

sample (`torch.Tensor`) : Текущая инстанция сэмпла, созданная процессом диффузии.

noise (`torch.Tensor`, *необязательный*) : Тензор шума, который нужно добавить к исходным образцам.

**Возвращает:** `torch.Tensor`

Тензор выборки на предыдущем шаге.

Один шаг для двухшагового метода DPMSolver второго порядка.

#### multistep_dpm_solver_third_order_update[[diffusers.EDMDPMSolverMultistepScheduler.multistep_dpm_solver_third_order_update]]

```python
multistep_dpm_solver_third_order_update(model_output_list: list[torch.Tensor], sample: Tensor)
```

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L618)

**Параметры:**

model_output_list (`list[torch.Tensor]`) : Прямые выходы обученной диффузионной модели на текущих и последующих временных шагах.

sample (`torch.Tensor`) : Текущая инстанция сэмпла, созданная процессом диффузии.

**Возвращает:** `torch.Tensor`

Тензор выборки на предыдущем шаге.

Один шаг для многошагового DPMSolver третьего порядка.

#### precondition_inputs[[diffusers.EDMDPMSolverMultistepScheduler.precondition_inputs]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L180)

**Параметры:**

sample (`torch.Tensor`) : входной тензор образца для предварительной обработки.

sigma (`float` или `torch.Tensor`) : текущее значение сигмы (уровня шума).

**Возвращает:** `torch.Tensor`

Масштабированный входной образец.

Предварительно обработайте входной образец, масштабируя его в соответствии с формулировкой EDM.

#### precondition_noise[[diffusers.EDMDPMSolverMultistepScheduler.precondition_noise]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L199)

**Параметры:**

sigma (`float` или `torch.Tensor`) : значение сигмы (уровня шума) для предварительной обработки.

**Возвращает:** `torch.Tensor`

Значение предобусловленного шума, вычисленное как `0.25 * log(sigma)`.

Предварительно обработайте уровень шума, применив логарифмическое преобразование.

#### precondition_outputs[[diffusers.EDMDPMSolverMultistepScheduler.precondition_outputs]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L219)

**Параметры:**

sample (`torch.Tensor`) : Тензор входной выборки.

model_output (`torch.Tensor`) : Прямой вывод из обученной диффузионной модели.

sigma (`float` или `torch.Tensor`) : текущее значение сигмы (уровня шума).

**Возвращает:** `torch.Tensor`

Образец после шумоподавления, вычисленный путём объединения skip-соединения и масштабирования вывода.

Предварительно обрабатывайте выходные модели в соответствии с формулировкой EDM.

#### scale_model_input[[diffusers.EDMDPMSolverMultistepScheduler.scale_model_input]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L255)

**Параметры:**

sample (`torch.Tensor`) : Тензор входной выборки.

timestep (`float` или `torch.Tensor`) : Текущий шаг (timestep) в цепочке диффузии.

**Возвращает:** `torch.Tensor`

Масштабированный входной образец.

Масштабирует входную величину модели денойзинга для соответствия алгоритму Эйлера. Обеспечивает совместимость с планировщиками, которым необходимо масштабировать входную величину модели денойзинга в зависимости от текущего шага.

#### set_begin_index[[diffusers.EDMDPMSolverMultistepScheduler.set_begin_index]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L169)

**Параметры:**

begin_index (`int`, по умолчанию `0`) : Начальный индекс для планировщика.

Устанавливает начальный индекс для планировщика. Эта функция должна выполняться из конвейера перед инференсом.

#### set_timesteps[[diffusers.EDMDPMSolverMultistepScheduler.set_timesteps]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L279)

**Параметры:**

num_inference_steps (`int`) : Количество шагов диффузии, используемое при генерации образцов с помощью предобученной модели.

device (`str` или `torch.device`, *необязательный*) : Устройство, на которое следует переместить шаги. Если `None`, шаги не перемещаются.

Устанавливает дискретные временные шаги, используемые для цепочки диффузии (выполняется перед инференсом).

#### шаг[[diffusers.EDMDPMSolverMultistepScheduler.step]]

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

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L726)

**Параметры:**

model_output (`torch.Tensor`) : Прямой вывод из обученной диффузионной модели.

timestep (`int`) : Текущий дискретный шаг времени в цепочке диффузии.

sample (`torch.Tensor`) : Текущая инстанция сэмпла, созданная процессом диффузии.

generator (`torch.Generator`, *необязательный*) : генератор случайных чисел.

return_dict (`bool`) : Возвращать ли [SchedulerOutput](/docs/diffusers/v0.43.0/ru/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) или `tuple`.

**Возвращает:** [SchedulerOutput](/docs/diffusers/v0.43.0/ru/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) или `tuple`

If return_dict is `True`, [SchedulerOutput](/docs/diffusers/v0.43.0/ru/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) is returned, otherwise a tuple is returned where the first element is the sample tensor.

Предскажите образец из предыдущего шага времени, инвертируя SDE. Эта функция распространяет образец с помощью многошагового DPMSolver.

## 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/v0.43.0/src/diffusers/schedulers/scheduling_utils.py#L66)

**Параметры:**

prev_sample (`torch.Tensor` формы `(batch_size, num_channels, height, width)` для изображений) : Вычисленная выборка `(x_{t-1})` для предыдущего шага. `prev_sample` следует использовать как следующий вход модели в цикле шумоподавления.

Базовый класс для результата функции `step` планировщика.