Hugging Face的标志

Diffusers 文档

文本到图像

Hugging Face's logo
加入Hugging Face社区

并获取增强文档体验的权限

以开始使用

论文摘要如下：

通过将图像形成过程分解为一系列去噪自编码器的连续应用，扩散模型（DMs）在图像数据及其它方面的合成结果达到了目前最佳水平。此外，它们的公式允许通过一个引导机制来控制图像生成过程，无需重新训练。然而，由于这些模型通常直接在像素空间运行，强大DM的优化通常消耗成百上千的GPU天数，而由于顺序评估，推理成本高昂。为了在有限的计算资源上使DM训练保持其质量和灵活性，我们将它们应用于强大预训练自编码器的潜在空间。与先前工作不同，在这种表示上训练扩散模型首次实现了在复杂度降低和细节保留之间达到几乎最优点的可能，大大提高了视觉保真度。通过在模型架构中引入交叉注意力层，我们将扩散模型转变为用于通用条件输入（如文本或边界框）的强大且灵活的生成器，并且以卷积方式实现高分辨率合成。我们的潜在扩散模型（LDMs）在图像修复和其他各项任务上（包括无条件图像生成、语义场景合成和超分辨率）实现了新的尖端水平，同时与基于像素的DMs相比，显著降低了计算需求。代码可在以下链接找到：https://github.com/CompVis/latent-diffusion。

请务必查看稳定扩散提示部分，了解如何探索调度器速度和质量之间的权衡，以及如何高效地重用管道组件！

如果您有兴趣使用任务之一的官方检查点，请探索CompVis、Runway和Stability AI Hub组织！

StableDiffusionPipeline

class diffusers.StableDiffusionPipeline

< >

( vae: AutoencoderKL text_encoder: CLIPTextModel tokenizer: CLIPTokenizer unet: UNet2DConditionModel scheduler: KarrasDiffusionSchedulers safety_checker: StableDiffusionSafetyChecker feature_extractor: CLIPImageProcessor image_encoder: CLIPVisionModelWithProjection = None requires_safety_checker: bool = True )

参数

  • vae (AutoencoderKL) — 用于将图像编码和转换为潜在表示的变分自编码器（VAE）模型。
  • text_encoder (CLIPTextModel) — 冻结文本编码器（clip-vit-large-patch14）。
  • 分词器 (CLIPTokenizer) — 一种用于对文本进行分词的CLIPTokenizer。
  • UNet模型 (UNet2DConditionModel) — 用于去噪编码图像潜伏变量的UNet2DConditionModel。
  • 调度器 (SchedulerMixin) — 与unet结合使用的调度器，以去噪编码图像潜伏变量。可以是以下之一：DDIMScheduler、LMSDiscreteScheduler或PNDMScheduler。
  • 安全检查器 (StableDiffusionSafetyChecker) — 估计生成的图像是否可能被认为是 offensive 或有害的分类模块。请参考 模型卡片 了解有关模型潜在危害的更多详细信息。
  • 特征提取器 (CLIPImageProcessor) — 用于从生成的图像中提取特征的 CLIPImageProcessor；用作 安全检查器 的输入。

使用稳定扩散进行文本到图像生成。

此模型继承自 DiffusionPipeline。请参阅超类文档了解所有管道实现的通用方法（下载、保存、在特定设备上运行等）。

该管道还继承了以下加载方法

__call__

< >

( 提示 prompt: 联合 = None高度 height: 可选 = None宽度 width: 可选 = None推理步数 num_inference_steps: 整数 = 50时间步数 timesteps: 列表 = None标准差 sigmas: 列表 = None引导比例 guidance_scale: 浮点 = 7.5负面提示 negative_prompt: 联合 = None每个提示的图像数量 num_images_per_prompt: 可选 = 1eta: 浮点 = 0.0生成器 generator: 联合 = None潜在变量 latents: 可选 = None提示嵌入 prompt_embeds: 可选 = None负面提示嵌入 negative_prompt_embeds: 可选 = NoneIP适配器图像 ip_adapter_image: 联合 = NoneIP适配器图像嵌入 ip_adapter_image_embeds: 可选 = None输出类型 output_type: 可选 = 'pil'返回字典 return_dict: 布尔 = True交叉注意力参数 cross_attention_kwargs: 可选 = None引导重新缩放 guidance_rescale: 浮点 = 0.0跳过剪贴 clip_skip: 可选 = None步骤结束回调 callback_on_step_end: 联合 = None步骤结束回调张量输入 callback_on_step_end_tensor_inputs: 列表 = ['latents']**kwargs ) → StableDiffusionPipelineOutput 或 tuple

