Diffusers 文档

EulerDiscreteScheduler

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

EulerDiscreteScheduler

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

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 范围到模型步进的 betas 序列的映射。 从 linearscaled_linear 中选择。
  • trained_betas (np.ndarray, 可选) — 直接将 betas 数组传递给构造函数以绕过 beta_startbeta_end
  • prediction_type (str, 默认为 epsilon, 可选) — 调度器函数的预测类型;可以是 epsilon (预测扩散过程的噪声)、sample (直接预测噪声样本)或 v_prediction (参见 Imagen Video 论文的 2.4 节)。
  • interpolation_type(str, 默认为 "linear", 可选) — 用于计算调度器去噪步骤的中间 sigmas 的插值类型。 应该是 "linear""log_linear" 之一。
  • use_karras_sigmas (bool, 可选, 默认为 False) — 是否在采样过程中对噪声时间表中的步长使用 Karras sigmas。 如果为 True,则 sigmas 根据噪声水平序列 {σi} 确定。
  • use_exponential_sigmas (bool, 可选, 默认为 False) — 是否在采样过程中对噪声时间表中的步长使用指数 sigmas。
  • use_beta_sigmas (bool, 可选, 默认为 False) — 是否在采样过程中对噪声时间表中的步长使用 beta sigmas。 有关更多信息,请参阅 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) — 是否重新缩放 betas 以使其具有零终端 SNR。 这使模型能够生成非常明亮和黑暗的样本,而不是将其限制为具有中等亮度的样本。 与 --offset_noise 大致相关。
  • final_sigmas_type (str, 默认为 "zero") — 采样过程中噪声时间表的最终 sigma 值。 如果为 "sigma_min",则最终 sigma 与训练时间表中的最后一个 sigma 相同。 如果为 zero,则最终 sigma 设置为 0。

Euler 调度器。

此模型继承自 SchedulerMixinConfigMixin。 查看超类文档以获取库为所有调度器实现的通用方法,例如加载和保存。

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 缩放以匹配 Euler 算法。

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 (strtorch.device, 可选) — 时间步应移动到的设备。 如果为 None,则时间步不会移动。
  • timesteps (List[int], 可选) — 用于支持任意时间步计划的自定义时间步。 如果为 None,则将根据 timestep_spacing 属性生成时间步。 如果传递了 timesteps,则 num_inference_stepssigmas 必须为 None,并且 timestep_spacing 属性将被忽略。
  • sigmas (List[float], 可选) — 用于支持任意时间步计划的自定义 sigmas 计划。 如果为 None,则将根据相关的调度器属性生成时间步和 sigmas。 如果传递了 sigmas,则 num_inference_stepstimesteps 必须为 None,并且将基于自定义 sigmas 计划生成时间步。

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

step

< >

( 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 ) EulerDiscreteSchedulerOutputtuple

参数

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

返回值

EulerDiscreteSchedulerOutputtuple

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

通过反转 SDE,从前一个时间步预测 sample。此函数从学习到的模型输出(通常是预测的噪声)传播扩散过程。

EulerDiscreteSchedulerOutput

class diffusers.schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput

< >

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

参数

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

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

< > 在 GitHub 上更新