# DPMSolverSinglestepScheduler

`DPMSolverSinglestepScheduler` は、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) に由来する、1ステップのスケジューラーです。

DPMSolver （改善版のDPMSolver++）は、収束次数を保証する拡散ODE用の高速な専用高次数ソルバーです。実証的に、DPMSolverサンプリングはわずか20ステップで高品質なサンプルを生成でき、10ステップでもかなり良いサンプルを生成できます。

元の実装は、[LuChengTHU/dpm-solver](https://github.com/LuChengTHU/dpm-solver) で確認できます。

## ヒント

ガイドサンプリングでは`solver_order`を2に設定すること、無条件サンプリングでは`solver_order=3`に設定することが推奨されます。

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

## DPMSolverSinglestepScheduler[[diffusers.DPMSolverSinglestepScheduler]]

#### diffusers.DPMSolverSinglestepScheduler[[diffusers.DPMSolverSinglestepScheduler]]

```python
diffusers.DPMSolverSinglestepScheduler(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++'] = 'dpmsolver++', solver_type: typing.Literal['midpoint', 'heun'] = 'midpoint', lower_order_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, final_sigmas_type: typing.Literal['zero', 'sigma_min'] = 'zero', lambda_min_clipped: float = -inf, variance_type: typing.Optional[typing.Literal['learned', 'learned_range']] = None, use_dynamic_shifting: bool = False, time_shift_type: typing.Literal['exponential'] = 'exponential')
```

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

**パラメータ:**

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

beta_start (`float`、デフォルトは`0.0001`) : 推論の初期`beta`値。

beta_end (`float`、デフォルトは `0.02`) : 最終的な `beta` の値。

beta_schedule (`"linear"`、`"scaled_linear"`、または `"squaredcos_cap_v2"`、デフォルトは `"linear"`) : ベータスケジュール。ベータの範囲から、モデルのステップ処理に使用するベータのシーケンスへのマッピングです。`linear`、`scaled_linear`、または `squaredcos_cap_v2` から選択します。

trained_betas (`np.ndarray` または `list[float]`、*任意*) : `beta_start` と `beta_end` をバイパスして、ベータの配列を直接コンストラクタに渡す場合に使用します。

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

prediction_type (`"epsilon"`, `"sample"`, `"v_prediction"`, or `"flow_prediction"`, defaults to `"epsilon"`) : Prediction type of the scheduler function; can be `epsilon` (predicts the noise of the diffusion process), `sample` (directly predicts the noisy sample`), `v_prediction` (see section 2.4 of [Imagen Video](https://huggingface.co/papers/2210.02303) paper), or `flow_prediction`.

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 (`"dpmsolver"`、`"dpmsolver++"`、または `"sde-dpmsolver++"`、デフォルトは `"dpmsolver++"`) : ソルバーのアルゴリズムタイプ。`dpmsolver`、`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 (`"midpoint"` または `"heun"`、デフォルトは `"midpoint"`) : 2 次ソルバーのソルバータイプ。`midpoint` または `heun` を指定できます。ソルバータイプはサンプルの品質にわずかな影響を与えますが、ステップ数が少ない場合特に顕著です。`midpoint` ソルバーの使用を推奨します。

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

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`) : フローベースモデルのフローシフトパラメータです。

final_sigmas_type (`"zero"` または `"sigma_min"`、*任意*、デフォルトは `"zero"`) : サンプリングプロセス中のノイズスケジュールにおける最終的な `sigma` 値。`"sigma_min"` の場合、最終的な sigma は学習スケジュールの最後の sigma と同じになります。`"zero"` の場合、最終的な sigma は 0 に設定されます。

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

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

use_dynamic_shifting (`bool`、デフォルトは`False`) : ノイズスケジュールに動的シフトを使用するかどうか。

time_shift_type (`"exponential"`、デフォルトは`"exponential"`) : 適用する時間シフトの種類。

`DPMSolverSinglestepScheduler` は、拡散 ODE 向けの高速な専用高次ソルバーです。

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

#### add_noise[[diffusers.DPMSolverSinglestepScheduler.add_noise]]

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

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

**パラメータ:**

original_samples (`torch.Tensor`) : ノイズが加えられていない元のサンプル。

noise (`torch.Tensor`) : サンプルに追加するノイズ。

timesteps (`torch.IntTensor`) : サンプルにノイズを付加するタイムステップ。

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

ノイズ付きサンプル。

指定されたタイムステップにおけるノイズスケジュールに従って、元のサンプルにノイズを追加します。

#### convert_model_output[[diffusers.DPMSolverSinglestepScheduler.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_singlestep.py#L666)

**パラメータ:**

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.DPMSolverSinglestepScheduler.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_singlestep.py#L762)

**パラメータ:**

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

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

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

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

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

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

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

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

#### get_order_list[[diffusers.DPMSolverSinglestepScheduler.get_order_list]]

```python
get_order_list(num_inference_steps: int)
```

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

**パラメータ:**

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

**戻り値:** `list[int]`

各タイムステップにおけるソルバーの順序のリスト。

各タイムステップでソルバーの順序を計算します。

#### index_for_timestep[[diffusers.DPMSolverSinglestepScheduler.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/main/src/diffusers/schedulers/scheduling_dpmsolver_singlestep.py#L1135)

**パラメータ:**

timestep (`int` または `torch.Tensor`) : インデックスを特定するためのタイムステップ。

schedule_timesteps (`torch.Tensor`, *任意*) : 検索対象のタイムステップスケジュール。`None` の場合は `self.timesteps` を使用します。

**戻り値:** `int`

スケジュールにおけるタイムステップのインデックス。

スケジュール内の指定されたタイムステップのインデックスを取得します。

#### scale_model_input[[diffusers.DPMSolverSinglestepScheduler.scale_model_input]]

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

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

**パラメータ:**

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

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

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

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

#### set_begin_index[[diffusers.DPMSolverSinglestepScheduler.set_begin_index]]

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

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

**パラメータ:**

begin_index (`int`、デフォルトは`0`) : スケジューラの開始インデックス。

スケジューラの開始インデックスを設定します。この関数は、推論の前にパイプラインから実行する必要があります。

#### set_timesteps[[diffusers.DPMSolverSinglestepScheduler.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)
```

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

**パラメータ:**

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

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

mu (`float`, *任意*) : 動的タイムシフトの指数。`use_dynamic_shifting` と `time_shift_type` が `"exponential"` であることが必要です。指定された場合、`flow_shift` は `exp(mu)` に設定されます。

timesteps (`list[int]`, *任意*) : 任意の間隔でタイムステップを配置できるようにするためのカスタムタイムステップ。`None` の場合、タイムステップ間の等間隔というデフォルトのタイムステップ間隔戦略が使用されます。`timesteps` が渡された場合、`num_inference_steps` は `None` でなければなりません。

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

#### singlestep_dpm_solver_second_order_update[[diffusers.DPMSolverSinglestepScheduler.singlestep_dpm_solver_second_order_update]]

```python
singlestep_dpm_solver_second_order_update(model_output_list: list, *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_singlestep.py#L829)

**パラメータ:**

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

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

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

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

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

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

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

`timestep_list[-2]` の時刻から `prev_timestep` の時刻での解を計算する、2 階単一ステップ DPMSolver の 1 ステップです。

#### singlestep_dpm_solver_third_order_update[[diffusers.DPMSolverSinglestepScheduler.singlestep_dpm_solver_third_order_update]]

```python
singlestep_dpm_solver_third_order_update(model_output_list: list, *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_singlestep.py#L943)

**パラメータ:**

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

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

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

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

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

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

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

3次の単一ステップ DPMSolver の1ステップ。時刻 `timestep_list[-3]` から時刻 `prev_timestep` における解を計算します。

#### singlestep_dpm_solver_update[[diffusers.DPMSolverSinglestepScheduler.singlestep_dpm_solver_update]]

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

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

**パラメータ:**

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

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

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

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

order (`int`) : このステップでのソルバーの順序。

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

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

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

単一ステップのDPMSolverの1ステップ。

#### ステップ[[diffusers.DPMSolverSinglestepScheduler.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/main/src/diffusers/schedulers/scheduling_dpmsolver_singlestep.py#L1188)

**パラメータ:**

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

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

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

generator (`torch.Generator`, *任意*) : 確率的サンプリング用の乱数生成器。

return_dict (`bool`、デフォルトは`True`) : [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を逆方向に適用することで予測します。この関数は、singlestep 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`関数の出力の基底クラス。