# EDMDPMSolverMultistepScheduler

`EDMDPMSolverMultistepScheduler` é uma [formulação de Karras](https://huggingface.co/papers/2206.00364) de `DPMSolverMultistepScheduler`, um agendador multietapa de [DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps](https://huggingface.co/papers/2206.00927) e [DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models](https://huggingface.co/papers/2211.01095), de Cheng Lu, Yuhao Zhou, Fan Bao, Jianfei Chen, Chongxuan Li e Jun Zhu.

DPMSolver (e a versão aprimorada DPMSolver++) é um solver de alta ordem dedicado e rápido para equações diferenciais ordinárias de difusão, com garantia de ordem de convergência. Empiricamente, a amostragem com DPMSolver usando apenas 20 passos pode gerar amostras de alta qualidade, e é capaz de gerar amostras bastante boas mesmo em 10 passos.

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L28)

**Parâmetros:**

sigma_min (`float`, *opcional*, padrão 0.002) : Magnitude mínima de ruído no agendamento de sigma. Isso foi definido como 0.002 no paper EDM [1]; um intervalo razoável é [0, 10].

sigma_max (`float`, *opcional*, padrão 80.0) : Magnitude máxima de ruído no agendamento de sigma. Isso foi definido como 80.0 no paper EDM [1]; um intervalo razoável é [0.2, 80.0].

sigma_data (`float`, *opcional*, padrão 0.5) : O desvio padrão da distribuição dos dados. Isso é definido como 0,5 no artigo EDM [1].

