Last updated
Last updated
The Heun scheduler (Algorithm 1) is from the paper by Karras et al. The scheduler is ported from the library and created by .
( num_train_timesteps: int = 1000beta_start: float = 0.00085beta_end: float = 0.012beta_schedule: str = 'linear'trained_betas: typing.Union[numpy.ndarray, typing.List[float], NoneType] = Noneprediction_type: str = 'epsilon'use_karras_sigmas: typing.Optional[bool] = Falseclip_sample: typing.Optional[bool] = Falseclip_sample_range: float = 1.0timestep_spacing: str = 'linspace'steps_offset: int = 0 )
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 starting beta value of inference.
beta_end (float, defaults to 0.02) β The final beta 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 from linear or scaled_linear.
trained_betas (np.ndarray, optional) β Pass an array of betas directly to the constructor to bypass beta_start and beta_end.
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 paper).
clip_sample (bool, defaults to True) β Clip the predicted sample for numerical stability.
clip_sample_range (float, defaults to 1.0) β The maximum magnitude for sample clipping. Valid only when clip_sample=True.
use_karras_sigmas (bool, optional, defaults to False) β Whether to use Karras sigmas for step sizes in the noise schedule during the sampling process. If True, the sigmas are determined according to a sequence of noise levels {Οi}.
timestep_spacing (str, defaults to "linspace") β The way the timesteps should be scaled. Refer to Table 2 of the for more information.
steps_offset (int, defaults to 0) β An offset added to the inference steps. You can use a combination of offset=1 and set_alpha_to_one=False to make the last step use step 0 for the previous alpha product like in Stable Diffusion.
Scheduler with Heun steps for discrete beta schedules.
scale_model_input
( sample: FloatTensortimestep: typing.Union[float, torch.FloatTensor] ) β torch.FloatTensor
Parameters
sample (torch.FloatTensor) β The input sample.
timestep (int, optional) β The current timestep in the diffusion chain.
Returns
torch.FloatTensor
A scaled input sample.
Ensures interchangeability with schedulers that need to scale the denoising model input depending on the current timestep.
set_timesteps
( num_inference_steps: intdevice: typing.Union[str, torch.device] = Nonenum_train_timesteps: typing.Optional[int] = None )
Parameters
num_inference_steps (int) β The number of diffusion steps used when generating samples with a pre-trained model.
device (str or torch.device, optional) β The device to which the timesteps should be moved to. If None, the timesteps are not moved.
Sets the discrete timesteps used for the diffusion chain (to be run before inference).
step
Parameters
model_output (torch.FloatTensor) β The direct output from learned diffusion model.
timestep (float) β The current discrete timestep in the diffusion chain.
sample (torch.FloatTensor) β A current instance of a sample created by the diffusion process.
Returns
Predict the sample from the previous timestep by reversing the SDE. This function propagates the diffusion process from the learned model outputs (most often the predicted noise).
( prev_sample: FloatTensor )
Parameters
prev_sample (torch.FloatTensor of shape (batch_size, num_channels, height, width) for images) β Computed sample (x_{t-1}) of previous timestep. prev_sample should be used as next model input in the denoising loop.
Base class for the output of a schedulerβs step function.
This model inherits from and . Check the superclass documentation for the generic methods the library implements for all schedulers such as loading and saving.
( model_output: typing.Union[torch.FloatTensor, numpy.ndarray]timestep: typing.Union[float, torch.FloatTensor]sample: typing.Union[torch.FloatTensor, numpy.ndarray]return_dict: bool = True ) β or tuple
return_dict (bool) β Whether or not to return a or tuple.
or tuple
If return_dict is True, is returned, otherwise a tuple is returned where the first element is the sample tensor.