DPMSolverSinglestepScheduler
DPMSolverSinglestepScheduler
is a single step scheduler from DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps and DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models by Cheng Lu, Yuhao Zhou, Fan Bao, Jianfei Chen, Chongxuan Li, and Jun Zhu.
DPMSolver (and the improved version DPMSolver++) is a fast dedicated high-order solver for diffusion ODEs with convergence order guarantee. Empirically, DPMSolver sampling with only 20 steps can generate high-quality samples, and it can generate quite good samples even in 10 steps.
The original implementation can be found at LuChengTHU/dpm-solver.
Tips
It is recommended to set solver_order
to 2 for guide sampling, and solver_order=3
for unconditional sampling.
Dynamic thresholding from Imagen is supported, and for pixel-space
diffusion models, you can set both algorithm_type="dpmsolver++"
and thresholding=True
to use dynamic
thresholding. This thresholding method is unsuitable for latent-space diffusion models such as
Stable Diffusion.
DPMSolverSinglestepScheduler
class diffusers.DPMSolverSinglestepScheduler
< source >( num_train_timesteps: int = 1000 beta_start: float = 0.0001 beta_end: float = 0.02 beta_schedule: str = 'linear' trained_betas: Optional = None solver_order: int = 2 prediction_type: str = 'epsilon' thresholding: bool = False dynamic_thresholding_ratio: float = 0.995 sample_max_value: float = 1.0 algorithm_type: str = 'dpmsolver++' solver_type: str = 'midpoint' lower_order_final: bool = False use_karras_sigmas: Optional = False final_sigmas_type: Optional = 'zero' lambda_min_clipped: float = -inf variance_type: Optional = None )
Parameters
- num_train_timesteps (
int
, defaults to 1000) — The number of diffusion steps to train the model. - beta_start (
float
, defaults to 0.0001) — The startingbeta
value of inference. - beta_end (
float
, defaults to 0.02) — The finalbeta
value. - beta_schedule (
str
, defaults to"linear"
) — The beta schedule, a mapping from a beta range to a sequence of betas for stepping the model. Choose fromlinear
,scaled_linear
, orsquaredcos_cap_v2
. - trained_betas (
np.ndarray
, optional) — Pass an array of betas directly to the constructor to bypassbeta_start
andbeta_end
. - solver_order (
int
, defaults to 2) — The DPMSolver order which can be1
or2
or3
. It is recommended to usesolver_order=2
for guided sampling, andsolver_order=3
for unconditional sampling. - prediction_type (
str
, defaults toepsilon
, optional) — Prediction type of the scheduler function; can beepsilon
(predicts the noise of the diffusion process),sample
(directly predicts the noisy sample) or
v_prediction` (see section 2.4 of Imagen Video paper). - thresholding (
bool
, defaults toFalse
) — Whether to use the “dynamic thresholding” method. This is unsuitable for latent-space diffusion models such as Stable Diffusion. - dynamic_thresholding_ratio (
float
, defaults to 0.995) — The ratio for the dynamic thresholding method. Valid only whenthresholding=True
. - sample_max_value (
float
, defaults to 1.0) — The threshold value for dynamic thresholding. Valid only whenthresholding=True
andalgorithm_type="dpmsolver++"
. - algorithm_type (
str
, defaults todpmsolver++
) — Algorithm type for the solver; can bedpmsolver
ordpmsolver++
. Thedpmsolver
type implements the algorithms in the DPMSolver paper, and thedpmsolver++
type implements the algorithms in the DPMSolver++ paper. It is recommended to usedpmsolver++
orsde-dpmsolver++
withsolver_order=2
for guided sampling like in Stable Diffusion. - solver_type (
str
, defaults tomidpoint
) — Solver type for the second-order solver; can bemidpoint
orheun
. The solver type slightly affects the sample quality, especially for a small number of steps. It is recommended to usemidpoint
solvers. - lower_order_final (
bool
, defaults toTrue
) — Whether to use lower-order solvers in the final steps. Only valid for < 15 inference steps. This can stabilize the sampling of DPMSolver for steps < 15, especially for steps <= 10. - use_karras_sigmas (
bool
, optional, defaults toFalse
) — Whether to use Karras sigmas for step sizes in the noise schedule during the sampling process. IfTrue
, the sigmas are determined according to a sequence of noise levels {σi}. - final_sigmas_type (
str
, optional, defaults to"zero"
) — The finalsigma
value for the noise schedule during the sampling process. If"sigma_min"
, the final sigma is the same as the last sigma in the training schedule. Ifzero
, the final sigma is set to 0. - lambda_min_clipped (
float
, defaults to-inf
) — Clipping threshold for the minimum value oflambda(t)
for numerical stability. This is critical for the cosine (squaredcos_cap_v2
) noise schedule. - variance_type (
str
, optional) — Set to “learned” or “learned_range” for diffusion models that predict variance. If set, the model’s output contains the predicted Gaussian variance.
DPMSolverSinglestepScheduler
is a fast dedicated high-order solver for diffusion ODEs.
This model inherits from SchedulerMixin and ConfigMixin. Check the superclass documentation for the generic methods the library implements for all schedulers such as loading and saving.
convert_model_output
< source >( model_output: Tensor *args sample: Tensor = None **kwargs ) → torch.Tensor
Convert the model output to the corresponding type the DPMSolver/DPMSolver++ algorithm needs. DPM-Solver is designed to discretize an integral of the noise prediction model, and DPM-Solver++ is designed to discretize an integral of the data prediction model.
The algorithm and model type are decoupled. You can use either DPMSolver or DPMSolver++ for both noise prediction and data prediction models.
dpm_solver_first_order_update
< source >( model_output: Tensor *args sample: Tensor = None **kwargs ) → torch.Tensor
Parameters
- model_output (
torch.Tensor
) — The direct output from the learned diffusion model. - timestep (
int
) — The current discrete timestep in the diffusion chain. - prev_timestep (
int
) — The previous discrete timestep in the diffusion chain. - sample (
torch.Tensor
) — A current instance of a sample created by the diffusion process.
Returns
torch.Tensor
The sample tensor at the previous timestep.
One step for the first-order DPMSolver (equivalent to DDIM).
get_order_list
< source >( num_inference_steps: int )
Computes the solver order at each time step.
scale_model_input
< source >( sample: Tensor *args **kwargs ) → torch.Tensor
Ensures interchangeability with schedulers that need to scale the denoising model input depending on the current timestep.
set_begin_index
< source >( begin_index: int = 0 )
Sets the begin index for the scheduler. This function should be run from pipeline before the inference.
set_timesteps
< source >( num_inference_steps: int = None device: Union = None timesteps: Optional = None )
Parameters
- num_inference_steps (
int
) — The number of diffusion steps used when generating samples with a pre-trained model. - device (
str
ortorch.device
, optional) — The device to which the timesteps should be moved to. IfNone
, the timesteps are not moved. - timesteps (
List[int]
, optional) — Custom timesteps used to support arbitrary spacing between timesteps. IfNone
, then the default timestep spacing strategy of equal spacing between timesteps schedule is used. Iftimesteps
is passed,num_inference_steps
must beNone
.
Sets the discrete timesteps used for the diffusion chain (to be run before inference).
singlestep_dpm_solver_second_order_update
< source >( model_output_list: List *args sample: Tensor = None **kwargs ) → torch.Tensor
Parameters
- model_output_list (
List[torch.Tensor]
) — The direct outputs from learned diffusion model at current and latter timesteps. - timestep (
int
) — The current and latter discrete timestep in the diffusion chain. - prev_timestep (
int
) — The previous discrete timestep in the diffusion chain. - sample (
torch.Tensor
) — A current instance of a sample created by the diffusion process.
Returns
torch.Tensor
The sample tensor at the previous timestep.
One step for the second-order singlestep DPMSolver that computes the solution at time prev_timestep
from the
time timestep_list[-2]
.
singlestep_dpm_solver_third_order_update
< source >( model_output_list: List *args sample: Tensor = None **kwargs ) → torch.Tensor
Parameters
- model_output_list (
List[torch.Tensor]
) — The direct outputs from learned diffusion model at current and latter timesteps. - timestep (
int
) — The current and latter discrete timestep in the diffusion chain. - prev_timestep (
int
) — The previous discrete timestep in the diffusion chain. - sample (
torch.Tensor
) — A current instance of a sample created by diffusion process.
Returns
torch.Tensor
The sample tensor at the previous timestep.
One step for the third-order singlestep DPMSolver that computes the solution at time prev_timestep
from the
time timestep_list[-3]
.
singlestep_dpm_solver_update
< source >( model_output_list: List *args sample: Tensor = None order: int = None **kwargs ) → torch.Tensor
Parameters
- model_output_list (
List[torch.Tensor]
) — The direct outputs from learned diffusion model at current and latter timesteps. - timestep (
int
) — The current and latter discrete timestep in the diffusion chain. - prev_timestep (
int
) — The previous discrete timestep in the diffusion chain. - sample (
torch.Tensor
) — A current instance of a sample created by diffusion process. - order (
int
) — The solver order at this step.
Returns
torch.Tensor
The sample tensor at the previous timestep.
One step for the singlestep DPMSolver.
step
< source >( model_output: Tensor timestep: int sample: Tensor return_dict: bool = True ) → SchedulerOutput or tuple
Parameters
- model_output (
torch.Tensor
) — The direct output from learned diffusion model. - timestep (
int
) — The current discrete timestep in the diffusion chain. - sample (
torch.Tensor
) — A current instance of a sample created by the diffusion process. - return_dict (
bool
) — Whether or not to return a SchedulerOutput ortuple
.
Returns
SchedulerOutput or tuple
If return_dict is True
, SchedulerOutput is returned, otherwise a
tuple is returned where the first element is the sample tensor.
Predict the sample from the previous timestep by reversing the SDE. This function propagates the sample with the singlestep DPMSolver.
SchedulerOutput
class diffusers.schedulers.scheduling_utils.SchedulerOutput
< source >( prev_sample: Tensor )
Base class for the output of a scheduler’s step
function.