Hugging Face 的 LOGO

Diffusers 文档

EulerDiscreteScheduler

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

EulerDiscreteScheduler

Euler 调度器（算法 2）来自 Karras 等人的 Elucidating the Design Space of Diffusion-Based Generative Models 论文。这是一种快速调度器，通常可以在 20-30 步内生成良好的输出。该调度器基于 Katherine Crowson 的原始 k-diffusion 实现。

EulerDiscreteScheduler

class diffusers.EulerDiscreteScheduler

< >

( num_train_timesteps: int = 1000 beta_start: float = 0.0001 beta_end: float = 0.02 beta_schedule: str = 'linear' trained_betas: typing.Union[numpy.ndarray, typing.List[float], NoneType] = None prediction_type: str = 'epsilon' interpolation_type: str = 'linear' use_karras_sigmas: typing.Optional[bool] = False use_exponential_sigmas: typing.Optional[bool] = False use_beta_sigmas: typing.Optional[bool] = False sigma_min: typing.Optional[float] = None sigma_max: typing.Optional[float] = None timestep_spacing: str = 'linspace' timestep_type: str = 'discrete' steps_offset: int = 0 rescale_betas_zero_snr: bool = False final_sigmas_type: str = 'zero' )

参数

  • num_train_timesteps (int, 默认为 1000) — 训练模型所需的扩散步数。
  • beta_start (float, 默认为 0.0001) — 推理的起始 beta 值。
  • beta_end (float, 默认为 0.02) — 最终的 beta 值。
  • beta_schedule (str, 默认为 "linear") — beta 调度，一个将 beta 范围映射到模型步进 beta 序列的映射。可选择 linear 或 scaled_linear。
  • trained_betas (np.ndarray, 可选) — 直接向构造函数传递一个 beta 数组，以绕过 beta_start 和 beta_end。
  • prediction_type (str, 默认为 epsilon, 可选) — 调度器函数的预测类型；可以是 epsilon（预测扩散过程的噪声）、sample（直接预测噪声样本）或 v_prediction（参见 Imagen Video 论文的 2.4 节）。
  • interpolation_type(str, 默认为 "linear", 可选) — 用于计算调度器去噪步骤中间 sigma 的插值类型。应为 "linear" 或 "log_linear" 之一。
  • use_karras_sigmas (bool, 可选, 默认为 False) — 在采样过程中，是否使用 Karras sigmas 作为噪声调度中的步长。如果为 True，则 sigma 值根据噪声水平序列 {σi} 确定。
  • use_exponential_sigmas (bool, 可选, 默认为 False) — 在采样过程中，是否使用指数 sigma 作为噪声调度中的步长。
  • use_beta_sigmas (bool, 可选, 默认为 False) — 在采样过程中，是否使用 beta sigma 作为噪声调度中的步长。有关更多信息，请参阅 Beta Sampling is All You Need。
  • timestep_spacing (str, 默认为 "linspace") — 时间步长的缩放方式。有关更多信息，请参阅 Common Diffusion Noise Schedules and Sample Steps are Flawed 的表 2。
  • steps_offset (int, 默认为 0) — 根据某些模型族的要求，添加到推理步骤的偏移量。
  • rescale_betas_zero_snr (bool, 默认为 False) — 是否重新调整 beta 值以使终端 SNR 为零。这使得模型能够生成非常亮和非常暗的样本，而不是将其限制在亮度适中的样本。与 --offset_noise 有松散的关联。
  • final_sigmas_type (str, 默认为 "zero") — 采样过程中噪声调度的最终 sigma 值。如果为 "sigma_min"，则最终 sigma 与训练调度中的最后一个 sigma 相同。如果为 zero，则最终 sigma 设置为 0。

欧拉调度器。

此模型继承自 SchedulerMixin 和 ConfigMixin。有关库为所有调度器实现的通用方法（如加载和保存），请查看超类文档。

