Hugging Face's logo

Diffusers documentation

FlowMatchHeunDiscreteScheduler

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

FlowMatchHeunDiscreteScheduler

FlowMatchHeunDiscreteScheduler is based on the flow-matching sampling introduced in EDM.

FlowMatchHeunDiscreteScheduler

class diffusers.FlowMatchHeunDiscreteScheduler

< >

( num_train_timesteps: int = 1000 shift: float = 1.0 )

Parameters

  • num_train_timesteps (int, defaults to 1000) — The number of diffusion steps to train the model.
  • 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 for more information.
  • shift (float, defaults to 1.0) — The shift value for the timestep schedule.

Heun scheduler.

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.

scale_noise

< >

( sample: FloatTensor timestep: Union noise: Optional = None ) → 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.

Forward process in flow-matching

set_begin_index

< >

( begin_index: int = 0 )

Parameters

  • begin_index (int) — The begin index for the scheduler.

Sets the begin index for the scheduler. This function should be run from pipeline before the inference.

set_timesteps

< >

( num_inference_steps: int device: Union = 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

< >

( model_output: FloatTensor timestep: Union sample: FloatTensor s_churn: float = 0.0 s_tmin: float = 0.0 s_tmax: float = inf s_noise: float = 1.0 generator: Optional = None return_dict: bool = True ) → ~schedulers.scheduling_Heun_discrete.HeunDiscreteSchedulerOutput or tuple

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.
  • s_churn (float) —
  • s_tmin (float) —
  • s_tmax (float) —
  • s_noise (float, defaults to 1.0) — Scaling factor for noise added to the sample.
  • generator (torch.Generator, optional) — A random number generator.
  • return_dict (bool) — Whether or not to return a ~schedulers.scheduling_Heun_discrete.HeunDiscreteSchedulerOutput or tuple.

Returns

~schedulers.scheduling_Heun_discrete.HeunDiscreteSchedulerOutput or tuple

If return_dict is True, ~schedulers.scheduling_Heun_discrete.HeunDiscreteSchedulerOutput 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 diffusion process from the learned model outputs (most often the predicted noise).

< > Update on GitHub

←FlowMatchEulerDiscreteScheduler HeunDiscreteScheduler→