sigma_schedule (`str`, *opcional*, padrão `karras`) : Agendamento para calcular os `sigmas`. Por padrão, usamos o agendamento introduzido no paper EDM (https://huggingface.co/papers/2206.00364). Outro valor aceitável é "exponential". O agendamento exponencial foi incorporado neste modelo: https://huggingface.co/stabilityai/cosxl.

num_train_timesteps (`int`, padrão 1000) : O número de etapas de difusão para treinar o modelo.

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`, *opcional*, padrão 7.0) : O parâmetro rho no agendamento de sigma de Karras. Este foi definido como 7.0 no paper EDM [1].

solver_order (`int`, padrão 2) : A ordem do DPMSolver, que pode ser `1` ou `2` ou `3`. Recomenda-se usar `solver_order=2` para amostragem guiada e `solver_order=3` para amostragem incondicional.

thresholding (`bool`, padrão `False`) : Se deve usar o método de "limiar dinâmico". Isso não é adequado para modelos de difusão em espaço latente, como o Stable Diffusion.

dynamic_thresholding_ratio (`float`, padrão 0.995) : A proporção para o método de limiar dinâmico. Válido apenas quando `thresholding=True`.

sample_max_value (`float`, padrão 1.0) : O valor de limiar para o limiar dinâmico. Válido apenas quando `thresholding=True` e `algorithm_type="dpmsolver++"`.

algorithm_type (`str`, padrão `dpmsolver++`) : Tipo de algoritmo para o solver; pode ser `dpmsolver++` ou `sde-dpmsolver++`. O tipo `dpmsolver++` implementa os algoritmos do paper [DPMSolver++](https://huggingface.co/papers/2211.01095). Recomenda-se usar `dpmsolver++` ou `sde-dpmsolver++` com `solver_order=2` para amostragem guiada, como no Stable Diffusion.

solver_type (`str`, padrão `midpoint`) : Tipo de solver para o solver de segunda ordem; pode ser `midpoint` ou `heun`. O tipo de solver afeta levemente a qualidade da amostra, especialmente para um pequeno número de etapas. Recomenda-se o uso de solvers `midpoint`.

lower_order_final (`bool`, padrão `True`) : Se deve usar solucionadores de ordem inferior nas etapas finais. Válido apenas para < 15 etapas de inferência. Isso pode estabilizar a amostragem do DPMSolver para etapas < 15, especialmente para etapas <= 10.

euler_at_final (`bool`, padrão `False`) : Se deve usar o método de Euler na etapa final. Trata-se de um compromisso entre estabilidade numérica e riqueza de detalhes. Isso pode estabilizar a amostragem da variante SDE do DPMSolver para um pequeno número de etapas de inferência, mas às vezes pode resultar em embaçamento.

final_sigmas_type (`str`, padrão `"zero"`) : O valor final de `sigma` para o agendamento de ruído durante o processo de amostragem. Se `"sigma_min"`, o sigma final é o mesmo que o último sigma no agendamento de treinamento. Se `zero`, o sigma final é definido como 0.

Implementa o DPMSolverMultistepScheduler na formulação EDM apresentada em Karras et al. 2022 [1]. `EDMDPMSolverMultistepScheduler` é um solver de alta ordem dedicado e rápido para EDOs de difusão.

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

Este modelo herda de [SchedulerMixin](/docs/diffusers/v0.43.0/pt/api/schedulers/overview#diffusers.SchedulerMixin) e [ConfigMixin](/docs/diffusers/v0.43.0/pt/api/configuration#diffusers.ConfigMixin). Consulte a documentação da superclasse para os métodos genéricos que a biblioteca implementa para todos os agendadores, como carregamento e salvamento.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L808)

**Parâmetros:**

original_samples (`torch.Tensor`) : As amostras originais às quais o ruído será adicionado.

noise (`torch.Tensor`) : O tensor de ruído a ser adicionado às amostras originais.

timesteps (`torch.Tensor`) : Os passos de tempo nos quais adicionar ruído, determinando o nível de ruído a partir da agenda.

**Retorna:** `torch.Tensor`

As amostras ruidosas com ruído adicionado, escalado de acordo com a agenda de passos temporais.

Adicione ruído às amostras originais de acordo com o agendamento de ruído nos timesteps especificados.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L471)

**Parâmetros:**

model_output (`torch.Tensor`) : A saída direta do modelo de difusão aprendido.

sample (`torch.Tensor`) : Uma instância atual de uma amostra criada pelo processo de difusão.

**Retorna:** `torch.Tensor`

A saída do modelo convertido.

Converte a saída do modelo para o tipo correspondente que o algoritmo DPMSolver/DPMSolver++ precisa. O DPM-Solver foi projetado para discretizar uma integral do modelo de previsão de ruído, e o DPM-Solver++ foi projetado para discretizar uma integral do modelo de previsão de dados.

> [!TIP] > O algoritmo e o tipo de modelo são desacoplados. Você pode usar DPMSolver ou DPMSolver++ para ambos
ruído > previsão e modelos de previsão de dados.

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L502)

**Parâmetros:**

model_output (`torch.Tensor`) : A saída direta do modelo de difusão aprendido.

sample (`torch.Tensor`) : Uma instância atual de uma amostra criada pelo processo de difusão.

noise (`torch.Tensor`, *opcional*) : O tensor de ruído a ser adicionado às amostras originais.

**Retorna:** `torch.Tensor`

O tensor de amostra no passo de tempo anterior.

Um passo para o DPMSolver de primeira ordem (equivalente ao 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)
```

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L673)

**Parâmetros:**

timestep (`int` ou `torch.Tensor`) : O timestep para o qual encontrar o índice.

schedule_timesteps (`torch.Tensor`, *opcional*) : O cronograma de passos de tempo a ser pesquisado. Se `None`, usa `self.timesteps`.

**Retorna:** `int`

O índice do timestep no agendamento.

Encontre o índice para um passo de tempo (timestep) específico no agendamento.

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L545)

**Parâmetros:**

model_output_list (`list[torch.Tensor]`) : As saídas diretas do modelo de difusão aprendido nos timesteps atuais e posteriores.

sample (`torch.Tensor`) : Uma instância atual de uma amostra criada pelo processo de difusão.

noise (`torch.Tensor`, *opcional*) : O tensor de ruído a ser adicionado às amostras originais.

**Retorna:** `torch.Tensor`

O tensor de amostra no passo de tempo anterior.

Um passo para o DPMSolver multietapa de segunda ordem.

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L618)

**Parâmetros:**

