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] 的大小和架构设计，用于使用基于稳定扩散的模型控制图像生成过程。我们表明，一个新的架构，仅包含基础模型参数的 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 检查点都是实验性的，还有很大的改进空间。请随时打开一个问题，并留下您对如何改进的反馈！
StableDiffusionXLControlNetXSPipeline
class diffusers.StableDiffusionXLControlNetXSPipeline
< 源代码 >( vae: AutoencoderKL text_encoder: CLIPTextModel text_encoder_2: CLIPTextModelWithProjection tokenizer: CLIPTokenizer tokenizer_2: CLIPTokenizer unet: Union controlnet: ControlNetXSAdapter scheduler: KarrasDiffusionSchedulers force_zeros_for_empty_prompt: bool = True add_watermarker: Optional = 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) — 用于创建 UNetControlNetXSModel 来对编码的图像潜在值进行去噪的UNet2DConditionModel。
- controlnet (
ControlNetXSAdapter) — 用于与unet结合使用的ControlNetXSAdapter，用于对编码后的图像潜在变量进行降噪。 - scheduler (SchedulerMixin) — 用于与
unet结合使用的调度器，用于对编码后的图像潜在变量进行降噪。 可以是 DDIMScheduler、LMSDiscreteScheduler 或 PNDMScheduler 中的一种。 - force_zeros_for_empty_prompt (
bool, 可选, 默认值"True") — 负向提示嵌入是否始终设置为 0。 另请参见stabilityai/stable-diffusion-xl-base-1-0的配置。 - add_watermarker (
bool, 可选) — 是否使用 invisible_watermark 库来为输出图像添加水印。 如果未定义，则在安装该包时默认值为True； 否则不使用水印。
使用 Stable Diffusion XL 和 ControlNet-XS 指导进行文本到图像生成的管道。
此模型继承自 DiffusionPipeline。 请查看超类文档以了解为所有管道实现的通用方法（下载、保存、在特定设备上运行等）。
该管道还继承了以下加载方法
- load_textual_inversion() 用于加载文本反转嵌入
- loaders.StableDiffusionXLLoraLoaderMixin.load_lora_weights() 用于加载 LoRA 权重
- loaders.FromSingleFileMixin.from_single_file() 用于加载
.ckpt文件
__call__
< source >( prompt: Union = None prompt_2: Union = None image: Union = None height: Optional = None width: Optional = None num_inference_steps: int = 50 guidance_scale: float = 5.0 negative_prompt: Union = None negative_prompt_2: Union = None num_images_per_prompt: Optional = 1 eta: float = 0.0 generator: Union = None latents: Optional = None prompt_embeds: Optional = None negative_prompt_embeds: Optional = None pooled_prompt_embeds: Optional = None negative_pooled_prompt_embeds: Optional = None output_type: Optional = 'pil' return_dict: bool = True cross_attention_kwargs: Optional = None controlnet_conditioning_scale: Union = 1.0 control_guidance_start: float = 0.0 control_guidance_end: float = 1.0 original_size: Tuple = None crops_coords_top_left: Tuple = (0, 0) target_size: Tuple = None negative_original_size: Optional = None negative_crops_coords_top_left: Tuple = (0, 0) negative_target_size: Optional = None clip_skip: Optional = None callback_on_step_end: Union = None callback_on_step_end_tensor_inputs: List = ['latents'] ) → ~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput 或 元组
参数
- prompt (
str或List[str], 可选) — 用于指导图像生成的提示或提示。如果未定义，则需要传递prompt_embeds。 - prompt_2 (
str或List[str], 可选) — 要发送到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的维度。如果传递了高度和/或宽度，则image将相应地调整大小。如果在init中指定了多个 ControlNet，则图像必须作为列表传递，以便列表中的每个元素都可以正确地批处理以输入到单个 ControlNet。 - height (
int, 可选，默认为self.unet.config.sample_size * self.vae_scale_factor) — 生成的图像的高度（以像素为单位）。对于 stabilityai/stable-diffusion-xl-base-1.0 和未针对低分辨率专门微调的检查点，任何低于 512 像素的值都不会正常工作。 - width (
int, 可选，默认为self.unet.config.sample_size * self.vae_scale_factor) — 生成的图像的宽度（以像素为单位）。对于 stabilityai/stable-diffusion-xl-base-1.0 和未针对低分辨率专门微调的检查点，任何低于 512 像素的值都不会正常工作。 - num_inference_steps (
int, 可选，默认为 50) — 降噪步骤的数量。更多的降噪步骤通常会导致更高质量的图像，但会以更慢的推理为代价。 - guidance_scale (
float, 可选，默认为 5.0) — 较高的引导比例值鼓励模型生成与文本prompt紧密相关的图像，但会以较低图像质量为代价。当guidance_scale > 1时，引导比例被启用。 - 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) — 每个提示要生成的图像数量。 - 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_embeds将从negative_prompt输入参数生成。 - pooled_prompt_embeds (
torch.Tensor, 可选) — 预生成的池化文本嵌入。可以用来轻松调整文本输入（提示权重）。如果未提供，则池化文本嵌入将从prompt输入参数生成。 - negative_pooled_prompt_embeds (
torch.Tensor, 可选) — 预生成的负面池化文本嵌入。可以用来轻松调整文本输入（提示权重）。如果未提供，则池化negative_prompt_embeds将从negative_prompt输入参数生成。 - output_type (
str, 可选, 默认值为"pil") — 生成的图像的输出格式。在PIL.Image或np.array中选择。 - return_dict (
bool, 可选, 默认值为True) — 是否返回 StableDiffusionPipelineOutput 而不是普通元组。 - cross_attention_kwargs (
dict, 可选) — 如果指定，则传递给self.processor中定义的AttentionProcessor的 kwargs 字典。 - control_guidance_end (
float, 可选, 默认为 1.0) — ControlNet 停止应用的总步数的百分比。 - original_size (
Tuple[int], 可选, 默认为 (1024, 1024)) — 如果original_size与target_size不相同，则图像将看起来被下采样或上采样。 如果未指定original_size，则默认为(width, height)。 作为 SDXL 微调的一部分，如 https://huggingface.co/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.co/papers/2307.01952 第 2.2 节所述。 - target_size (
Tuple[int], 可选, 默认为 (1024, 1024)) — 在大多数情况下，target_size应设置为生成的图像所需的高度和宽度。 如果未指定，它将默认为(width, height)。 作为 SDXL 微调的一部分，如 https://huggingface.co/papers/2307.01952 第 2.2 节所述。 - negative_original_size (
Tuple[int], 可选, 默认为 (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], 可选, 默认为 (0, 0)) — 基于特定裁剪坐标对生成过程进行负向条件化。 作为 SDXL 微调的一部分，如 https://huggingface.co/papers/2307.01952 第 2.2 节所述。 有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。 - negative_target_size (
Tuple[int], 可选, 默认为 (1024, 1024)) — 基于目标图像分辨率对生成过程进行负向条件化。 在大多数情况下，它应该与target_size相同。 作为 SDXL 微调的一部分，如 https://huggingface.co/papers/2307.01952 第 2.2 节所述。 有关更多信息，请参阅此问题线程： https://github.com/huggingface/diffusers/issues/4208。 - clip_skip (
int, 可选) — 从 CLIP 计算提示嵌入时要跳过的层数。 值为 1 表示将使用倒数第二层的输出计算提示嵌入。
返回值
~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://hf.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
< source >( prompt: str prompt_2: Optional = None device: Optional = None num_images_per_prompt: int = 1 do_classifier_free_guidance: bool = True negative_prompt: Optional = None negative_prompt_2: Optional = None prompt_embeds: Optional = None negative_prompt_embeds: Optional = None pooled_prompt_embeds: Optional = None negative_pooled_prompt_embeds: Optional = None lora_scale: Optional = None clip_skip: Optional = None )
参数
- prompt (
str或List[str], 可选) — 要编码的提示 - prompt_2 (
str或List[str], 可选) — 要发送到tokenizer_2和text_encoder_2的提示或提示。如果没有定义，则在两个文本编码器中都使用promptdevice — (torch.device): torch 设备 - num_images_per_prompt (
int) — 每个提示应生成的图像数量 - do_classifier_free_guidance (
bool) — 是否使用无分类器引导 - 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输入参数生成池化负面_prompt_embeds。 - lora_scale (
float, 可选) — 如果加载 LoRA 层，则将应用于文本编码器所有 LoRA 层的 LoRA 比例。 - clip_skip (
int, 可选) — 在计算提示词嵌入时要跳过的 CLIP 层数。 值为 1 意味着将使用倒数第二层的输出计算提示词嵌入。
将提示词编码为文本编码器隐藏状态。
StableDiffusionPipelineOutput
class diffusers.pipelines.stable_diffusion.StableDiffusionPipelineOutput
< 源代码 >( images: Union nsfw_content_detected: Optional )
Stable Diffusion 管道的输出类。