Hugging Face's logo

Diffusers 文档

ControlNet-XS 与 Stable Diffusion XL

Hugging Face's logo
加入 Hugging Face 社区

并获取增强的文档体验

开始使用

ControlNet-XS 与 Stable Diffusion XL

ControlNet-XS 由 Denis Zavadski 和 Carsten Rother 在 ControlNet-XS 中提出。它基于以下观察：原始 ControlNet 中的控制模型可以做得更小，并且仍然产生良好的结果。

与原始 ControlNet 模型类似，您可以提供额外的控制图像来调节和控制 Stable Diffusion 生成。例如，如果您提供深度图，ControlNet 模型将生成一个保留深度图空间信息的图像。这是一种更灵活、更准确的控制图像生成过程的方法。

ControlNet-XS 生成的图像质量与常规 ControlNet 相当，但速度快 20-25%（参见基准测试），并且内存使用量减少约 45%。

以下是来自项目页面的概述

随着计算能力的提高，当前的模型架构似乎遵循简单地放大所有组件的趋势，而没有验证这样做的必要性。在这个项目中，我们研究了 ControlNet [Zhang et al., 2023] 的大小和架构设计，以使用基于 stable diffusion 的模型控制图像生成过程。我们表明，参数仅为基础模型 1% 的新架构实现了最先进的结果，在 FID 分数方面明显优于 ControlNet。因此，我们称之为 ControlNet-XS。我们提供了用于控制 StableDiffusion-XL [Podell et al., 2023]（模型 B，48M 参数）和 StableDiffusion 2.1 [Rombach et al. 2022]（模型 B，14M 参数）的代码，所有这些都在 openrail 许可下。

此模型由 UmerHA 贡献。❤️

🧪 许多 SDXL ControlNet 检查点都是实验性的，并且有很大的改进空间。欢迎提出 Issue 并向我们提供关于如何改进的反馈！

请务必查看调度器 指南，了解如何探索调度器速度和质量之间的权衡，并参阅跨 pipelines 重用组件部分，了解如何有效地将相同组件加载到多个 pipelines 中。

StableDiffusionXLControlNetXSPipeline

class diffusers.StableDiffusionXLControlNetXSPipeline

< >

( vae: AutoencoderKL text_encoder: CLIPTextModel text_encoder_2: CLIPTextModelWithProjection tokenizer: CLIPTokenizer tokenizer_2: CLIPTokenizer unet: typing.Union[diffusers.models.unets.unet_2d_condition.UNet2DConditionModel, diffusers.models.controlnets.controlnet_xs.UNetControlNetXSModel] controlnet: ControlNetXSAdapter scheduler: KarrasDiffusionSchedulers force_zeros_for_empty_prompt: bool = True add_watermarker: typing.Optional[bool] = None feature_extractor: CLIPImageProcessor = None )

参数

  • vae (AutoencoderKL) — 变分自动编码器 (VAE) 模型，用于将图像编码和解码为潜在表示形式。
  • text_encoder (CLIPTextModel) — 冻结的文本编码器 (clip-vit-large-patch14)。
  • text_encoder_2 (CLIPTextModelWithProjection) — 第二个冻结的文本编码器 (laion/CLIP-ViT-bigG-14-laion2B-39B-b160k)。
  • tokenizer (CLIPTokenizer) — 一个 CLIPTokenizer，用于文本分词。
  • tokenizer_2 (CLIPTokenizer) — 一个 CLIPTokenizer，用于文本分词。
  • unet (UNet2DConditionModel) — 一个 UNet2DConditionModel，用于创建 `UNetControlNetXSModel`，以对编码后的图像潜在信息进行去噪。
  • controlnet (ControlNetXSAdapter) — 一个 ControlNetXSAdapter，与 `unet` 结合使用，以对编码后的图像潜在信息进行去噪。
  • scheduler (SchedulerMixin) — 一个调度器，与 `unet` 结合使用，以对编码后的图像潜在信息进行去噪。可以是 DDIMScheduler、LMSDiscreteScheduler 或 PNDMScheduler 之一。
  • force_zeros_for_empty_prompt (bool, optional, defaults to "True") — 负面提示嵌入是否应始终设置为 0。另请参阅 stabilityai/stable-diffusion-xl-base-1-0 的配置。
  • add_watermarker (bool, optional) — 是否使用 `invisible_watermark` 库为输出图像添加水印。如果未定义，则当软件包已安装时，默认值为 `True`；否则不使用水印。

使用 ControlNet-XS 指导的 Stable Diffusion XL 文本到图像生成管线。

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