model_output_list (`list[torch.Tensor]`) : As saídas diretas do modelo de difusão aprendido nos timesteps atuais e posteriores.

sample (`torch.Tensor`) : Uma instância atual de uma amostra criada pelo processo de difusão.

**Retorna:** `torch.Tensor`

O tensor de amostra no passo de tempo anterior.

Um passo do DPMSolver multietapa de terceira ordem.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L180)

**Parâmetros:**

sample (`torch.Tensor`) : O tensor de amostra de entrada para pré-condicionamento.

sigma (`float` ou `torch.Tensor`) : O valor atual de sigma (nível de ruído).

**Retorna:** `torch.Tensor`

A amostra de entrada escalada.

Pré-condicione a amostra de entrada escalando-a de acordo com a formulação EDM.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L199)

**Parâmetros:**

sigma (`float` ou `torch.Tensor`) : O valor de sigma (nível de ruído) a ser pré-condicionado.

**Retorna:** `torch.Tensor`

O valor de ruído pré-condicionado calculado como `0.25 * log(sigma)`.

Pré-condicione o nível de ruído aplicando uma transformação logarítmica.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L219)

**Parâmetros:**

sample (`torch.Tensor`) : O tensor da amostra de entrada.

model_output (`torch.Tensor`) : A saída direta do modelo de difusão aprendido.

sigma (`float` ou `torch.Tensor`) : O valor atual de sigma (nível de ruído).

**Retorna:** `torch.Tensor`

A amostra desruída calculada combinando a conexão de atalho e a escala de saída.

Pré-condicione as saídas do modelo de acordo com a formulação do EDM.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L255)

**Parâmetros:**

sample (`torch.Tensor`) : O tensor da amostra de entrada.

timestep (`float` ou `torch.Tensor`) : O timestep atual na cadeia de difusão.

**Retorna:** `torch.Tensor`

Uma amostra de entrada escalada.

Escala a entrada do modelo de desruidamento para corresponder ao algoritmo Euler. Garante a intercambiabilidade com agendadores que precisam escalar a entrada do modelo de desruidamento dependendo do passo de tempo atual.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L169)

**Parâmetros:**

begin_index (`int`, padrão `0`) : O índice inicial para o agendador.

Define o índice inicial para o agendador. Esta função deve ser executada a partir do pipeline antes da inferência.

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

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L279)

**Parâmetros:**

num_inference_steps (`int`) : O número de etapas de difusão usadas ao gerar amostras com um modelo pré-treinado.

device (`str` ou `torch.device`, *opcional*) : O dispositivo para o qual os timesteps devem ser movidos. Se `None`, os timesteps não são movidos.

Define os passos discretos usados para a cadeia de difusão (a ser executado antes da inferência).

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_edm_dpmsolver_multistep.py#L726)

**Parâmetros:**

model_output (`torch.Tensor`) : A saída direta do modelo de difusão aprendido.

timestep (`int`) : O passo de tempo discreto atual na cadeia de difusão.

sample (`torch.Tensor`) : Uma instância atual de uma amostra criada pelo processo de difusão.

generator (`torch.Generator`, *opcional*) : Um gerador de números aleatórios.

return_dict (`bool`) : Se deve ou não retornar um [SchedulerOutput](/docs/diffusers/v0.43.0/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) ou `tuple`.

**Retorna:** [SchedulerOutput](/docs/diffusers/v0.43.0/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) ou `tuple`

Se return_dict for `True`, [SchedulerOutput](/docs/diffusers/v0.43.0/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) é retornado; caso contrário, uma tupla é retornada, em que o primeiro elemento é o tensor de amostras.

Preveja a amostra do passo de tempo anterior revertendo o SDE. Esta função propaga a amostra com o DPMSolver multistep.

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

[Fonte](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/schedulers/scheduling_utils.py#L66)

**Parâmetros:**

prev_sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)` para imagens) : Amostra calculada `(x_{t-1})` do passo anterior. `prev_sample` deve ser usado como entrada do próximo modelo no loop de remoção de ruído.

Classe base para a saída da função `step` de um agendador.