参数

  • 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参数的调度器，可自定义的去噪过程timesteps。如果未定义，将使用当num_inference_steps传递时的默认行为。必须按降序排列。
  • sigmas (List[float], 可选) — 对于支持在set_timesteps方法中使用sigmas参数的调度器，可自定义的去噪过程sigmas。如果未定义，将使用当num_inference_steps传递时的默认行为。
  • guidance_scale (float, 可选, 默认为7.5) — 较高的指导尺度值会促使模型生成与文本 prompt 紧密相关的图像，但会牺牲较低的图像质量。当 guidance_scale > 1 时启用指导尺度。
  • negative_prompt (str 或 str列表, 可选) — 指导不希望在图像生成中包含的提示。如果没有定义，则需要传递 negative_prompt_embeds。在没有使用指导（guidance_scale < 1）时忽略。
  • num_images_per_prompt (int, 可选, 默认为1) — 每个提示生成的图像数量。
  • eta (float, 可选, 默认值为 0.0) — 对应于 DDIM 论文中的参数 eta (η)。仅适用于 DDIMScheduler，在其他调度器中被忽略。
  • generator (torch.Generator 或 List[torch.Generator], 可选) — 使用 torch.Generator 来使生成过程具有确定性。
  • latents (torch.Tensor, 可选) — 从高斯分布中采样的预生成的噪声潜变量，用作图像生成的输入。可用于使用不同的提示调整相同的生成。如果未提供，使用提供的随机 generator 生成潜变量张量。
  • prompt_embeds (torch.Tensor, 可选) — 预生成的文本嵌入。可用于轻松调整文本输入（提示权重）。如果不提供，则从 prompt 输入参数生成文本嵌入。
  • negative_prompt_embeds (torch.Tensor, 可选) — 预生成的负文本嵌入。可用于轻松调整文本输入（提示权重）。如果不提供，则从 negative_prompt 输入参数生成。ip_adapter_image — (PipelineImageInput, 可选)：与 IP 适配器一起使用时的可选图像输入。
  • ip_adapter_image_embeds (torch.Tensor 列表，可选) — IP-Adapter 的预生成图像嵌入。它应该是一个与 IP-Adapters 数量相同的长度列表。每个元素应该是一个形状为 (batch_size, num_images, emb_dim) 的张量。它应该包含负图像嵌入，如果将 do_classifier_free_guidance 设置为 True。如果不提供，则从 ip_adapter_image 输入参数计算嵌入。
  • output_type (str, 可选, 默认为 "pil") — 生成的图像的输出格式。选择 PIL.Image 或 np.array。
  • return_dict (bool, 可选, 默认为 True) — 是否返回 StableDiffusionPipelineOutput 而不是普通元组。
  • cross_attention_kwargs (dict, 可选) — 一个kwargs字典，如果指定，则传递给self.processor中定义的AttentionProcessor。
  • 指南缩放 (float, 可选, 默认为 0.0) — 从《常见的扩散噪声调度和样本步骤存在缺陷》中获取的指南缩放系数。指南缩放系数应修复在使用零终端 SNR 时出现的过曝问题。
  • clip_skip (int, 可选) — 跳过的 CLIP 层数数，在计算提示嵌入时。值为 1 表示使用预最终层的输出计算提示嵌入。
  • callback_on_step_end (Callable, PipelineCallback, MultiPipelineCallbacks, 可选) — 在推理过程中的去噪步骤结束时调用的函数或 PipelineCallback 或 MultiPipelineCallbacks 的子类。它具有以下参数： 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 属性中列出的变量。

返回值

StableDiffusionPipelineOutput 或 元组

如果 return_dict 为 True，则返回 StableDiffusionPipelineOutput，否则返回一个 元组，其中第一个元素是包含生成的图像的列表，第二个元素是表示对应的生成图像是否包含“不适合工作场所”（nsfw）内容的 布尔值 列表。

对管道进行生成的调用函数。

示例

>>> import torch
>>> from diffusers import StableDiffusionPipeline