此管线还继承了以下加载方法

__call__

< >

( prompt: typing.Union[str, typing.List[str]] = None prompt_2: typing.Union[str, typing.List[str], NoneType] = None image: typing.Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, typing.List[PIL.Image.Image], typing.List[numpy.ndarray], typing.List[torch.Tensor]] = None height: typing.Optional[int] = None width: typing.Optional[int] = None num_inference_steps: int = 50 guidance_scale: float = 5.0 negative_prompt: typing.Union[str, typing.List[str], NoneType] = None negative_prompt_2: typing.Union[str, typing.List[str], NoneType] = None num_images_per_prompt: typing.Optional[int] = 1 eta: float = 0.0 generator: typing.Union[torch._C.Generator, typing.List[torch._C.Generator], NoneType] = None latents: typing.Optional[torch.Tensor] = None prompt_embeds: typing.Optional[torch.Tensor] = None negative_prompt_embeds: typing.Optional[torch.Tensor] = None pooled_prompt_embeds: typing.Optional[torch.Tensor] = None negative_pooled_prompt_embeds: typing.Optional[torch.Tensor] = None output_type: typing.Optional[str] = 'pil' return_dict: bool = True cross_attention_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None controlnet_conditioning_scale: typing.Union[float, typing.List[float]] = 1.0 control_guidance_start: float = 0.0 control_guidance_end: float = 1.0 original_size: typing.Tuple[int, int] = None crops_coords_top_left: typing.Tuple[int, int] = (0, 0) target_size: typing.Tuple[int, int] = None negative_original_size: typing.Optional[typing.Tuple[int, int]] = None negative_crops_coords_top_left: typing.Tuple[int, int] = (0, 0) negative_target_size: typing.Optional[typing.Tuple[int, int]] = None clip_skip: typing.Optional[int] = None callback_on_step_end: typing.Union[typing.Callable[[int, int, typing.Dict], NoneType], diffusers.callbacks.PipelineCallback, diffusers.callbacks.MultiPipelineCallbacks, NoneType] = None callback_on_step_end_tensor_inputs: typing.List[str] = ['latents'] ) → ~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput or tuple

