参数

• prompt (str 或 List[str], 可选) — 用于引导图像生成的 prompt。如果未定义，则需要传递 prompt_embeds。
• height (int, optional, defaults to self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的高度，单位为像素。
• width (int, optional, defaults to self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的宽度，单位为像素。
• num_inference_steps (int, optional, defaults to 50) — 推理步骤数。更多的去噪步骤通常会带来更高质量的图像，但会牺牲推理速度。
• timesteps (List[int], optional) — 时间步长。用于去噪过程的自定义时间步长，适用于调度器在其 set_timesteps 方法中支持 `timesteps` 参数的情况。 如果未定义，则当传递 `num_inference_steps` 时将使用默认行为。 必须按降序排列。
• guidance_scale (float, optional, defaults to 7.5) — 引导比例。更高的引导比例值会鼓励模型生成与文本 prompt 更紧密相关的图像，但会以降低图像质量为代价。 当 guidance_scale > 1 时，引导比例生效。
• negative_prompt (str or List[str], optional) — 负面提示。用于引导图像生成中不应包含的内容的提示。 如果未定义，则需要传递 negative_prompt_embeds。 当不使用引导（guidance_scale < 1）时忽略。
• num_images_per_prompt (int, optional, defaults to 1) — 每提示图像数量。每个提示生成的图像数量。
• batch_size (int, optional, defaults to 1) — 批大小。一个批次中的图像数量。
• eta (float, optional, defaults to 0.0) — eta。对应于 DDIM 论文中的参数 eta (η)。 仅适用于 ~schedulers.DDIMScheduler，在其他调度器中将被忽略。
• generator (torch.Generator or List[torch.Generator], optional) — 生成器。用于使生成具有确定性的 torch.Generator。
• latents (torch.FloatTensor, optional) — 潜在变量。从高斯分布中预生成的噪声潜在变量，用作图像生成的输入。 可用于使用不同的提示调整相同的生成。 如果未提供，则通过使用提供的随机 generator 采样来生成潜在张量。
• prompt_embeds (torch.FloatTensor, optional) — 提示嵌入。预生成的文本嵌入。 可用于轻松调整文本输入（提示权重）。 如果未提供，则从 prompt 输入参数生成文本嵌入。
• negative_prompt_embeds (torch.FloatTensor, optional) — 负面提示嵌入。预生成的负面文本嵌入。 可用于轻松调整文本输入（提示权重）。 如果未提供，则从 `negative_prompt` 输入参数生成 `negative_prompt_embeds`。 ip_adapter_image — (`PipelineImageInput`, *optional*): 与 IP 适配器一起使用的可选图像输入。
• output_type (str, optional, defaults to "pil") — 输出类型。生成图像的输出格式。 在 PIL.Image 或 np.array 之间选择。
• return_dict (bool, optional, defaults to True) — 返回字典。是否返回 GaudiStableDiffusionPipelineOutput 而不是纯元组。
• cross_attention_kwargs (dict, optional) — 交叉注意力关键字参数。一个关键字参数字典，如果指定，则作为 self.processor 中定义的 AttentionProcessor 的参数传递。
• guidance_rescale (float, optional, defaults to 0.0) — 引导重缩放。来自 Common Diffusion Noise Schedules and Sample Steps are Flawed 的引导重缩放因子。 引导重缩放因子应修复使用零终端 SNR 时的过度曝光问题。
• clip_skip (int, optional) — CLIP 跳过。从 CLIP 中跳过的层数，用于计算提示嵌入。 值 1 表示预最终层的输出将用于计算提示嵌入。
• callback_on_step_end (Callable, optional) — 步骤结束时回调。在推理期间每个去噪步骤结束时调用的函数。 该函数使用以下参数调用： `callback_on_step_end(self: DiffusionPipeline, step: int, timestep: int, callback_kwargs: Dict)`。 `callback_kwargs` 将包含 `callback_on_step_end_tensor_inputs` 指定的所有张量列表。
• callback_on_step_end_tensor_inputs (List, optional) — 步骤结束时回调的张量输入。`callback_on_step_end` 函数的张量输入列表。 列表中指定的张量将作为 `callback_kwargs` 参数传递。 您将只能包含管道类的 `._callback_tensor_inputs` 属性中列出的变量。
• profiling_warmup_steps (int, optional) — 性能分析预热步骤。性能分析中要忽略的步骤数。
• profiling_steps (int, optional) — 性能分析步骤。启用性能分析时要捕获的步骤数。

如果 return_dict 为 True，则返回 ~diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput，否则返回一个 tuple，其中第一个元素是包含生成图像的列表，第二个元素是 bool 列表，指示相应的生成图像是否包含“不适合工作场所观看”（nsfw）内容。

参数

• save_directory (str 或 os.PathLike) — 要保存到的目录。如果不存在，将创建该目录。
• safe_serialization (bool, 可选, 默认为 True) — 是否使用 safetensors 或传统的 PyTorch 方式（使用 pickle）保存模型。
• variant (str, 可选) — 如果指定，权重将以 pytorch_model..bin 格式保存。
• push_to_hub (bool, 可选, 默认为 False) — 是否在保存模型后将其推送到 Hugging Face 模型 hub。 您可以使用 repo_id 指定要推送到的存储库（默认为命名空间中 save_directory 的名称）。
• kwargs (Dict[str, Any], 可选) — 传递给 ~utils.PushToHubMixin.push_to_hub 方法的附加关键字参数。

参数

• timestep (int, optional) — 扩散链中当前的离散时间步长。 可选地用于初始化在去噪计划中间开始的情况下的参数（例如，用于图像到图像）。

参数

• model_output (torch.FloatTensor) — 来自学习扩散模型的直接输出。
• sample (torch.FloatTensor) — 由扩散过程创建的样本的当前实例。
• eta (float) — 扩散步骤中添加噪声的噪声权重。
• use_clipped_model_output (bool, defaults to False) — 如果为 True，则从裁剪的预测原始样本计算“校正后的” model_output。 这是必要的，因为当 self.config.clip_sample 为 True 时，预测的原始样本会被裁剪到 [-1, 1]。 如果未发生裁剪，“校正后的” model_output 将与作为输入提供的输出一致，并且 use_clipped_model_output 无效。
• generator (torch.Generator, optional) — 随机数生成器。
• variance_noise (torch.FloatTensor) — 通过直接提供方差本身的噪声来替代使用 generator 生成噪声。 对于诸如 CycleDiffusion 之类的方法很有用。
• return_dict (bool, optional, defaults to True) — 是否返回 DDIMSchedulerOutput 或 tuple。

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

参数

• prompt (str 或 List[str], 可选) — 用于引导图像生成的提示词。如果未定义，则必须传递 prompt_embeds。代替。
• prompt_2 (str 或 List[str], 可选) — 要发送到 tokenizer_2 和 text_encoder_2 的提示词。如果未定义，则 prompt 将在两个文本编码器中使用
• height (int, 可选, 默认为 self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的高度像素。默认设置为 1024 以获得最佳效果。对于 stabilityai/stable-diffusion-xl-base-1.0 和未针对低分辨率进行微调的检查点，低于 512 像素的任何值都无法很好地工作。
• width (int, 可选, 默认为 self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的宽度像素。默认设置为 1024 以获得最佳效果。对于 stabilityai/stable-diffusion-xl-base-1.0 和未针对低分辨率进行微调的检查点，低于 512 像素的任何值都无法很好地工作。
• num_inference_steps (int, 可选, 默认为 50) — 去噪步骤的数量。更多去噪步骤通常会以较慢的推理速度为代价，从而获得更高质量的图像。
• timesteps (List[int], 可选) — 用于支持在其 set_timesteps 方法中使用 timesteps 参数的调度器的去噪过程的自定义时间步长。如果未定义，将使用传递 num_inference_steps 时的默认行为。必须按降序排列。
• denoising_end (float, 可选) — 如果指定，则确定在有意提前终止之前要完成的总去噪过程的分数（介于 0.0 和 1.0 之间）。因此，返回的样本仍将保留大量的噪声，这由调度器选择的离散时间步长决定。当此 pipeline 构成“去噪器混合”多 pipeline 设置的一部分时，应理想地使用 denoising_end 参数，如 优化图像输出 中所述
• guidance_scale (float, 可选, 默认为 5.0) — Classifier-Free Diffusion Guidance 中定义的引导缩放。 guidance_scale 定义为 Imagen Paper 的公式 2 中的 w。通过设置 guidance_scale > 1 启用引导缩放。较高的引导缩放鼓励生成与文本 prompt 紧密相关的图像，通常以降低图像质量为代价。
• negative_prompt (str 或 List[str], 可选) — 不用于引导图像生成的提示词。如果未定义，则必须传递 negative_prompt_embeds 代替。当不使用引导时忽略（即，如果 guidance_scale 小于 1 则忽略）。
• negative_prompt_2 (str 或 List[str], 可选) — 不用于引导图像生成的提示词，要发送到 tokenizer_2 和 text_encoder_2。如果未定义，则 negative_prompt 将在两个文本编码器中使用
• num_images_per_prompt (int, 可选, 默认为 1) — 每个提示词要生成的图像数量。
• batch_size (int, optional, defaults to 1) — 一个批次中的图像数量。
• eta (float, optional, defaults to 0.0) — 对应于 DDIM 论文中的参数 eta (η): https://arxiv.org/abs/2010.02502。仅适用于 schedulers.DDIMScheduler，对其他调度器将被忽略。
• generator (torch.Generator 或 List[torch.Generator], optional) — 一个或一组 torch 生成器，用于使生成过程确定化。
• latents (torch.FloatTensor, optional) — 预生成的噪声潜变量，从高斯分布中采样，用作图像生成的输入。可用于通过不同的提示调整相同的生成结果。如果未提供，将使用提供的随机 generator 采样生成潜变量张量。
• prompt_embeds (torch.FloatTensor, optional) — 预生成的文本嵌入。可用于轻松调整文本输入，例如 提示权重。如果未提供，将从 prompt 输入参数生成文本嵌入。
• negative_prompt_embeds (torch.FloatTensor, optional) — 预生成的负面文本嵌入。可用于轻松调整文本输入，例如 提示权重。如果未提供，将从 negative_prompt 输入参数生成 negative_prompt_embeds。
• pooled_prompt_embeds (torch.FloatTensor, optional) — 预生成的池化文本嵌入。可用于轻松调整文本输入，例如 提示权重。如果未提供，将从 prompt 输入参数生成池化文本嵌入。
• negative_pooled_prompt_embeds (torch.FloatTensor, optional) — 预生成的负面池化文本嵌入。可用于轻松调整文本输入，例如 提示权重。如果未提供，将从 negative_prompt 输入参数生成池化的 negative_prompt_embeds。 ip_adapter_image — (PipelineImageInput, optional): 与 IP 适配器一起使用的可选图像输入。
• output_type (str, optional, defaults to "pil") — 生成图像的输出格式。在 PIL: PIL.Image.Image 或 np.array 之间选择。
• return_dict (bool, optional, defaults to True) — #是否返回 ~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput 而不是纯元组。是否返回 GaudiStableDiffusionXLPipelineOutput 而不是纯元组。
• cross_attention_kwargs (dict, optional) — 一个 kwargs 字典，如果指定，则会传递给 AttentionProcessor，定义在 diffusers.models.attention_processor 中的 self.processor 下。
• guidance_rescale (float, optional, defaults to 0.0) — Common Diffusion Noise Schedules and Sample Steps are Flawed 提出的引导重缩放因子。guidance_scale 在 Common Diffusion Noise Schedules and Sample Steps are Flawed 的公式 16 中定义为 φ。当使用零终端信噪比时，引导重缩放因子应修复过度曝光。
• original_size (Tuple[int], optional, defaults to (1024, 1024)) — 如果 original_size 与 target_size 不同，图像将显示为降采样或升采样。如果未指定，original_size 默认为 (height, width)。SDXL 微条件控制的一部分，如 https://huggingface.co/papers/2307.01952 的 2.2 节所述。
• crops_coords_top_left (Tuple[int], optional, defaults to (0, 0)) — crops_coords_top_left 可用于生成看起来像是从 crops_coords_top_left 位置向下“裁剪”的图像。通常通过将 crops_coords_top_left 设置为 (0, 0) 来获得良好居中的图像。SDXL 微条件控制的一部分，如 https://huggingface.co/papers/2307.01952 的 2.2 节所述。
• target_size (Tuple[int], optional, defaults to (1024, 1024)) — 在大多数情况下，target_size 应设置为生成图像的所需高度和宽度。如果未指定，则默认为 (height, width)。SDXL 微条件控制的一部分，如 https://huggingface.co/papers/2307.01952 的 2.2 节所述。
• negative_original_size (Tuple[int], optional, defaults to (1024, 1024)) — 为了基于特定的图像分辨率对生成过程进行负面条件控制。SDXL 微条件控制的一部分，如 https://huggingface.co/papers/2307.01952 的 2.2 节所述。有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。
• negative_crops_coords_top_left (Tuple[int], optional, defaults to (0, 0)) — 为了基于特定的裁剪坐标对生成过程进行负面条件控制。SDXL 微条件控制的一部分，如 https://huggingface.co/papers/2307.01952 的 2.2 节所述。有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。
• negative_target_size (Tuple[int], optional, defaults to (1024, 1024)) — 为了基于目标图像分辨率对生成过程进行负面条件控制。在大多数情况下，它应与 target_size 相同。SDXL 微条件控制的一部分，如 https://huggingface.co/papers/2307.01952 的 2.2 节所述。有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。
• callback_on_step_end (Callable, optional) — 一个函数，在推理期间的每个去噪步骤结束时调用。该函数使用以下参数调用：callback_on_step_end(self: DiffusionPipeline, step: int, timestep: int, callback_kwargs: Dict)。callback_kwargs 将包含由 callback_on_step_end_tensor_inputs 指定的所有张量列表。
• callback_on_step_end_tensor_inputs (List, optional) — callback_on_step_end 函数的张量输入列表。列表中指定的张量将作为 callback_kwargs 参数传递。您将只能包含在管道类的 ._callback_tensor_inputs 属性中列出的变量。
• profiling_warmup_steps (int, optional) — 进行性能分析时要忽略的步数。
• profiling_steps (int, optional) — 启用性能分析时要捕获的步数。

#如果 return_dict 为 True，则为 ~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput，否则为 GaudiStableDiffusionXLPipelineOutput 或 tuple：如果 return_dict 为 True，则为 GaudiStableDiffusionXLPipelineOutput，否则为 tuple。当返回元组时，第一个元素是包含生成图像的列表。

参数

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

缩放后的输入样本。

参数

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

如果 return_dict 为 True，则返回 ~schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput，否则返回一个元组，其中第一个元素是 sample tensor。

参数

• timestep (float) — 扩散链中当前的离散步长。 可选地用于初始化在去噪计划中间开始的情况下的参数（例如，对于图像到图像)

参数

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

缩放后的输入样本。

参数

• model_output (torch.FloatTensor) — 来自学习的扩散模型的直接输出。
• timestep (float) — 扩散链中当前的离散步长。
• sample (torch.FloatTensor) — 由扩散过程创建的样本的当前实例。
• generator (torch.Generator, *可选*) — 随机数生成器。
• return_dict (bool) — 是否返回 ~schedulers.scheduling_euler_ancestral_discrete.EulerAncestralDiscreteSchedulerOutput 或元组。

如果 return_dict 为 True，则返回 ~schedulers.scheduling_euler_ancestral_discrete.EulerAncestralDiscreteSchedulerOutput，否则返回一个元组，其中第一个元素是 sample tensor。

参数

• prompt (str 或 List[str], 可选) — 用于引导图像生成的提示或提示列表。如果未定义，则必须改为传递 prompt_embeds。
• image (torch.FloatTensor, PIL.Image.Image, np.ndarray, List[torch.FloatTensor], List[PIL.Image.Image], 或 List[np.ndarray]) — Image 或张量，表示要放大的图像批次。
• num_inference_steps (int, 可选, 默认为 50) — 去噪步骤的数量。更多去噪步骤通常会带来更高质量的图像，但会牺牲更慢的推理速度。
• guidance_scale (float, 可选, 默认为 7.5) — 无分类器扩散引导 中定义的引导比例。 guidance_scale 定义为 Imagen Paper 的等式 2 中的 w。通过设置 guidance_scale > 1 启用引导比例。较高的引导比例鼓励生成与文本 prompt 紧密相关的图像，但通常以降低图像质量为代价。
• negative_prompt (str 或 List[str], 可选) — 不用于引导图像生成的提示或提示列表。如果未定义，则必须改为传递 negative_prompt_embeds。当不使用引导时忽略（即，如果 guidance_scale 小于 1 则忽略）。
• num_images_per_prompt (int, 可选, 默认为 1) — 每个提示要生成的图像数量。
• batch_size (int, 可选, 默认为 1) — 批次中的图像数量。
• eta (float, 可选, 默认为 0.0) — 对应于 DDIM 论文中的参数 eta (η)： https://arxiv.org/abs/2010.02502。仅适用于 schedulers.DDIMScheduler，对于其他调度器将被忽略。
• generator (torch.Generator 或 List[torch.Generator], 可选) — 用于使生成具有确定性的一个或多个 torch 生成器。
• latents (torch.FloatTensor, 可选) — 预生成的噪声潜在表示，从高斯分布中采样，用作图像生成的输入。可用于使用不同的提示调整相同的生成。如果未提供，将随机生成潜在张量。
• prompt_embeds (torch.FloatTensor, 可选) — 预生成的文本嵌入。可用于轻松调整文本输入，例如 提示权重。如果未提供，将从 prompt 输入参数生成文本嵌入。
• negative_prompt_embeds (torch.FloatTensor, optional) — 预生成的负面文本嵌入。 可以用于轻松调整文本输入，例如 提示词权重。 如果未提供，则将从 negative_prompt 输入参数生成 negative_prompt_embeds。
• output_type (str, optional, defaults to "pil") — 生成图像的输出格式。 在 PIL: PIL.Image.Image 或 np.array 之间选择。
• return_dict (bool, optional, defaults to True) — 是否返回 GaudiStableDiffusionPipelineOutput 而不是普通的元组。
• callback (Callable, optional) — 一个函数，它将在推理期间每 callback_steps 步调用一次。 该函数将被以下参数调用： callback(step: int, timestep: int, latents: torch.FloatTensor)。
• callback_steps (int, optional, defaults to 1) — callback 函数将被调用的频率。 如果未指定，则将在每个步骤调用回调。
• cross_attention_kwargs (dict, optional) — 一个 kwargs 字典，如果指定，则会传递给 AttentionProcessor，定义在 diffusers.cross_attention 下。
• clip_skip (int, optional) — 在计算提示词嵌入时，从 CLIP 跳过的层数。 值为 1 表示预最终层的输出将用于计算提示词嵌入。

GaudiStableDiffusionPipelineOutput 如果 return_dict 为 True，否则为 tuple。 当返回元组时，第一个元素是包含生成图像的列表，第二个元素是 bool 列表，表示根据 safety_checker，相应的生成图像是否可能代表“不适合工作场所观看” (nsfw) 内容。