>>> pipe = StableDiffusionPipeline.from_pretrained("runwayml/stable-diffusion-v1-5", torch_dtype=torch.float16)
>>> pipe = pipe.to("cuda")

>>> prompt = "a photo of an astronaut riding a horse on mars"
>>> image = pipe(prompt).images[0]

启用注意力切片

< >

( slice_size: 联合 = 'auto' )

参数

  • slice_size (str 或 int, 可选，默认为 "auto") — 当为 "auto" 时，将输入到注意力头部的数据减半，因此注意力计算分为两步进行。如果为 "max"，则每次只运行一个片段来运行，从而节省最大内存量。如果提供了数字，则使用 attention_head_dim // slice_size 个片段。在这种情况下，attention_head_dim 必须是 slice_size 的倍数。

启用切片注意力计算。当此选项启用时，注意模块会将输入张量分割成多个片段，以分步计算注意力。对于超过一个的注意力头，将在每个头上顺序执行计算。这可以节省一些内存，但会稍微降低速度。

⚠️ 如果您已经使用 PyTorch 2.0 中的 scaled_dot_product_attention (SDPA) 或 xFormers，请不要启用注意力切片。这些注意力计算已经非常内存高效，因此您不需要启用此功能。如果使用 SDPA 或 xFormers 启用注意力切片，可能会导致严重减速！

示例

>>> import torch
>>> from diffusers import StableDiffusionPipeline

>>> pipe = StableDiffusionPipeline.from_pretrained(
...     "runwayml/stable-diffusion-v1-5",
...     torch_dtype=torch.float16,
...     use_safetensors=True,
... )

>>> prompt = "a photo of an astronaut riding a horse on mars"
>>> pipe.enable_attention_slicing()
>>> image = pipe(prompt).images[0]

disable_attention_slicing

< >

( )

禁用切片注意力计算。如果之前已经调用 enable_attention_slicing，则注意力计算将一次性完成。

enable_vae_slicing

< >

( )

启用 sliced VAE 解码。当此选项启用时，VAE 将将输入张量分割成多个切片以分步骤进行解码。这有助于节省一些内存并允许更大的批处理大小。

disable_vae_slicing

< >

( )

禁用 sliced VAE 解码。如果之前启用了 enable_vae_slicing，此方法将回到一步解码计算。

enable_xformers_memory_efficient_attention

< >

( attention_op: Optional = None )

参数

  • attention_op (Callable, 可选) — 覆盖默认的 None 操作符，用作 xFormers 中 memory_efficient_attention() 函数的 op 参数。

启用从 xFormers 的内存高效注意力。当此选项启用时，应该观察到较低的 GPU 内存使用率和推理过程中的潜在加速。训练过程中的加速不能保证。

⚠️ 当内存高效注意力和分片注意力都启用时，内存高效注意力优先。

示例

>>> import torch
>>> from diffusers import DiffusionPipeline
>>> from xformers.ops import MemoryEfficientAttentionFlashAttentionOp

>>> pipe = DiffusionPipeline.from_pretrained("stabilityai/stable-diffusion-2-1", torch_dtype=torch.float16)
>>> pipe = pipe.to("cuda")
>>> pipe.enable_xformers_memory_efficient_attention(attention_op=MemoryEfficientAttentionFlashAttentionOp)
>>> # Workaround for not accepting attention shape using VAE for Flash Attention
>>> pipe.vae.enable_xformers_memory_efficient_attention(attention_op=None)

disable_xformers_memory_efficient_attention

< >

( )

禁用从 xFormers 的内存高效注意力。

enable_vae_tiling

< >

( )

启用瓦片 VAE 解码。当此选项启用时，VAE 会将输入张量分割成瓦片，分多步进行解码和编码。这对于节省大量内存并允许处理更大的图像非常有用。

disable_vae_tiling

< >

( )

禁用瓦片化VAE解码。如果之前启用了enable_vae_tiling，此方法将回退到一步计算解码。

load_textual_inversion

< >

( pretrained_model_name_or_path: Union token: Union = None tokenizer: Optional = None text_encoder: Optional = None **kwargs )

