Hugging Face's logo

Diffusers documentation

HeunDiscreteScheduler

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.42.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

HeunDiscreteScheduler

Heun 调度器（算法 1）出自 Karras 等人撰写的论文 Elucidating the Design Space of Diffusion-Based Generative Models。该调度器移植自 k-diffusion 库，由 Katherine Crowson 创建。

HeunDiscreteScheduler

class diffusers.HeunDiscreteScheduler

< >

( num_train_timesteps: int = 1000beta_start: float = 0.00085beta_end: float = 0.012beta_schedule: str = 'linear'trained_betas: numpy.ndarray | list[float] | None = Noneprediction_type: str = 'epsilon'use_karras_sigmas: bool = Falseuse_exponential_sigmas: bool = Falseuse_beta_sigmas: bool = Falseclip_sample: bool = Falseclip_sample_range: float = 1.0timestep_spacing: typing.Literal['linspace', 'leading', 'trailing'] = 'linspace'steps_offset: int = 0 )

参数

  • num_train_timesteps (int，默认为 1000) — 用于训练模型的扩散步数。
  • beta_start (float，默认为 0.0001) — 推理的起始 beta 值。
  • beta_end (float，默认为 0.02) — 最终的 beta 值。
  • beta_schedule（"linear"、"scaled_linear"、"squaredcos_cap_v2" 或 "exp"，默认为 "linear"）—— Beta 调度，将 beta 范围映射为用于模型步进的一系列 beta 值。可选 linear、scaled_linear、squaredcos_cap_v2 或 exp。
  • trained_betas (np.ndarray, 可选) — 直接传入 betas 数组到构造函数中，以绕过 beta_start 和 beta_end。
  • prediction_type ("epsilon", "sample", or "v_prediction", 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 Imagen Video paper).
  • clip_sample (bool，默认为 True) — 对预测样本进行裁剪，以确保数值稳定性。
  • clip_sample_range (float，默认为 1.0) — 样本裁剪的最大幅度。仅在 clip_sample=True 时有效。
  • use_karras_sigmas (bool，可选，默认为 False) — 是否在采样过程的噪声调度中使用 Karras sigmas 来确定步长。如果为 True，则 sigmas 将根据噪声水平序列 {σi} 确定。
  • use_exponential_sigmas (bool，可选，默认为 False) — 在采样过程中，噪声调度的步长是否使用指数 sigmas。
  • use_beta_sigmas (bool, optional, defaults to False) — Whether to use beta sigmas for step sizes in the noise schedule during the sampling process. Refer to Beta Sampling is All You Need for more information.
  • timestep_spacing（"linspace"、"leading" 或 "trailing"，默认为 "linspace"） — 时间步的缩放方式。更多信息请参阅 常见的扩散噪声调度和采样步骤存在缺陷 中的表 2。
  • steps_offset (int，默认为 0) — 添加到推理步数中的偏移量，某些模型系列需要此参数。

用于离散 beta 调度的 Heun 步调度器。

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

add_noise

< >

( original_samples: Tensornoise: Tensortimesteps: Tensor ) → torch.Tensor

参数

  • original_samples (torch.Tensor) — 将添加噪声的原始样本。
  • noise (torch.Tensor) — 要添加到原始样本中的噪声张量。
  • timesteps (torch.Tensor) — 用于添加噪声的时间步，决定调度器中的噪声水平。

返回值

torch.Tensor

根据时间步调度对添加的噪声进行缩放后的含噪样本。

根据指定时间步的噪声调度，向原始样本添加噪声。

index_for_timestep

< >

( timestep: typing.Union[float, torch.Tensor]schedule_timesteps: typing.Optional[torch.Tensor] = None ) → int

参数

  • timestep（float 或 torch.Tensor）— 要在调度器中查找的时间步值。
  • schedule_timesteps (torch.Tensor，可选) — 要搜索的时间步调度。如果为 None，则使用 self.timesteps。

返回值

int

时间步在调度器中的索引。对于第一个步骤，如果存在多个匹配项，则返回第二个索引，以避免在从调度器中间开始（例如，用于图像到图像任务）时跳过某个 sigma。

查找给定时间步在时间步调度中的索引。

scale_model_input

< >

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

参数

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

返回值

torch.Tensor

经过缩放的输入样本。

确保与那些需要根据当前时间步对去噪模型输入进行缩放的调度器之间的可互换性。

set_begin_index

< >

( begin_index: int = 0 )

参数

  • begin_index (int，默认为 0) — 调度器的起始索引。

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

set_timesteps

< >

( num_inference_steps: int | None = Nonedevice: typing.Union[str, torch.device] = Nonenum_train_timesteps: int | None = Nonetimesteps: list[int] | None = None )

参数

  • num_inference_steps（int，可选，默认为 None）— 使用预训练模型生成样本时所用的扩散步数。
  • device (str, torch.device, 可选，默认为 None) — timesteps 应移动到的设备。如果为 None，则不移动 timesteps。
  • num_train_timesteps (int，可选，默认为 None) — 训练模型时使用的扩散步数。如果为 None，则使用默认的 num_train_timesteps 属性。
  • timesteps (list[int], 可选) — 用于支持任意时间步间隔的自定义时间步。如果为 None，则会根据 timestep_spacing 属性生成时间步。如果传入了 timesteps，则 num_inference_steps 必须为 None，并且 timestep_spacing 属性将被忽略。

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

步骤

< >

( model_output: typing.Union[torch.Tensor, numpy.ndarray]timestep: typing.Union[float, torch.Tensor]sample: typing.Union[torch.Tensor, numpy.ndarray]return_dict: bool = True ) → HeunDiscreteSchedulerOutput or tuple

参数

  • model_output (torch.Tensor) — 学习到的扩散模型的直接输出。
  • timestep (float) — 扩散链中的当前离散时间步。
  • sample (torch.Tensor) — 扩散过程生成的样本的当前实例。
  • return_dict (bool) — 是否返回 HeunDiscreteSchedulerOutput 或元组。

返回值

HeunDiscreteSchedulerOutput 或 tuple

If return_dict is True, HeunDiscreteSchedulerOutput is returned, otherwise a tuple is returned where the first element is the sample tensor.

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

SchedulerOutput

class diffusers.schedulers.scheduling_utils.SchedulerOutput

< >

( prev_sample: Tensor )

参数

  • prev_sample（对于图像，形状为 (batch_size, num_channels, height, width) 的 torch.Tensor）— 前一时间步的已计算样本 (x_{t-1})。在去噪循环中，应将 prev_sample 用作下一个模型输入。

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

Update on GitHub

←HeliosScheduler IPNDMScheduler→