参数

• prompt (str 或 List[str], 可选) —— 指导图像生成的提示或提示列表。如果未定义，您需要传入 prompt_embeds。
• height (int, 可选，默认为 self.unet.config.sample_size * self.vae_scale_factor) —— 生成的图像的像素高度。
• width (int, 可选，默认为 self.unet.config.sample_size * self.vae_scale_factor) — 生成的图像的像素宽度。
• num_inference_steps (int, 可选，默认为 50) — 降噪步骤的数量。更多的降噪步骤通常会导致图像质量更高，但推理速度会变慢。
• timesteps (List[int], 可选) — 使用支持在 set_timesteps 方法中带有 timesteps 参数的调度器的自定义时间步骤进行降噪过程。如果未定义，则当传递 num_inference_steps 时将使用默认行为。必须按降序排列。
• guidance_scale (float，可选，默认值为7.5) — 较高指导比例值会鼓励模型在牺牲图像质量的情况下，生成与文本prompt紧密相关的图像。当guidance_scale > 1时，指导比例被启用。
• 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 论文中的参数 η (η)。仅适用于 ~schedulers.DDIMScheduler，在其他调度器中被忽略。
• generator (torch.Generator 或 List[torch.Generator], 可选) — 一个 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，可选，默认为 "pil"） — 生成图像的输出格式。可选择 PIL.Image 或 np.array。
• return_dict （bool，可选，默认为 True） — 是否返回 GaudiStableDiffusionPipelineOutput 而不是纯元组。
• cross_attention_kwargs （dict，可选） — 一个 kwargs 字典，如果指定，会传递给 AttentionProcessor 如在 self.processor 中定义的那样。
• guidance_rescale （float，可选，默认为0.0）——来自常见的扩散噪声调度和采样步骤是错误的的引导缩放因子。引导缩放因子应修复使用零终端SNR时的过度曝光。
• clip_skip （int，可选）——在计算提示嵌入时跳过的CLIP层的数量。值为1表示将使用预最终层的输出计算提示嵌入。
• callback_on_step_end （Callable，可选）——在每个推理步骤的降噪步骤结束时被调用的函数。该函数使用以下参数调用：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 (列表, 可选) — 为 callback_on_step_end 函数提供的张量输入列表。列出的张量将通过 callback_kwargs 参数传递。您只能包含您管道类 ._callback_tensor_inputs 属性中列出的变量。
• profiling_warmup_steps (整数, 可选) — 忽略以进行性能分析的步骤数。
• profiling_steps (整数, 可选) — 启用性能分析时要捕获的步骤数。

如果 return_dict 为 True，则返回 ~diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput，否则返回一个 元组，其中第一个元素是包含生成的图像的列表，第二个元素是一个指示对应生成的图像是否包含“不适宜工作环境”内容的布尔值列表。

参数

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

参数

• timestep (int, 可选) — 扩散链中的当前离散时间步。可选用于初始化参数，例如在去噪过程中从图像生成图像时开始。

参数