scale_model_input

< >

( sample: Tensor timestep: typing.Union[float, torch.Tensor] ) → torch.Tensor

参数

  • sample (torch.Tensor) — 输入样本。
  • timestep (int, 可选) — 扩散链中的当前时间步。

返回

torch.Tensor

一个缩放后的输入样本。

确保与需要根据当前时间步缩放去噪模型输入的调度器可互换。通过 (sigma**2 + 1) ** 0.5 缩放去噪模型输入以匹配欧拉算法。

set_begin_index

< >

( begin_index: int = 0 )

参数

  • begin_index (int) — 调度器的起始索引。

设置调度器的起始索引。此函数应在推理之前从管道中运行。

set_timesteps

< >

( num_inference_steps: int = None device: typing.Union[str, torch.device] = None timesteps: typing.Optional[typing.List[int]] = None sigmas: typing.Optional[typing.List[float]] = None )

参数

  • num_inference_steps (int) — 使用预训练模型生成样本时使用的扩散步数。
  • device (str 或 torch.device, 可选) — 时间步长应移动到的设备。如果为 None，则时间步长不移动。
  • timesteps (List[int], 可选) — 用于支持任意时间步长调度的自定义时间步长。如果为 None，则时间步长将根据 timestep_spacing 属性生成。如果传递了 timesteps，则 num_inference_steps 和 sigmas 必须为 None，并且 timestep_spacing 属性将被忽略。
  • sigmas (List[float], 可选) — 用于支持任意时间步长调度的自定义 sigma。如果为 None，则时间步长和 sigma 将根据相关的调度器属性生成。如果传递了 sigmas，则 num_inference_steps 和 timesteps 必须为 None，并且时间步长将根据自定义 sigma 调度生成。

设置用于扩散链的离散时间步（在推理之前运行）。

步骤

< >

( model_output: Tensor timestep: typing.Union[float, torch.Tensor] sample: Tensor s_churn: float = 0.0 s_tmin: float = 0.0 s_tmax: float = inf s_noise: float = 1.0 generator: typing.Optional[torch._C.Generator] = None return_dict: bool = True ) → EulerDiscreteSchedulerOutput 或 tuple

参数

  • model_output (torch.Tensor) — 从学习到的扩散模型直接输出。
  • timestep (float) — 扩散链中的当前离散时间步。
  • sample (torch.Tensor) — 由扩散过程创建的当前样本实例。
  • s_churn (float) —
  • s_tmin (float) —
  • s_tmax (float) —
  • s_noise (float, 默认为 1.0) — 添加到样本的噪声缩放因子。
  • generator (torch.Generator, 可选) — 随机数生成器。
  • return_dict (bool) — 是否返回 EulerDiscreteSchedulerOutput 或元组。

返回

EulerDiscreteSchedulerOutput 或 tuple

如果 return_dict 为 True，则返回 EulerDiscreteSchedulerOutput，否则返回一个元组，其中第一个元素是样本张量。

通过逆转 SDE 预测前一个时间步的样本。此函数从学习到的模型输出（通常是预测的噪声）传播扩散过程。

EulerDiscreteSchedulerOutput

class diffusers.schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput

< >

( prev_sample: Tensor pred_original_sample: typing.Optional[torch.Tensor] = None )

参数

  • prev_sample (形状为图片 (batch_size, num_channels, height, width) 的 torch.Tensor) — 上一个时间步计算的样本 (x_{t-1})。prev_sample 应用作去噪循环中的下一个模型输入。
  • pred_original_sample (形状为图片 (batch_size, num_channels, height, width) 的 torch.Tensor) — 基于当前时间步的模型输出预测的去噪样本 (x_{0})。pred_original_sample 可用于预览进度或用于指导。

调度器 step 函数输出的输出类。

< > 在 GitHub 上更新

←EulerAncestralDiscreteScheduler FlowMatchEulerDiscreteScheduler→