# DPMSolverMultistepInverse

`DPMSolverMultistepInverse` は、Cheng Lu、Yuhao Zhou、Fan Bao、Jianfei Chen、Chongxuan Li、Jun Zhu による [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) に記載されている、逆方向のスケジューラーです。

実装は、主に[Null-text Inversion for Editing Real Images using Guided Diffusion Models](https://huggingface.co/papers/2211.09794)のDDIMインバージョンの定義と、[Xiang-cd/DiffEdit-stable-diffusion](https://github.com/Xiang-cd/DiffEdit-stable-diffusion/blob/main/diffedit.ipynb)の`DiffEdit`の潜在インバージョンのノートブック実装に基づいています。

## ヒント

[Imagen](https://huggingface.co/papers/2205.11487)からの動的閾値化はサポートされており、ピクセル空間の拡散モデルでは、`algorithm_type="dpmsolver++"`と`thresholding=True`の両方を設定することで、動的閾値化を使用できます。この閾値化手法は、Stable Diffusionなどの潜在空間拡散モデルには適していません。

## DPMSolverMultistepInverseScheduler[[diffusers.DPMSolverMultistepInverseScheduler]]

#### diffusers.DPMSolverMultistepInverseScheduler[[diffusers.DPMSolverMultistepInverseScheduler]]

```python
diffusers.DPMSolverMultistepInverseScheduler(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, 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_flow_sigmas: bool = False, flow_shift: float = 1.0, 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)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L86)

**パラメータ:**

num_train_timesteps (`int`、デフォルトは 1000) : モデルを学習するための拡散ステップ数。

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` をバイパスして、ベータの配列を直接コンストラクタに渡す。

solver_order (`int`、デフォルトは 2) : `1`、`2`、または `3` を指定できる DPMSolver の order です。ガイド付きサンプリングには `solver_order=2`、無条件サンプリングには `solver_order=3` の使用を推奨します。

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

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`、`dpmsolver++`、`sde-dpmsolver`、または`sde-dpmsolver++`を指定できます。`dpmsolver`タイプは[DPMSolver](https://huggingface.co/papers/2206.00927)論文のアルゴリズムを実装し、`dpmsolver++`タイプは[DPMSolver++](https://huggingface.co/papers/2211.01095)論文のアルゴリズムを実装します。Stable Diffusionのようなガイド付きサンプリングでは、`dpmsolver++`または`sde-dpmsolver++`を`solver_order=2`と組み合わせて使用することを推奨します。

solver_type (`str`、デフォルトは `midpoint`) : 2 階のソルバーのソルバータイプ。`midpoint` または `heun` を指定できます。ソルバータイプはサンプルの品質にわずかな影響を与えますが、ステップ数が少ない場合に特に顕著です。`midpoint` ソルバーの使用を推奨します。

lower_order_final (`bool`、デフォルトは`True`) : 最終ステップで低次のソルバーを使用するかどうか。15ステップ未満の推論ステップでのみ有効です。ステップ数が15未満、特に10以下の場合、DPMSolverのサンプリングを安定化させることができます。

euler_at_final (`bool`、デフォルトは`False`) : 最終ステップでEuler法を使用するかどうか。数値安定性とディテールの豊かさのトレードオフです。推論ステップ数が少ない場合、DPMSolverのSDEバリアントのサンプリングを安定させることができますが、場合によってはぼやけの原因になります。

use_karras_sigmas (`bool`, *任意*, デフォルトは `False`) : サンプリングプロセス中のノイズスケジュールにおけるステップサイズに Karras シグマを使用するかどうか。`True` の場合、シグマはノイズレベルの列 {σi} に基づいて決定されます。

use_exponential_sigmas (`bool`、*任意*、デフォルトは`False`) : サンプリングプロセス中のノイズスケジュールにおいて、ステップサイズに指数シグマを使用するかどうか。

use_beta_sigmas (`bool`, *optional*, defaults to `False`) : Whether to use beta sigmas for step sizes in the noise schedule during the sampling process. Refer to [Beta Sampling is All You Need](https://huggingface.co/papers/2407.12173) for more information.

use_flow_sigmas (`bool`、*任意*、デフォルトは`False`) : サンプリングプロセス中のノイズスケジュールにおいて、ステップサイズにフローシグマを使用するかどうか。

flow_shift (`float`、*任意*、デフォルト値は 1.0) : フローシフト係数です。`use_flow_sigmas=True` の場合のみ有効です。

lambda_min_clipped (`float`、デフォルトは`-inf`) : 数値の安定性を確保するために`lambda(t)`の最小値に適用するクリッピングの閾値です。これはコサイン（`squaredcos_cap_v2`）ノイズスケジュールにおいて重要になります。

variance_type (`str`, *任意*) : 分散を予測する拡散モデルの場合、"learned" または "learned_range" に設定します。設定した場合、モデルの出力には予測されたガウス分散が含まれます。

timestep_spacing (`str`, defaults to `"linspace"`) : The way the timesteps should be scaled. Refer to Table 2 of the [Common Diffusion Noise Schedules and Sample Steps are Flawed](https://huggingface.co/papers/2305.08891) for more information.

steps_offset (`int`、デフォルトは 0) : 一部のモデルファミリーで必要とされる、推論ステップに追加されるオフセットです。

`DPMSolverMultistepInverseScheduler` は [DPMSolverMultistepScheduler](/docs/diffusers/main/ja/api/schedulers/multistep_dpm_solver#diffusers.DPMSolverMultistepScheduler) の逆スケジューラーです。

このモデルは [SchedulerMixin](/docs/diffusers/main/ja/api/schedulers/overview#diffusers.SchedulerMixin) と [ConfigMixin](/docs/diffusers/main/ja/api/configuration#diffusers.ConfigMixin) を継承しています。読み込みや保存など、ライブラリがすべてのスケジューラに対して実装している汎用的なメソッドについては、スーパークラスのドキュメントを参照してください。

#### add_noise[[diffusers.DPMSolverMultistepInverseScheduler.add_noise]]

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

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L1118)

**パラメータ:**

original_samples (`torch.Tensor`) : ノイズを追加する元のサンプル。

noise (`torch.Tensor`) : ノイズのテンソル。

timesteps (`torch.IntTensor`) : ノイズを追加するタイムステップ。

**戻り値:** `torch.Tensor`

ノイズ付きサンプル。

スケジューラの対応する関数を使用して、クリーンな`original_samples`にノイズを追加します。

#### convert_model_output[[diffusers.DPMSolverMultistepInverseScheduler.convert_model_output]]

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

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L600)

**パラメータ:**

model_output (`torch.Tensor`) : 学習済み拡散モデルからの直接の出力です。

sample (`torch.Tensor`, *任意*) : 拡散プロセスによって生成されたサンプルの現在のインスタンス。

**戻り値:** `torch.Tensor`

変換後のモデルの出力。

モデルの出力を、DPMSolver/DPMSolver++ アルゴリズムが要求する対応する型に変換します。DPM-Solver はノイズ予測モデルの積分を離散化するように設計されており、DPM-Solver++ はデータ予測モデルの積分を離散化するように設計されています。

> [!TIP] > アルゴリズムとモデルタイプは分離されています。DPMSolverとDPMSolver++のいずれかを、両方の
noise > prediction および data prediction models。

#### dpm_solver_first_order_update[[diffusers.DPMSolverMultistepInverseScheduler.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)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L699)

**パラメータ:**

model_output (`torch.Tensor`) : 学習済み拡散モデルからの直接の出力です。

sample (`torch.Tensor`, *任意*) : 拡散プロセスによって生成されたサンプルの現在のインスタンス。

noise (`torch.Tensor`, *任意*) : ノイズテンソル。

**戻り値:** `torch.Tensor`

前のタイムステップのサンプルテンソル。

1次DPMSolverの1ステップ（DDIMと同等）。

#### multistep_dpm_solver_second_order_update[[diffusers.DPMSolverMultistepInverseScheduler.multistep_dpm_solver_second_order_update]]

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

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L774)

**パラメータ:**

model_output_list (`list[torch.Tensor]`) : 学習済み拡散モデルが現在のタイムステップおよびその後のタイムステップで直接出力する値。

sample (`torch.Tensor`, *任意*) : 拡散プロセスによって生成されたサンプルの現在のインスタンス。

noise (`torch.Tensor`, *任意*) : 確率的(`sde-*`)ソルババリアントで使用されるランダムノイズ。`algorithm_type`がそれらのいずれかに設定されている場合に必要であり、それ以外の場合は使用されません。

**戻り値:** `torch.Tensor`

前のタイムステップのサンプルテンソル。

2次多ステップDPMSolverの1ステップ。

#### multistep_dpm_solver_third_order_update[[diffusers.DPMSolverMultistepInverseScheduler.multistep_dpm_solver_third_order_update]]

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

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L901)

**パラメータ:**

model_output_list (`list[torch.Tensor]`) : 学習済み拡散モデルが現在のタイムステップおよびその後のタイムステップで直接出力する値。

sample (`torch.Tensor`, *任意*) : 拡散プロセスによって生成されたサンプルの現在のインスタンス。

noise (`torch.Tensor`, *任意*) : ノイズテンソル。

**戻り値:** `torch.Tensor`

前のタイムステップのサンプルテンソル。

3階の多段DPMSolverの1ステップ。

#### scale_model_input[[diffusers.DPMSolverMultistepInverseScheduler.scale_model_input]]

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

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L1103)

**パラメータ:**

sample (`torch.Tensor`) : 入力サンプル。

**戻り値:** `torch.Tensor`

スケーリングされた入力サンプル。

現在のタイムステップに応じて、デノイジングモデルの入力をスケーリングする必要があるスケジューラとの相互運用性を保証します。

#### set_timesteps[[diffusers.DPMSolverMultistepInverseScheduler.set_timesteps]]

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

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L283)

**パラメータ:**

num_inference_steps (`int`) : 事前学習済みモデルでサンプルを生成する際に使用される拡散ステップの数。

device (`str` または `torch.device`、*任意*) : timesteps を移動先とするデバイスです。`None` の場合、timesteps は移動されません。

拡散チェーンで使用される離散タイムステップを設定します（推論の実行前に実行する必要があります）。

#### ステップ[[diffusers.DPMSolverMultistepInverseScheduler.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)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpmsolver_multistep_inverse.py#L1017)

**パラメータ:**

model_output (`torch.Tensor`) : 学習済み拡散モデルからの直接の出力です。

timestep (`int`) : 拡散チェーンにおける現在の離散タイムステップ。

sample (`torch.Tensor`) : 拡散プロセスによって生成されたサンプルの現在のインスタンス。

generator (`torch.Generator`, *任意*) : 乱数生成器。

variance_noise (`torch.Tensor`) : `generator` を使用してノイズを生成する代わりに、分散自体のノイズを直接指定するための代替手段です。`CycleDiffusion` のような手法に有用です。

return_dict (`bool`) : [SchedulerOutput](/docs/diffusers/main/ja/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput)を返すか、`tuple`を返すかを指定します。

**戻り値:** [SchedulerOutput](/docs/diffusers/main/ja/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) または `tuple`

`True` の場合、[SchedulerOutput](/docs/diffusers/main/ja/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) が返され、それ以外の場合は、最初の要素がサンプルテンソルであるタプルが返されます。

前のタイムステップのサンプルを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/main/src/diffusers/schedulers/scheduling_utils.py#L66)

**パラメータ:**

prev_sample (`torch.Tensor`、画像の場合は `(batch_size, num_channels, height, width)` の形状) : 前のタイムステップの計算済みサンプル `(x_{t-1})`。`prev_sample` は、デノイジングループの次のモデル入力として使用する必要があります。

スケジューラーの`step`関数の出力の基底クラス。