• model_output (torch.FloatTensor) — 从学习的扩散模型直接输出的内容。
• sample (torch.FloatTensor) — 由扩散过程创建的当前样本实例。
• eta (float) — 扩散步骤中添加噪声的噪声权重。
• use_clipped_model_output (bool, 默认为 False) — 如果为 True，则从剪切的预测原始样本计算“修正”的 model_output。这是必要的，因为当 self.config.clip_sample 为 True 时，预测原始样本会被剪切成 [-1, 1]。如果没有发生剪裁，则“修正”的 model_output 将与作为输入提供的那个相同，并且 use_clipped_model_output 不会产生任何效果。
• generator (torch.Generator, 可选) — 随机数生成器。
• variance_noise (torch.FloatTensor) — 相对于使用 generator 生成噪声，直接提供噪声 Variance 的噪声。对于例如 CycleDiffusion 方法很有用。
• return_dict (bool, 可选, 默认为 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 像素以获得最佳结果。小于 512 像素的内容通常不适用于 stabilityai/stable-diffusion-xl-base-1.0 以及未在低分辨率上专门微调的检查点。
• width （int，可选项，默认为 self.unet.config.sample_size * self.vae_scale_factor）— 生成的图像的像素宽度。默认设置为 1024 像素以获得最佳结果。小于 512 像素的内容通常不适用于 stabilityai/stable-diffusion-xl-base-1.0 以及未在低分辨率上专门微调的检查点。
• num_inference_steps （int，可选，默认为50） — 隔噪步数。更多的隔噪步骤通常会换来图像质量更高的结果，但推理速度会相应的变慢。
• timesteps （List[int]，可选） — 为支持在 其 set_timesteps 方法中加入 timesteps 参数的调度器使用的自定义时间步。如果没有定义，当传递 num_inference_steps 时将使用默认行为。必须按照降序排列。
• denoising_end （float，可选） — 当指定时，确定总隔噪过程完成前要完成的比例（在 0.0 和 1.0 之间）。结果，返回的样本还将保留大量的噪声，这些噪声由调度器选择的离散时间步确定。理想情况下，当此流水线是“混合隔噪器”多流水线设置的一部分时，应使用 denoising_end 参数，如优化图像输出中所述。
• guidance_scale (float，可选，默认为 5.0) — 指导尺度，在无分类扩散指导中定义。 guidance_scale 是《Imagen 文章》第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, 可选, 默认为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，可选）—预先生成的有噪声的潜能，从高斯分布中采样，用作图像生成的输入。可用于通过不同的提示调整相同的生成。如果没有提供，将使用提供的随机generator生成潜力的张量。
• prompt_embeds （torch.FloatTensor，可选）—预先生成的文本嵌入。可用于轻松调整文本输入，例如提示加权。如果没有提供，将从prompt输入参数生成文本嵌入。
• negative_prompt_embeds （torch.FloatTensor，可选）—预先生成的负文本嵌入。可用于轻松调整文本输入，例如提示加权。如果没有提供，将从negative_prompt输入参数生成负嵌入。
• pooled_prompt_embeds (torch.FloatTensor, 可选) — 预生成的文本集合嵌入。可用于轻松调整文本输入，例如提示加权。如果没有提供，将根据 prompt 输入参数生成文本集合嵌入。
• negative_pooled_prompt_embeds (torch.FloatTensor, 可选) — 预生成的负文本集合嵌入。可用于轻松调整文本输入，例如提示加权。如果没有提供，将根据 negative_prompt 输入参数生成负文本集合嵌入。
• output_type (str, 可选，默认为 "pil") — 生成图像的输出格式。选择 PIL: PIL.Image.Image 或 np.array。
• return_dict (bool, 可选, 默认为 True) — 是否返回/plain tuple。
• 交叉注意力参数 (dict, 可选) — 如果指定，将传递给 AttentionProcessor，如定义在 diffusers.models.attention_processor 中的 self.processor。
• 引导缩放因子 (float, 可选, 默认为 0.0) — 根据 Common Diffusion Noise Schedules and Sample Steps are Flawed 提出的引导缩放因子，guidance_scale 定义为公式的 φ。该缩放因子可以解决使用零终端 SNR 时的过曝问题。
• original_size (Tuple[int], 可选，默认为 (1024, 1024)) — 如果 original_size 和 target_size 不一样，图像将看起来是下采样或上采样。如果未指定，则默认为 (高度, 宽度)。这是 SDXL 的微条件部分，如第 2.2 节所述 https://huggingface.co/papers/2307.01952。
• crops_coords_top_left (Tuple[int], 可选, 默认为 (0, 0)) — crops_coords_top_left 可以用于从 crops_coords_top_left 位置向下裁剪图像。通常通过将 crops_coords_top_left 设置为 (0, 0) 来实现居中的、良好的图像。这是 SDXL 的微条件部分，如第 2.2 节所述 https://huggingface.co/papers/2307.01952。
• target_size (Tuple[int], 可选, 默认为 (1024, 1024)) — 对于大多数情况，应将 target_size 设置为生成的图像所需的宽度和高度。如果未指定，则默认为 (高度, 宽度)。这是 SDXL 的微条件部分，如第 2.2 节所述 https://huggingface.co/papers/2307.01952。
• negative_target_size (元组[int], 可选, 默认为 (1024, 1024)) — 基于目标图像分辨率对生成过程进行负条件设置。对于大多数情况，应与 target_size 相同。SDXL 微条件设置的一部分，如第 2.2 节所述https://huggingface.co/papers/2307.01952。更多信息，请参阅此问题线程：https://github.com/huggingface/diffusers/issues/4208。
• callback_on_step_end (可调用, 可选) — 一个在每个推理的分步解噪结束时被调用的函数。该函数使用以下参数调用：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 (列表, 可选) — 用于 callback_on_step_end 函数的张量输入列表。列表中指定的张量将作为 callback_kwargs 参数传递。您只能包括管道类 `. _ callback_tensor_inputs` 属性中列出的变量。
• profiling_warmup_steps （int，可选） — 忽略分析时要忽略的步数。
• profiling_steps （int，可选） — 启用分析时要捕获的步数。

#~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput 如果 return_dict 为 True，否则为 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，否则返回元组，其中第一个元素是样本张量。

参数

• 时间步长 (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，否则返回一个元组，其中第一个元素是样本张量。

参数

• 提示 (str or List[str], 可选) — 指导图像生成的提示。如果未定义，必须传递 prompt_embeds。代替。
• image (torch.FloatTensor, PIL.Image.Image, np.ndarray, List[torch.FloatTensor], List[PIL.Image.Image], or List[np.ndarray]) — 要升采样图像的 Image 或张量。
• num_inference_steps (int, 可选, 默认为 50) — 缩放步骤的数量。更多的去噪步骤通常会以速度为代价提高图像质量。
• guidance_scale (float, 可选, 默认为 7.5) — 指导比例，如《无分类器扩散指导》中定义。`guidance_scale` 定义为《instancen paper》中的 2 公式中的 `w`。启用指导比例需要设置 `guidance_scale > 1`。较高的指导比例鼓励生成与文本 `prompt` 密切相关的图像，通常以降低图像质量为代价。
• eta (float, 可选, 默认为 0.0) — 对应 DDIM 论文中参数 eta (η)：https://arxiv.org/abs/2010.02502。仅适用于 schedulers.DDIMScheduler，其他将被忽略。
• generator (torch.Generator 或 List[torch.Generator], 可选) — 一个或多个 torch 生成器，用于使生成过程确定性。
• latents (torch.FloatTensor, 可选) — 预生成的噪声 latents，从高斯分布中采样，用作图像生成的输入。可用于使用不同的提示调整相同的生成。如果未提供，将随机生成 latents 张量。
• prompt_embeds （torch.FloatTensor，可选） — 预生成的文本嵌入。可用于轻松调整文本输入，例如提示权重。如果不提供，将根据 prompt 输入参数生成文本嵌入。
• negative_prompt_embeds （torch.FloatTensor，可选） — 预生成的负面文本嵌入。可用于轻松调整文本输入，例如提示权重。如果不提供，将从 negative_prompt 输入参数生成负面文本嵌入。
• output_type （str，可选，默认为 "pil"） — 生成的图像的输出格式。可选择 PIL：PIL.Image.Image 或 np.array。
• return_dict (bool, 选填，默认为 True) — 是否返回 GaudiStableDiffusionPipelineOutput 而非纯元组。
• callback (Callable, 选填) — 每个推断阶段执行 callback_steps 步时调用的函数。函数将使用以下参数调用： callback(step: int, timestep: int, latents: torch.FloatTensor)。
• callback_steps (int, 选填，默认为 1) — callback 函数被调用的频率。如果没有指定，该回调将在每个步骤中调用。
• cross_attention_kwargs (dict, 可选) —— 如果指定，则传递给 AttentionProcessor 的 kwargs 字典，如 self.processor 中定义的那样，位于diffusers.cross_attention 下。
• clip_skip (int, 可选) —— 在计算提示嵌入时跳过的 CLIP 层数的数量。1 的值表示将使用预终层的输出计算提示嵌入。

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