参数

  • 预训练模型或路径名（字符串、os.PathLike或str或List[str或os.PathLike]或字典或List[字典]） — 可以是以下之一或它们的列表：

    • 字符串，在Hub上托管的预训练模型ID（例如 sd-concepts-library/low-poly-hd-logos-icons）。
    • 包含文本逆变换权重的目录路径（例如 ./my_text_inversion_directory/）。
    • 包含文本逆变换权重的文件路径（例如 ./my_text_inversions.pt）。
    • torch状态字典。
  • token（字符串或字符串列表，可选） — 用于文本逆变换权重的令牌。如果 pretrained_model_name_or_path 是列表，则 token 也必须是相同长度的列表。
  • text_encoder（可选） — 冻结的文字编码器（CLIPTextModel，例如 clip-vit-large-patch14）。如果不指定，则函数将采用self.tokenizer。
  • tokenizer (CLIPTokenizer, 可选) — 用于标记文本的 CLIPTokenizer。如果没有指定，函数将使用 self.tokenizer。
  • weight_name (str, 可选) — 自定义权重文件的名称。应在以下情况下使用：

    • 保存的文本反转文件是 🤗 Diffusers 格式，但以特定的权重名称保存，例如 text_inv.bin。
    • 保存的文本反转文件是 Automatic1111 格式。
  • cache_dir (Union[str, os.PathLike], 可选) — 如果不使用标准缓存，则用于下载预训练模型配置的缓存目录的路径。
  • force_download (bool, 可选，默认值为 False) — 是否强制，（重新）下载模型权重和配置文件，如果存在则覆盖缓存的版本。
  • proxies (Dict[str, str], 可选) — 使用协议或端点按代理服务器进行分组的字典，例如，{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。代理用于每个请求。
  • local_files_only (bool, 可选，默认值为 False) — 是否仅加载本地的模型权重和配置文件。如果设置为 True，则不会从 Hub 下载模型。
  • token (str 或 bool，可选) — 用于远程文件HTTP标头认证的令牌。如果 True，则使用从 diffusers-cli login 生成的令牌（存储在 ~/.huggingface 中）。
  • revision (str，可选，默认为 "main") — 要使用的特定模型版本。可以是分支名、标签名、提交id或Git允许的任何标识符。
  • subfolder (str，可选，默认为 "") — 模型文件在Hub或本地较大模型仓库中的子文件夹位置。
  • 镜像 (str，可选）— 将源镜像以解决在中国下载模型时可能出现的问题。我们不保证源的时间性或安全性，并建议参考镜像网站获取更多信息。

将Textual Inversion嵌入加载到《StableDiffusionPipeline》文本编码器中（支持🤗 Diffusers和Automatic1111格式）。

示例

以🤗 Diffusers格式加载Textual Inversion嵌入向量

from diffusers import StableDiffusionPipeline
import torch

model_id = "runwayml/stable-diffusion-v1-5"
pipe = StableDiffusionPipeline.from_pretrained(model_id, torch_dtype=torch.float16).to("cuda")

pipe.load_textual_inversion("sd-concepts-library/cat-toy")

prompt = "A <cat-toy> backpack"

image = pipe(prompt, num_inference_steps=50).images[0]
image.save("cat-backpack.png")

以Automatic1111格式加载Textual Inversion嵌入向量，请先下载向量（例如从civitAI）然后本地加载

该向量

from diffusers import StableDiffusionPipeline
import torch

model_id = "runwayml/stable-diffusion-v1-5"
pipe = StableDiffusionPipeline.from_pretrained(model_id, torch_dtype=torch.float16).to("cuda")

pipe.load_textual_inversion("./charturnerv2.pt", token="charturnerv2")

prompt = "charturnerv2, multiple views of the same character in the same outfit, a character turnaround of a woman wearing a black jacket and red shirt, best quality, intricate details."

image = pipe(prompt, num_inference_steps=50).images[0]
image.save("character.png")

from_single_file

( pretrained_model_link_or_path **kwargs )

参数

  • pretrained_model_link_or_path (str 或 os.PathLike，可选) — 可以是：
  • torch_dtype (str 或 torch.dtype，可选) — 覆盖默认的 torch.dtype 并以另一种数据类型加载模型。
  • force_download (bool，可选，默认为 False) — 是否强制重新下载模型权重和配置文件，如果存在则覆盖缓存版本。
  • cache_dir (Union[str, os.PathLike], 可选) — 如果不使用标准缓存，则用于存储下载的预训练模型配置文件的目录。
  • proxies (Dict[str, str], 可选) — 根据协议或端点使用的代理服务器字典，例如，{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。代理会在每个请求中使用。
  • local_files_only (bool, 可选, 默认为 False) — 是否仅加载本地模型权重和配置文件。如果设置为 True，则模型将不会从Hub下载。
  • token (str 或 bool，可选) — 用于远程文件HTTP载体授权的令牌。如果为 True，则使用由 diffusers-cli login 生成的令牌（存储在 ~/.huggingface 中）。
  • revision (str，可选，默认为 "main") — 要使用的特定模型版本。它可以是分支名称、标签名称、提交ID或Git允许的任何标识符。
  • original_config_file (str，可选) — 用于训练模型的原始配置文件的路径。如果没有提供，将根据检查点文件推断配置文件。
  • config (str, 可选) — 可以是：

    • 一个字符串，Hub 上托管的一个预训练管道的 repo id （例如 CompVis/ldm-text2im-large-256）。
    • 一个 目录路径 （例如 ./my_pipeline_directory/），其中包含 Diffusers 格式的管道组件配置文件。
  • kwargs （剩余的关键字参数字典，可选） — 可以用来覆盖加载和可保存变量（特定管道类的管道组件）。被覆盖的组件直接传递给管道的 __init__ 方法。更多信息请见下方示例。

从以 .ckpt 或 .safetensors 格式保存的预训练权重加载一个 DiffusionPipeline。默认情况下，管道被设置为评估模式（model.eval()）。

示例

>>> from diffusers import StableDiffusionPipeline

>>> # Download pipeline from huggingface.co and cache.
>>> pipeline = StableDiffusionPipeline.from_single_file(
...     "https://huggingface.co/WarriorMama777/OrangeMixs/blob/main/Models/AbyssOrangeMix/AbyssOrangeMix.safetensors"
... )

>>> # Download pipeline from local file
>>> # file is downloaded under ./v1-5-pruned-emaonly.ckpt
>>> pipeline = StableDiffusionPipeline.from_single_file("./v1-5-pruned-emaonly.ckpt")

>>> # Enable float16 and move to GPU
>>> pipeline = StableDiffusionPipeline.from_single_file(
...     "https://huggingface.co/runwayml/stable-diffusion-v1-5/blob/main/v1-5-pruned-emaonly.ckpt",
...     torch_dtype=torch.float16,
... )
>>> pipeline.to("cuda")

load_lora_weights

< >

( pretrained_model_name_or_path_or_dict: 联合类型 adapter_name = None **kwargs )

参数

  • pretrained_model_name_or_path_or_dict (str 或 os.PathLike 或 dict) — 请参阅 lora_state_dict().
  • kwargs (dict, 可选) — 请参阅 lora_state_dict().
  • adapter_name (str, 可选) — 用于引用已加载的适配器模型的适配器名称。如果未指定，将使用 default_{i}，其中 i 是正在加载的适配器的总数。

将指定在 pretrained_model_name_or_path_or_dict 中的 LoRA 权重加载到 self.unet 和 self.text_encoder。

所有关键字参数都传递给 self.lora_state_dict。

有关加载状态字典的更多详细信息，请参阅 lora_state_dict()。

有关将状态字典加载到 self.unet 的更多详细信息，请参阅 load_lora_into_unet()。

有关将状态字典加载到 self.text_encoder 的更多详细信息，请参阅 load_lora_into_text_encoder()。

save_lora_weights

< >

( save_directory: Union unet_lora_layers: Dict = None text_encoder_lora_layers: Dict = None is_main_process: bool = True weight_name: str = None save_function: Callable = None safe_serialization: bool = True )

参数

  • save_directory (str 或 os.PathLike) — 保存LoRA参数的目录。如果不存在，则将创建它。
  • unet_lora_layers (Dict[str, torch.nn.Module]或Dict[str, torch.Tensor]) — 对应于unet的LoRA层的状态字典。
  • text_encoder_lora_layers (Dict[str, torch.nn.Module]或Dict[str, torch.Tensor]) — 对应于text_encoder的LoRA层的状态字典。由于它来自🤗 Transformers，必须明确传递文本编码器的LoRA状态字典。
  • is_main_process (bool，可选，默认为True）— 调用此方法的进程是否为主进程。在分布式训练期间很有用，你需要在此函数上调用所有进程。在这种情况下，仅在主进程中设置is_main_process=True以避免竞争条件。

保存与 UNet 和文本编码器对应的 LoRA 参数。

encode_prompt

( 提示 设备 每提示图片数量 是否启用分类器自由指导 负提示 = None 提示嵌入: 可选 = None 负提示嵌入: 可选 = None LoRA缩放: 可选 = None clip_skip: 可选 = None )

参数

  • 提示 (str 或 List[str]，可选) —— 要编码的提示
  • 每提示图片数量 (int) —— 每个提示应生成的图片数量
  • do_classifier_free_guidance (bool) — 是否使用无分类器指导
  • negative_prompt (str 或 List[str], 可选) — 不用来指导图像生成的提示或提示列表。如果未定义，则必须传递 negative_prompt_embeds。在不使用指导时忽略（即，当 guidance_scale 小于 1 时忽略）。
  • prompt_embeds (torch.Tensor, 可选) — 预生成的文本嵌入。可以用来轻松调整文本输入，例如提示权重。如果未提供，则将从 prompt 输入参数生成文本嵌入。
  • negative_prompt_embeds (torch.Tensor，可选）——预先生成的负文本嵌入。可用于轻松调整文本输入，例如调整提示权重。如果不提供，则从negative_prompt输入参数生成负提示嵌入。
  • lora_scale (float，可选）——应用于加载的LoRA层的LoRA缩放比例。
  • clip_skip (int，可选）——在计算提示嵌入时跳过的CLIP层数。1的值表示将使用预终层输出计算提示嵌入。

将提示编码为文本编码器的隐藏状态。

get_guidance_scale_embedding

< >

( w: Tensor embedding_dim: int = 512 dtype: dtype = torch.float32 ) → torch.Tensor

参数

  • w (torch.Tensor) — 使用指定的引导尺度生成嵌入向量，以随后丰富时间步嵌入
  • embedding_dim (int, 可选, 默认为 512) — 生成嵌入的维度
  • dtype (torch.dtype, 可选, 默认为 torch.float32) — 生成的嵌入数据的类型。

返回值

torch.Tensor

形状为 (len(w), embedding_dim) 的嵌入向量。

见 https://github.com/google-research/vdm/blob/dc27b98a554f65cdc654b800da5aa1846545d41b/model_vdm.py#L298

StableDiffusionPipelineOutput

类 diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput

< >

( images: Union nsfw_content_detected: Optional )

参数

  • images （List[PIL.Image.Image] 或 np.ndarray） — 长度为 batch_size 的去噪 PIL 图像列表或形状为 (batch_size, height, width, num_channels) 的 NumPy 数组。
  • nsfw_content_detected（《List[bool]》）— 指示相应生成的图像是否包含“不适宜工作环境” (nsfw) 内容的列表，或在无法执行安全性检查时为 None。

Stable Diffusion 管道输出的类。

FlaxStableDiffusionPipeline

类 diffusers.FlaxStableDiffusionPipeline

< >

( vae: FlaxAutoencoderKL text_encoder: FlaxCLIPTextModel tokenizer: CLIPTokenizer unet: FlaxUNet2DConditionModel scheduler: Union safety_checker: FlaxStableDiffusionSafetyChecker feature_extractor: CLIPImageProcessor dtype: dtype = <class 'jax.numpy.float32'> )

参数

  • vae (FlaxAutoencoderKL) — 变分自编码器 (VAE) 模型，用于将图像编码和解码为潜在表示。
  • text_encoder （FlaxCLIPTextModel）— 冻结文本编码器 （clip-vit-large-patch14）。
  • tokenizer （CLIPTokenizer）— 用于文本分词的 CLIPTokenizer。
  • unet （FlaxUNet2DConditionModel）— 用于降噪编码图像潜变量的 FlaxUNet2DConditionModel。
  • 调度器 (SchedulerMixin) — 与 unet 结合使用以去噪编码图像潜在的调度器。可以是 FlaxDDIMScheduler、FlaxLMSDiscreteScheduler、FlaxPNDMScheduler 或 FlaxDPMSolverMultistepScheduler 之一。
  • 安全检查器 (FlaxStableDiffusionSafetyChecker) — 估计生成图像是否可能被认为是冒犯性或有害的分类模块。请参阅 模型卡片 以了解有关模型潜在危害的更多详细信息。
  • 特征提取器 (CLIPImageProcessor) — 从生成图像中提取特征的 CLIPImageProcessor；用作 safety_checker 的输入。

基于Flax的文本到图像生成稳定扩散的流程。

此模型继承自 FlaxDiffusionPipeline。请参阅超类文档，了解所有流程实现的通用方法（下载、保存、在特定设备上运行等）。

__call__

< >

( prompt_ids: 数组 params: 联合 prng_seed: 数组 num_inference_steps: int = 50 height: Optional = None width: Optional = None guidance_scale: 联合 = 7.5 latents: 数组 = None neg_prompt_ids: 数组 = None return_dict: bool = True jit: bool = False ) → FlaxStableDiffusionPipelineOutput or tuple

参数

  • prompt (字符串 或 字符串列表，可选) — 指导图像生成的提示或提示列表。
  • 高度 (int, 可选, 默认值为 self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的像素高度。
  • 宽度 (int, 可选, 默认值为 self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的像素宽度。
  • num_inference_steps (int, 可选, 默认值为 50) — 去噪步骤的数量。更多的去噪步骤通常会导致图像质量更高，但推理速度会更慢。
  • guidance_scale (float, 可选, 默认为 7.5) — 较高的指导尺度值会鼓励模型生成与文本 prompt 紧密相关的图像，但代价是图像质量降低。当 guidance_scale > 1 时，指导尺度被启用。
  • latents (jnp.ndarray, 可选) — 用于图像生成的预生成的噪声潜值，从高斯分布中采样，作为输入。可用于使用不同的提示调整相同的生成。如果没有提供，将使用提供的随机 generator 生成一个潜值数组。
  • jit (bool, 默认为 False) — 是否运行 pmap 版本的生成和安全性评分函数。

    这个参数存在是因为 __call__ 还不支持端到端 pmap。它将在未来的版本中移除。
  • return_dict (bool, optional, 默认为 True) — 是否返回一个 FlaxStableDiffusionPipelineOutput 而不是普通的元组。

返回值

FlaxStableDiffusionPipelineOutput 或 tuple

如果 return_dict 为 True，则返回 FlaxStableDiffusionPipelineOutput，否则返回包含生成的图像列表（第一个元素）和一个表示相应生成的图像是否包含“不适宜工作环境”内容（nsfw）的布尔值列表的元组。

对管道进行生成的调用函数。

示例

>>> import jax
>>> import numpy as np
>>> from flax.jax_utils import replicate
>>> from flax.training.common_utils import shard

>>> from diffusers import FlaxStableDiffusionPipeline

>>> pipeline, params = FlaxStableDiffusionPipeline.from_pretrained(
...     "runwayml/stable-diffusion-v1-5", variant="bf16", dtype=jax.numpy.bfloat16
... )

>>> prompt = "a photo of an astronaut riding a horse on mars"

>>> prng_seed = jax.random.PRNGKey(0)
>>> num_inference_steps = 50

>>> num_samples = jax.device_count()
>>> prompt = num_samples * [prompt]
>>> prompt_ids = pipeline.prepare_inputs(prompt)
# shard inputs and rng

>>> params = replicate(params)
>>> prng_seed = jax.random.split(prng_seed, jax.device_count())
>>> prompt_ids = shard(prompt_ids)

>>> images = pipeline(prompt_ids, params, prng_seed, num_inference_steps, jit=True).images
>>> images = pipeline.numpy_to_pil(np.asarray(images.reshape((num_samples,) + images.shape[-3:])))

FlaxStableDiffusionPipelineOutput

class diffusers.pipelines.stable_diffusion.FlaxStableDiffusionPipelineOutput

< >

( images: ndarray nsfw_content_detected: List )

参数

  • images (np.ndarray) — 数组的去噪图像，形状为 (batch_size, height, width, num_channels)。
  • nsfw_content_detected (List[bool]) — 指示相应生成的图像是否包含“不适宜工作环境”内容的列表，或者在无法进行安全检查时的 None。

基于Flax的Stable Diffusion管道的输出类。

replace

< >

( **updates )

“返回一个新对象，用新的值替换指定的字段。”

< > 更新于GitHub

←概述 图像到图像→