参数

  • prompt (str 或 List[str], optional) — 引导图像生成的提示或提示列表。如果未定义，则需要传递 `prompt_embeds`。
  • prompt_2 (str 或 List[str], optional) — 要发送到 `tokenizer_2` 和 `text_encoder_2` 的提示或提示列表。如果未定义，则 `prompt` 将在两个文本编码器中都使用。
  • image (torch.Tensor, PIL.Image.Image, np.ndarray, List[torch.Tensor], List[PIL.Image.Image], List[np.ndarray], — List[List[torch.Tensor]], List[List[np.ndarray]] 或 List[List[PIL.Image.Image]]): `ControlNet` 的输入条件，为 `unet` 的生成提供指导。如果类型指定为 `torch.Tensor`，则按原样传递给 `ControlNet`。`PIL.Image.Image` 也可接受为图像。输出图像的尺寸默认为 `image` 的尺寸。如果传递了 `height` 和/或 `width`，则会相应地调整 `image` 的大小。如果在 `init` 中指定了多个 `ControlNet`，则必须将图像作为列表传递，以便列表中的每个元素都可以正确地批量处理，以输入到单个 `ControlNet`。
  • height (int, optional, defaults to self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的高度（以像素为单位）。对于 stabilityai/stable-diffusion-xl-base-1.0 以及未在低分辨率下专门微调的检查点，任何低于 512 像素的值都无法很好地工作。
  • width (int, optional, defaults to self.unet.config.sample_size * self.vae_scale_factor) — 生成图像的宽度（以像素为单位）。对于 stabilityai/stable-diffusion-xl-base-1.0 以及未在低分辨率下专门微调的检查点，任何低于 512 像素的值都无法很好地工作。
  • num_inference_steps (int, optional, defaults to 50) — 去噪步骤的数量。更多的去噪步骤通常会以较慢的推理速度为代价，带来更高质量的图像。
  • guidance_scale (float, optional, defaults to 5.0) — 更高的 guidance scale 值会鼓励模型生成与文本 `prompt` 紧密相关的图像，但会以较低的图像质量为代价。当 `guidance_scale > 1` 时，guidance scale 启用。
  • negative_prompt (str 或 List[str], optional) — 引导图像生成中*不*包含什么的提示或提示列表。如果未定义，则需要传递 `negative_prompt_embeds`。当不使用 guidance 时（`guidance_scale < 1`），此参数将被忽略。
  • negative_prompt_2 (str 或 List[str], optional) — 引导图像生成中*不*包含什么的提示或提示列表。这将被发送到 `tokenizer_2` 和 `text_encoder_2`。如果未定义，则 `negative_prompt` 将在两个文本编码器中都使用。
  • 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 输入参数生成 negative_prompt_embeds。
  • pooled_prompt_embeds (torch.Tensor, 可选) — 预生成的池化文本嵌入。可用于轻松调整文本输入（提示权重）。如果未提供，则会从 prompt 输入参数生成池化文本嵌入。
  • negative_pooled_prompt_embeds (torch.Tensor, 可选) — 预生成的负面池化文本嵌入。可用于轻松调整文本输入（提示权重）。如果未提供，则会从 negative_prompt 输入参数生成池化的 negative_prompt_embeds。
  • output_type (str, 可选，默认为 "pil") — 生成的图像的输出格式。在 PIL.Image 或 np.array 之间选择。
  • return_dict (bool, 可选，默认为 True) — 是否返回 StableDiffusionPipelineOutput 而不是纯元组。
  • cross_attention_kwargs (dict, 可选) — 一个 kwargs 字典，如果指定，则将其传递给 self.processor 中定义的 AttentionProcessor。
  • controlnet_conditioning_scale (float 或 List[float], 可选，默认为 1.0) — ControlNet 的输出在添加到原始 unet 中的残差之前，会乘以 controlnet_conditioning_scale。
  • control_guidance_start (float, 可选，默认为 0.0) — ControlNet 开始应用的步数占总步数的百分比。
  • control_guidance_end (float, 可选，默认为 1.0) — ControlNet 停止应用的步数占总步数的百分比。
  • original_size (Tuple[int], 可选，默认为 (1024, 1024)) — 如果 original_size 与 target_size 不同，则图像将显示为降采样或升采样。如果未指定，original_size 默认为 (width, height)。SDXL 微调的一部分，如 https://huggingface.ac.cn/papers/2307.01952 第 2.2 节所述。
  • crops_coords_top_left (Tuple[int], 可选，默认为 (0, 0)) — crops_coords_top_left 可用于生成看起来像是从位置 crops_coords_top_left 向下“裁剪”的图像。通常通过将 crops_coords_top_left 设置为 (0, 0) 可以获得较好的、居中的图像。SDXL 微调的一部分，如 https://huggingface.ac.cn/papers/2307.01952 第 2.2 节所述。
  • target_size (Tuple[int], 可选，默认为 (1024, 1024)) — 在大多数情况下，target_size 应设置为生成图像的期望高度和宽度。如果未指定，则默认为 (width, height)。SDXL 微调的一部分，如 https://huggingface.ac.cn/papers/2307.01952 第 2.2 节所述。
  • negative_original_size (Tuple[int], 可选，默认为 (1024, 1024)) — 为了基于特定的图像分辨率对生成过程进行负面调节。SDXL 微调的一部分，如 https://huggingface.ac.cn/papers/2307.01952 第 2.2 节所述。有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。
  • negative_crops_coords_top_left (Tuple[int], 可选，默认为 (0, 0)) — 为了基于特定的裁剪坐标对生成过程进行负面调节。SDXL 微调的一部分，如 https://huggingface.ac.cn/papers/2307.01952 第 2.2 节所述。有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。
  • negative_target_size (Tuple[int], 可选，默认为 (1024, 1024)) — 为了基于目标图像分辨率对生成过程进行负面调节。在大多数情况下，它应与 target_size 相同。SDXL 微调的一部分，如 https://huggingface.ac.cn/papers/2307.01952 第 2.2 节所述。有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。
  • 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 (List, 可选) — callback_on_step_end 函数的张量输入列表。列表中指定的张量将作为 callback_kwargs 参数传递。您将只能包含管道类 ._callback_tensor_inputs 属性中列出的变量。

返回

~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput 或 tuple

如果 return_dict 为 True，则返回 ~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput，否则返回包含输出图像的 tuple。

用于生成的管道调用函数。

示例

>>> # !pip install opencv-python transformers accelerate
>>> from diffusers import StableDiffusionXLControlNetXSPipeline, ControlNetXSAdapter, AutoencoderKL
>>> from diffusers.utils import load_image
>>> import numpy as np
>>> import torch

>>> import cv2
>>> from PIL import Image

>>> prompt = "aerial view, a futuristic research complex in a bright foggy jungle, hard lighting"
>>> negative_prompt = "low quality, bad quality, sketches"

>>> # download an image
>>> image = load_image(
...     "https://huggingface.co/datasets/hf-internal-testing/diffusers-images/resolve/main/sd_controlnet/hf-logo.png"
... )

>>> # initialize the models and pipeline
>>> controlnet_conditioning_scale = 0.5
>>> vae = AutoencoderKL.from_pretrained("madebyollin/sdxl-vae-fp16-fix", torch_dtype=torch.float16)
>>> controlnet = ControlNetXSAdapter.from_pretrained(
...     "UmerHA/Testing-ConrolNetXS-SDXL-canny", torch_dtype=torch.float16
... )
>>> pipe = StableDiffusionXLControlNetXSPipeline.from_pretrained(
...     "stabilityai/stable-diffusion-xl-base-1.0", controlnet=controlnet, torch_dtype=torch.float16
... )
>>> pipe.enable_model_cpu_offload()

>>> # get canny image
>>> image = np.array(image)
>>> image = cv2.Canny(image, 100, 200)
>>> image = image[:, :, None]
>>> image = np.concatenate([image, image, image], axis=2)
>>> canny_image = Image.fromarray(image)

>>> # generate image
>>> image = pipe(
...     prompt, controlnet_conditioning_scale=controlnet_conditioning_scale, image=canny_image
... ).images[0]

encode_prompt

< >

( prompt: str prompt_2: typing.Optional[str] = None device: typing.Optional[torch.device] = None num_images_per_prompt: int = 1 do_classifier_free_guidance: bool = True negative_prompt: typing.Optional[str] = None negative_prompt_2: typing.Optional[str] = None prompt_embeds: typing.Optional[torch.Tensor] = None negative_prompt_embeds: typing.Optional[torch.Tensor] = None pooled_prompt_embeds: typing.Optional[torch.Tensor] = None negative_pooled_prompt_embeds: typing.Optional[torch.Tensor] = None lora_scale: typing.Optional[float] = None clip_skip: typing.Optional[int] = None )

参数

  • prompt (str 或 List[str], 可选) — 要编码的提示词
  • prompt_2 (str 或 List[str], 可选) — 要发送到 tokenizer_2 和 text_encoder_2 的提示词。如果未定义，则 prompt 将用于两个文本编码器
  • device — (torch.device): torch 设备
  • num_images_per_prompt (int) — 每个提示词应生成的图像数量
  • do_classifier_free_guidance (bool) — 是否使用无分类器引导（classifier free guidance）
  • negative_prompt (str 或 List[str], 可选) — 不用于引导图像生成的提示词。如果未定义，则必须传入 negative_prompt_embeds 代替。当不使用引导时（即，如果 guidance_scale 小于 1），将被忽略。
  • negative_prompt_2 (str 或 List[str], 可选) — 不用于引导图像生成的提示词，将发送到 tokenizer_2 和 text_encoder_2。如果未定义，则 negative_prompt 将用于两个文本编码器
  • prompt_embeds (torch.Tensor, 可选) — 预生成的文本嵌入。可用于轻松调整文本输入，例如 提示词权重。如果未提供，将从 prompt 输入参数生成文本嵌入。
  • negative_prompt_embeds (torch.Tensor, 可选) — 预生成的负面文本嵌入。可用于轻松调整文本输入，例如 提示词权重。如果未提供，将从 negative_prompt 输入参数生成 negative_prompt_embeds。
  • pooled_prompt_embeds (torch.Tensor, 可选) — 预生成的池化文本嵌入。可用于轻松调整文本输入，例如 提示词权重。如果未提供，将从 prompt 输入参数生成池化文本嵌入。
  • negative_pooled_prompt_embeds (torch.Tensor, 可选) — 预生成的负面池化文本嵌入。可用于轻松调整文本输入，例如 提示词权重。如果未提供，将从 negative_prompt 输入参数生成池化 negative_prompt_embeds。
  • lora_scale (float, 可选) — 如果加载了 LoRA 层，则将应用于文本编码器所有 LoRA 层的 lora 缩放比例。
  • clip_skip (int, 可选) — 在计算提示词嵌入时，要从 CLIP 跳过的层数。值为 1 表示将使用预倒数第二层的输出进行提示词嵌入的计算。

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

StableDiffusionPipelineOutput

class diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput

< >

( images: typing.Union[typing.List[PIL.Image.Image], numpy.ndarray] nsfw_content_detected: typing.Optional[typing.List[bool]] )

参数

  • 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 管道的输出类。

< > 在 GitHub 上更新

←ControlNet-XS ControlNetUnion→