ControlNet 与 Stable Diffusion XL
ControlNet 由 Lvmin Zhang、Anyi Rao 和 Maneesh Agrawala 在 为文本到图像扩散模型添加条件控制 中提出。
使用 ControlNet 模型,您可以提供额外的控制图像来调节和控制 Stable Diffusion 的生成。例如,如果您提供深度图,ControlNet 模型将生成一个保留深度图空间信息的图像。这是一种更灵活、更精确的控制图像生成过程的方法。
论文摘要如下:
我们提出了 ControlNet,这是一种神经网络架构,可以为大型预训练文本到图像扩散模型添加空间条件控制。ControlNet 锁定生产就绪的大型扩散模型,并利用其通过数十亿张图像预训练的深层且鲁棒的编码层作为强大的骨干来学习各种条件控制。神经架构与“零卷积”(零初始化卷积层)相连,这些层从零开始逐步增加参数,确保没有有害噪声会影响微调。我们使用 Stable Diffusion 测试了各种条件控制,例如边缘、深度、分割、人体姿势等,使用单个或多个条件,有或没有提示。我们展示了 ControlNet 的训练对小型(<50k)和大型(>1m)数据集都非常稳健。大量的结果表明,ControlNet 可以促进更广泛的应用,以控制图像扩散模型。
您可以在 🤗 Diffusers Hub 组织中找到其他较小的 Stable Diffusion XL (SDXL) ControlNet 检查点,并浏览 Hub 上的 社区训练 检查点。
🧪 许多 SDXL ControlNet 检查点是实验性的,还有很大的改进空间。请随时打开一个 Issue 并向我们提供有关如何改进的反馈!
如果您没有看到您感兴趣的检查点,可以使用我们的 训练脚本 训练自己的 SDXL ControlNet。
StableDiffusionXLControlNetPipeline
class diffusers.StableDiffusionXLControlNetPipeline
< source >( vae: AutoencoderKL text_encoder: CLIPTextModel text_encoder_2: CLIPTextModelWithProjection tokenizer: CLIPTokenizer tokenizer_2: CLIPTokenizer unet: UNet2DConditionModel controlnet: Union scheduler: KarrasDiffusionSchedulers force_zeros_for_empty_prompt: bool = True add_watermarker: Optional = None feature_extractor: CLIPImageProcessor = None image_encoder: CLIPVisionModelWithProjection = 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
。 - controlnet (ControlNetModel 或
List[ControlNetModel]
) — 在去噪过程中为unet
提供额外的条件。 如果您设置多个 ControlNet 作为列表,则来自每个 ControlNet 的输出将加在一起以创建一个组合的额外条件。 - 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 指导进行文本到图像生成的管道。
此模型继承自 DiffusionPipeline。 检查超类文档以获取为所有管道实现的通用方法(下载、保存、在特定设备上运行等)。
该管道还继承了以下加载方法
- load_textual_inversion() 用于加载文本反转嵌入
- load_lora_weights() 用于加载 LoRA 权重
- save_lora_weights() 用于保存 LoRA 权重
- from_single_file() 用于加载
.ckpt
文件 - load_ip_adapter() 用于加载 IP 适配器
__call__
< 源代码 >( 提示: Union = None 提示_2: Union = None 图像: Union = None 高度: Optional = None 宽度: Optional = None 推理步骤数量: int = 50 时间步: List = None 西格玛: List = None 去噪结束: Optional = None 引导尺度: float = 5.0 负面提示: Union = None 负面提示_2: Union = None 每个提示的图像数量: Optional = 1 埃塔: float = 0.0 生成器: Union = None 潜在变量: Optional = None 提示嵌入: Optional = None 负面提示嵌入: Optional = None 池化提示嵌入: Optional = None 负面池化提示嵌入: Optional = None ip_适配器图像: Union = None ip_适配器图像嵌入: Optional = None 输出类型: Optional = 'pil' 返回字典: bool = True 交叉注意力参数: Optional = None ControlNet 条件尺度: Union = 1.0 猜测模式: bool = False 控制引导开始: Union = 0.0 控制引导结束: Union = 1.0 原始大小: Tuple = None 裁剪坐标左上角: Tuple = (0, 0) 目标大小: Tuple = None 负面原始大小: Optional = None 负面裁剪坐标左上角: Tuple = (0, 0) 负面目标大小: Optional = None 剪辑跳过: Optional = None 步骤结束回调: Union = None 步骤结束张量输入回调: List = ['latents'] **kwargs ) → StableDiffusionPipelineOutput 或 tuple
参数
- 提示 (
str
或List[str]
, 可选) — 用于引导图像生成的提示或提示列表。如果未定义,则需要传递prompt_embeds
。 - 提示_2 (
str
或List[str]
, 可选) — 要发送到tokenizer_2
和text_encoder_2
的提示或提示列表。如果未定义,则在两个文本编码器中都使用prompt
。 - 图像 (
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]]
): 用于为生成提供引导unet
的 ControlNet 输入条件。如果类型指定为torch.Tensor
,则按原样传递给 ControlNet。PIL.Image.Image
也可以作为图像接受。输出图像的尺寸默认为image
的尺寸。如果传递了高度和/或宽度,则image
将相应调整大小。如果在init
中指定了多个 ControlNet,则图像必须作为列表传递,以便每个列表元素都可以正确批处理以输入到单个 ControlNet。 - 高度 (
int
, 可选, 默认为self.unet.config.sample_size * self.vae_scale_factor
) — 生成的图像的像素高度。对于低于 512 像素的图像,stabilityai/stable-diffusion-xl-base-1.0 和未专门针对低分辨率进行微调的检查点不会很好地工作。 - 宽度 (
int
, 可选, 默认为self.unet.config.sample_size * self.vae_scale_factor
) — 生成的图像的像素宽度。对于低于 512 像素的图像,stabilityai/stable-diffusion-xl-base-1.0 和未专门针对低分辨率进行微调的检查点不会很好地工作。 - num_inference_steps (
int
, 可选, 默认值为 50) — 降噪步骤数。更多的降噪步骤通常会导致更高质量的图像,但会降低推理速度。 - timesteps (
List[int]
, 可选) — 用于降噪过程的自定义时间步长,适用于在其set_timesteps
方法中支持timesteps
参数的调度器。如果未定义,将使用传递num_inference_steps
时的默认行为。必须按降序排列。 - sigmas (
List[float]
, 可选) — 用于降噪过程的自定义 sigma,适用于在其set_timesteps
方法中支持sigmas
参数的调度器。如果未定义,将使用传递num_inference_steps
时的默认行为。 - denoising_end (
float
, 可选) — 当指定时,确定在有意提前终止降噪过程之前要完成的总降噪过程的比例(介于 0.0 和 1.0 之间)。因此,返回的样本将仍然保留由调度器选择的离散时间步长确定的大量噪声。denoising_end 参数应该最好在该管道构成“降噪器混合”多管道设置的一部分时使用,如 Refining the Image Output 中所述 - 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
输入参数生成negative_prompt_embeds
。 - pooled_prompt_embeds (
torch.Tensor
, 可选) — 预先生成的池化文本嵌入。 可用于轻松调整文本输入(提示加权)。 如果未提供,则从prompt
输入参数生成池化文本嵌入。 - negative_pooled_prompt_embeds (
torch.Tensor
, 可选) — 预先生成的负面池化文本嵌入。 可用于轻松调整文本输入(提示加权)。 如果未提供,则从negative_prompt
输入参数生成池化negative_prompt_embeds
。 ip_adapter_image — (PipelineImageInput
, 可选): 可选的图像输入,用于与 IP 适配器一起使用。 - ip_adapter_image_embeds (
List[torch.Tensor]
, 可选) — IP-Adapter 的预生成图像嵌入。 它的长度应与 IP-Adapter 的数量相同。 每个元素应该是形状为(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 字典传递给AttentionProcessor
,如self.processor
中所定义。 - controlnet_conditioning_scale (
float
或List[float]
, 可选, 默认为 1.0) — ControlNet 的输出在添加到原始unet
中的残差之前,乘以controlnet_conditioning_scale
。 如果在init
中指定了多个 ControlNet,则可以将相应的比例设置为列表。 - control_guidance_end (
float
或List[float]
, 可选, 默认值 1.0) — ControlNet 停止应用的总步数百分比。 - original_size (
Tuple[int]
, 可选, 默认值 (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]
, 可选, 默认值 (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
应设置为生成的图像的所需高度和宽度。 如果未指定,它将默认为(height, width)
。 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 表示将使用倒数第二层的输出计算提示嵌入。 - 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
属性中列出的变量。
返回
StableDiffusionPipelineOutput 或 tuple
如果return_dict
为True
,则返回StableDiffusionPipelineOutput,否则返回包含输出图像的tuple
。
用于生成管道调用函数。
示例
>>> # !pip install opencv-python transformers accelerate
>>> from diffusers import StableDiffusionXLControlNetPipeline, ControlNetModel, 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 # recommended for good generalization
>>> controlnet = ControlNetModel.from_pretrained(
... "diffusers/controlnet-canny-sdxl-1.0", torch_dtype=torch.float16
... )
>>> vae = AutoencoderKL.from_pretrained("madebyollin/sdxl-vae-fp16-fix", torch_dtype=torch.float16)
>>> pipe = StableDiffusionXLControlNetPipeline.from_pretrained(
... "stabilityai/stable-diffusion-xl-base-1.0", controlnet=controlnet, vae=vae, 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: 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
的提示或提示。 如果未定义,则在两个文本编码器中使用prompt
device — (torch.device
): 火炬设备 - 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_embeds
将从negative_prompt
输入参数生成。 - pooled_prompt_embeds (
torch.Tensor
, 可选) — 预生成的池化文本嵌入。可用于轻松调整文本输入,例如 提示权重。如果未提供,则池化文本嵌入将从prompt
输入参数生成。 - negative_pooled_prompt_embeds (
torch.Tensor
, 可选) — 预生成的负池化文本嵌入。可用于轻松调整文本输入,例如 提示权重。如果未提供,则池化negative_prompt_embeds
将从negative_prompt
输入参数生成。 - lora_scale (
float
, 可选) — 如果加载了 LoRA 层,则将应用于文本编码器所有 LoRA 层的 LoRA 比例。 - clip_skip (
int
, 可选) — 从 CLIP 计算提示嵌入时要跳过的层数。值为 1 表示将使用倒数第二层的输出计算提示嵌入。
将提示编码为文本编码器隐藏状态。
get_guidance_scale_embedding
< 源代码 > ( w: Tensor embedding_dim: int = 512 dtype: dtype = torch.float32 ) → torch.Tensor
StableDiffusionXLControlNetImg2ImgPipeline
类 diffusers.StableDiffusionXLControlNetImg2ImgPipeline
< 源代码 >( vae: AutoencoderKL text_encoder: CLIPTextModel text_encoder_2: CLIPTextModelWithProjection tokenizer: CLIPTokenizer tokenizer_2: CLIPTokenizer unet: UNet2DConditionModel controlnet: Union scheduler: KarrasDiffusionSchedulers requires_aesthetics_score: bool = False force_zeros_for_empty_prompt: bool = True add_watermarker: Optional = None feature_extractor: CLIPImageProcessor = None image_encoder: CLIPVisionModelWithProjection = None )
参数
- vae (AutoencoderKL) — 变分自动编码器 (VAE) 模型,用于将图像编码和解码为潜在表示。
- text_encoder (
CLIPTextModel
) — 冻结的文本编码器。Stable Diffusion 使用 CLIP 的文本部分,特别是 clip-vit-large-patch14 变体。 - text_encoder_2 (
CLIPTextModelWithProjection
) — 第二个冻结的文本编码器。Stable Diffusion XL 使用 CLIP 的文本和池部分,特别是 laion/CLIP-ViT-bigG-14-laion2B-39B-b160k 变体。 - tokenizer (
CLIPTokenizer
) — CLIPTokenizer 类的分词器。 - tokenizer_2 (
CLIPTokenizer
) — CLIPTokenizer 类的第二个分词器。 - controlnet (ControlNetModel 或
List[ControlNetModel]
) — 在去噪过程中为 unet 提供额外的条件。如果设置多个 ControlNet 作为列表,则来自每个 ControlNet 的输出将加在一起,以创建一个组合的额外条件。 - scheduler (SchedulerMixin) — 与
unet
组合使用以对编码的图像潜变量进行去噪的调度器。可以是 DDIMScheduler、LMSDiscreteScheduler 或 PNDMScheduler 之一。 - requires_aesthetics_score (
bool
, 可选, 默认为"False"
) —unet
是否需要在推断期间传递aesthetic_score
条件。另请参阅stabilityai/stable-diffusion-xl-refiner-1-0
的配置。 - force_zeros_for_empty_prompt (
bool
, 可选, 默认为"True"
) — 是否强制将负面提示嵌入设置为始终为 0。另请参阅stabilityai/stable-diffusion-xl-base-1-0
的配置。 - add_watermarker (
bool
, 可选) — 是否使用 invisible_watermark 库 对输出图像加水印。如果未定义,则如果安装了包,则默认值为 True,否则将不使用任何水印器。 - feature_extractor (CLIPImageProcessor) — 从生成的图像中提取特征的
CLIPImageProcessor
;用作safety_checker
的输入。
使用带有 ControlNet 指导的 Stable Diffusion XL 进行图像到图像生成的管道。
此模型继承自 DiffusionPipeline。查看超类文档以获取库为所有管道实现的通用方法(例如下载或保存、在特定设备上运行等)。
该管道还继承了以下加载方法
- load_textual_inversion() 用于加载文本反转嵌入
- load_lora_weights() 用于加载 LoRA 权重
- save_lora_weights() 用于保存 LoRA 权重
- load_ip_adapter() 用于加载 IP 适配器
__call__
< 源代码 > ( 提示: Union = None 提示_2: Union = None 图像: Union = None 控制图像: Union = None 高度: Optional = None 宽度: Optional = None 强度: float = 0.8 推理步骤数: int = 50 引导尺度: float = 5.0 负面提示: Union = None 负面提示_2: Union = None 每个提示的图像数量: Optional = 1 eta: float = 0.0 生成器: Union = None 潜在变量: Optional = None 提示嵌入: Optional = None 负面提示嵌入: Optional = None 汇聚提示嵌入: Optional = None 负面汇聚提示嵌入: Optional = None ip_adapter_image: Union = None ip_adapter_image_embeds: Optional = None 输出类型: Optional = 'pil' 返回字典: bool = True 交叉注意力参数: Optional = None ControlNet 条件尺度: Union = 0.8 猜测模式: bool = False 控制引导开始: Union = 0.0 控制引导结束: Union = 1.0 原始尺寸: Tuple = None 裁剪坐标左上角: Tuple = (0, 0) 目标尺寸: Tuple = None 负面原始尺寸: Optional = None 负面裁剪坐标左上角: Tuple = (0, 0) 负面目标尺寸: Optional = None 美学评分: float = 6.0 负面美学评分: float = 2.5 CLIP 跳过: Optional = None 步骤结束回调: Union = None 步骤结束回调张量输入: List = ['latents'] **kwargs ) → StableDiffusionXLControlNetImg2ImgPipelineOutput 或 元组
参数
- 提示 (
str
或List[str]
, 可选) — 指导图像生成的提示或提示。如果未定义,则必须传递prompt_embeds
。 取而代之。 - 提示_2 (
str
或List[str]
, 可选) — 要发送到tokenizer_2
和text_encoder_2
的提示或提示。如果未定义,则两个文本编码器都使用prompt
- 图像 (
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]]
): 初始图像将用作图像生成过程的起点。还可以接受图像潜在变量作为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 输入条件。ControlNet 使用此输入条件来生成对 Unet 的引导。如果类型指定为torch.Tensor
,则按原样传递给 ControlNet。PIL.Image.Image
也可以作为图像接受。输出图像的尺寸默认为image
的尺寸。如果传递了高度和/或宽度,则image
会根据它们调整大小。如果在初始化中指定了多个 ControlNet,则图像必须作为列表传递,以便列表的每个元素都可以正确地批处理以输入到单个 controlnet 中。 - 高度 (
int
, 可选, 默认为 control_image 的大小) — 生成的图像的像素高度。低于 512 像素的任何内容对于 stabilityai/stable-diffusion-xl-base-1.0 和未针对低分辨率专门微调的检查点将无法正常工作。 - width (
int
, 可选, 默认值为控制图像的大小) — 生成的图像的像素宽度。低于 512 像素的图像对于 stabilityai/stable-diffusion-xl-base-1.0 以及没有专门针对低分辨率进行微调的检查点来说效果并不好。 - strength (
float
, 可选, 默认值为 0.8) — 指示变换参考image
的程度。必须介于 0 到 1 之间。image
用作起点,strength
越高,添加的噪声越多。降噪步骤的数量取决于最初添加的噪声量。当strength
为 1 时,添加的噪声最大,降噪过程将运行num_inference_steps
中指定的全部迭代次数。值为 1 本质上会忽略image
。 - num_inference_steps (
int
, 可选, 默认值为 50) — 降噪步骤的数量。更多的降噪步骤通常会导致更高的图像质量,但会牺牲推理速度。 - guidance_scale (
float
, 可选, 默认值为 7.5) — 在 Classifier-Free Diffusion Guidance 中定义的引导比例。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) — 每个提示要生成的图像数量。 - eta (
float
, 可选, 默认值为 0.0) — 对应 DDIM 论文中的参数 eta (η):https://arxiv.org/abs/2010.02502。仅适用于 schedulers.DDIMScheduler,其他情况下会被忽略。 - generator (
torch.Generator
或List[torch.Generator]
, 可选) — 一个或多个 torch 生成器,用于使生成确定性。 - 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。 ip_adapter_image — (PipelineImageInput
, 可选): 可选的图像输入,用于与 IP 适配器协作。 - ip_adapter_image_embeds (
List[torch.Tensor]
, 可选) — 预生成的 IP 适配器的图像嵌入。它应该是一个列表,长度与 IP 适配器的数量相同。每个元素应该是一个形状为(batch_size, num_images, emb_dim)
的张量。如果do_classifier_free_guidance
设置为True
,它应该包含负面图像嵌入。如果没有提供,则会从ip_adapter_image
输入参数计算嵌入。 - output_type (
str
, 可选, 默认值为"pil"
) — 生成的图像的输出格式。在 PIL:PIL.Image.Image
或np.array
中选择。 - return_dict (
bool
, 可选, 默认值为True
) — 是否返回 StableDiffusionPipelineOutput 而不是普通元组。 - cross_attention_kwargs (
dict
, 可选) — 如果指定,则作为关键字参数字典传递给 diffusers.models.attention_processor 中self.processor
下定义的AttentionProcessor
。 - controlnet_conditioning_scale (
float
或List[float]
, 可选, 默认值为 1.0) — ControlNet 的输出在添加到原始 Unet 中的残差之前,将乘以controlnet_conditioning_scale
。如果在初始化中指定了多个 ControlNet,则可以将相应的比例设置为列表。 - guess_mode (
bool
, 可选, 默认值为False
) — 在此模式下,ControlNet 编码器将尽力识别输入图像的内容,即使您删除所有提示。建议使用 3.0 到 5.0 之间的guidance_scale
。 - control_guidance_end (
float
或List[float]
, 可选, 默认值为 1.0) — 控制网络停止应用的总步数的百分比。 - original_size (
Tuple[int]
, 可选, 默认值为 (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]
, 可选, 默认值为 (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
应设置为生成的图像的所需高度和宽度。 如果未指定,它将默认设置为(height, width)
。 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。 - aesthetic_score (
float
, 可选, 默认值为 6.0) — 通过影响正面文本条件来模拟生成图像的美学评分。 SDXL 微调的一部分,如 https://huggingface.co/papers/2307.01952 的第 2.2 节中所述。 - negative_aesthetic_score (
float
, 可选, 默认值为 2.5) — SDXL 微调的一部分,如 https://huggingface.co/papers/2307.01952 的第 2.2 节中所述。 可用于通过影响负面文本条件来模拟生成图像的美学评分。 - callback_on_step_end_tensor_inputs (
List
, 可选) —callback_on_step_end
函数的张量输入列表。列表中指定的张量将作为callback_kwargs
参数传递。您只能包含在管道类._callback_tensor_inputs
属性中列出的变量。
返回
StableDiffusionPipelineOutput 或 tuple
StableDiffusionPipelineOutput 如果 return_dict
为 True,否则为包含输出图像的 tuple
。
调用管道进行生成时调用的函数。
示例
>>> # pip install accelerate transformers safetensors diffusers
>>> import torch
>>> import numpy as np
>>> from PIL import Image
>>> from transformers import DPTImageProcessor, DPTForDepthEstimation
>>> from diffusers import ControlNetModel, StableDiffusionXLControlNetImg2ImgPipeline, AutoencoderKL
>>> from diffusers.utils import load_image
>>> depth_estimator = DPTForDepthEstimation.from_pretrained("Intel/dpt-hybrid-midas").to("cuda")
>>> feature_extractor = DPTImageProcessor.from_pretrained("Intel/dpt-hybrid-midas")
>>> controlnet = ControlNetModel.from_pretrained(
... "diffusers/controlnet-depth-sdxl-1.0-small",
... variant="fp16",
... use_safetensors=True,
... torch_dtype=torch.float16,
... )
>>> vae = AutoencoderKL.from_pretrained("madebyollin/sdxl-vae-fp16-fix", torch_dtype=torch.float16)
>>> pipe = StableDiffusionXLControlNetImg2ImgPipeline.from_pretrained(
... "stabilityai/stable-diffusion-xl-base-1.0",
... controlnet=controlnet,
... vae=vae,
... variant="fp16",
... use_safetensors=True,
... torch_dtype=torch.float16,
... )
>>> pipe.enable_model_cpu_offload()
>>> def get_depth_map(image):
... image = feature_extractor(images=image, return_tensors="pt").pixel_values.to("cuda")
... with torch.no_grad(), torch.autocast("cuda"):
... depth_map = depth_estimator(image).predicted_depth
... depth_map = torch.nn.functional.interpolate(
... depth_map.unsqueeze(1),
... size=(1024, 1024),
... mode="bicubic",
... align_corners=False,
... )
... depth_min = torch.amin(depth_map, dim=[1, 2, 3], keepdim=True)
... depth_max = torch.amax(depth_map, dim=[1, 2, 3], keepdim=True)
... depth_map = (depth_map - depth_min) / (depth_max - depth_min)
... image = torch.cat([depth_map] * 3, dim=1)
... image = image.permute(0, 2, 3, 1).cpu().numpy()[0]
... image = Image.fromarray((image * 255.0).clip(0, 255).astype(np.uint8))
... return image
>>> prompt = "A robot, 4k photo"
>>> image = load_image(
... "https://huggingface.co/datasets/hf-internal-testing/diffusers-images/resolve/main"
... "/kandinsky/cat.png"
... ).resize((1024, 1024))
>>> controlnet_conditioning_scale = 0.5 # recommended for good generalization
>>> depth_image = get_depth_map(image)
>>> images = pipe(
... prompt,
... image=image,
... control_image=depth_image,
... strength=0.99,
... num_inference_steps=50,
... controlnet_conditioning_scale=controlnet_conditioning_scale,
... ).images
>>> images[0].save(f"robot_cat.png")
encode_prompt
< 源代码 > ( 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
的提示或提示。如果未定义,则在两个文本编码器中都使用prompt
设备 — (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
输入参数生成池化negative_prompt_embeds。 - lora_scale (
float
, 可选) — 如果加载了LoRA层,则将应用于文本编码器所有LoRA层的LoRA比例。 - clip_skip (
int
, 可选) — 计算提示嵌入时要从 CLIP 中跳过的层数。 值 1 意味着将使用倒数第二层的输出计算提示嵌入。
将提示编码为文本编码器隐藏状态。
StableDiffusionXLControlNetInpaintPipeline
class diffusers.StableDiffusionXLControlNetInpaintPipeline
< 源代码 >( vae: AutoencoderKL text_encoder: CLIPTextModel text_encoder_2: CLIPTextModelWithProjection tokenizer: CLIPTokenizer tokenizer_2: CLIPTokenizer unet: UNet2DConditionModel controlnet: Union scheduler: KarrasDiffusionSchedulers requires_aesthetics_score: bool = False force_zeros_for_empty_prompt: bool = True add_watermarker: Optional = None feature_extractor: Optional = None image_encoder: Optional = None )
参数
- vae (AutoencoderKL) — 变分自动编码器 (VAE) 模型,用于将图像编码和解码为潜表示。
- text_encoder (
CLIPTextModel
) — 冻结的文本编码器。 Stable Diffusion XL 使用 CLIP 的文本部分,特别是 clip-vit-large-patch14 变体。 - text_encoder_2 (
CLIPTextModelWithProjection
) — 第二个冻结文本编码器。 Stable Diffusion XL 使用了 CLIP 的文本和池部分,特别是 laion/CLIP-ViT-bigG-14-laion2B-39B-b160k 变体。 - tokenizer (
CLIPTokenizer
) — 类别为 CLIPTokenizer 的分词器。 - tokenizer_2 (
CLIPTokenizer
) — 类别为 CLIPTokenizer 的第二个分词器。 - unet (UNet2DConditionModel) — 用于对编码图像潜在表示进行降噪的条件 U-Net 架构。
- scheduler (SchedulerMixin) — 与
unet
配合使用以对编码图像潜在表示进行降噪的调度器。 可以是 DDIMScheduler、LMSDiscreteScheduler 或 PNDMScheduler 之一。
使用 Stable Diffusion XL 进行文本到图像生成的管道。
此模型继承自 DiffusionPipeline。查看超类文档以获取库为所有管道实现的通用方法(例如下载或保存、在特定设备上运行等)。
该管道还继承了以下加载方法
- load_textual_inversion() 用于加载文本反转嵌入
- load_lora_weights() 用于加载 LoRA 权重
- save_lora_weights() 用于保存 LoRA 权重
- from_single_file() 用于加载
.ckpt
文件 - load_ip_adapter() 用于加载 IP 适配器
__call__
< 源代码 > ( prompt: Union = None prompt_2: Union = None image: Union = None mask_image: Union = None control_image: Union = None height: Optional = None width: Optional = None padding_mask_crop: Optional = None strength: float = 0.9999 num_inference_steps: int = 50 denoising_start: Optional = None denoising_end: Optional = None 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 ip_adapter_image: Union = None ip_adapter_image_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 guess_mode: bool = False control_guidance_start: Union = 0.0 control_guidance_end: Union = 1.0 guidance_rescale: float = 0.0 original_size: Tuple = None crops_coords_top_left: Tuple = (0, 0) target_size: Tuple = None aesthetic_score: float = 6.0 negative_aesthetic_score: float = 2.5 clip_skip: Optional = None callback_on_step_end: Union = None callback_on_step_end_tensor_inputs: List = ['latents'] **kwargs ) → ~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput
or tuple
参数
- prompt (
str
或List[str]
, 可选) — 指导图像生成的提示或提示。如果未定义,则必须传递prompt_embeds
。 代替。 - prompt_2 (
str
或List[str]
, 可选) — 要发送到tokenizer_2
和text_encoder_2
的提示或提示。如果未定义,则prompt
将在两个文本编码器中使用 - image (
PIL.Image.Image
) —Image
或表示将要进行修复的图像批次的张量,即 图像的一部分将被mask_image
掩盖,并根据prompt
重新绘制。 - mask_image (
PIL.Image.Image
) —Image
或表示图像批次的张量,以掩盖image
。蒙版中的白色像素将被重新绘制,而黑色像素将被保留。如果mask_image
是 PIL 图像,它将在使用前被转换为单通道(亮度)。如果它是张量,它应该包含一个颜色通道(L)而不是 3,因此预期形状将为(B, H, W, 1)
。 - height (
int
, 可选, 默认值为 self.unet.config.sample_size * self.vae_scale_factor) — 生成的图像的高度(以像素为单位)。 - width (
int
, 可选, 默认值为 self.unet.config.sample_size * self.vae_scale_factor) — 生成的图像的宽度(以像素为单位)。 - padding_mask_crop (
int
, 可选, 默认值为None
) — 应用于图像和蒙版的裁剪边距大小。如果为None
,则不会对图像和 mask_image 应用裁剪。如果padding_mask_crop
不为None
,则它将首先找到一个与图像具有相同纵横比并包含所有蒙版区域的矩形区域,然后根据padding_mask_crop
扩展该区域。然后,图像和 mask_image 将根据扩展区域进行裁剪,然后再调整大小以适应原始图像大小以进行修复。当蒙版区域较小而图像较大且包含与修复无关的信息(如背景)时,这很有用。 - strength (
float
, 可选, 默认值为 0.9999) — 从概念上讲,表示要转换参考image
的蒙版部分的程度。必须在 0 到 1 之间。image
将用作起点,向其添加更多噪声,越大strength
。去噪步骤的数量取决于最初添加的噪声量。当strength
为 1 时,添加的噪声将达到最大,去噪过程将运行num_inference_steps
中指定的全部迭代次数。因此,值为 1 本质上会忽略参考image
的蒙版部分。请注意,如果denoising_start
被声明为整数,则strength
的值将被忽略。 - num_inference_steps (
int
, 可选, 默认值为 50) — 去噪步骤的数量。更多去噪步骤通常会导致更高质量的图像,但会以更慢的推理为代价。 - denoising_start (
float
, 可选) — 当指定时,表示在启动去噪过程之前要绕过的总去噪过程的比例(介于 0.0 和 1.0 之间)。因此,去噪过程的初始部分将被跳过,并假设传递的image
是一个部分去噪的图像。请注意,当指定此参数时,strength 将被忽略。当此管道集成到“去噪器混合”多管道设置中时,denoising_start
参数特别有用,如 完善图像输出 中所述。 - denoising_end (
float
, 可选) — 当指定时,确定在故意过早终止之前要完成的总去噪过程的比例(介于 0.0 和 1.0 之间)。结果,返回的样本仍将保留大量噪声(大约最后的 20% 时间步长仍然需要)并且应该由一个后继管道去噪,该管道将denoising_start
设置为 0.8,以便它只去噪最后 20% 的调度器。denoising_end 参数应该最好用于此管道作为“去噪器混合”多管道设置的一部分时,如 完善图像输出 中所述。 - guidance_scale (
float
, 可选, 默认值为 7.5) — 无分类器扩散引导 中定义的引导尺度。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
用于两个文本编码器 - prompt_embeds (
torch.Tensor
, 可选) — 预先生成的文本嵌入。 可用于轻松调整文本输入,例如 提示加权。 如果未提供,则将从prompt
输入参数生成文本嵌入。 - negative_prompt_embeds (
torch.Tensor
, 可选) — 预先生成的负文本嵌入。 可用于轻松调整文本输入,例如 提示加权。 如果未提供,则将从negative_prompt
输入参数生成negative_prompt_embeds
。 ip_adapter_image — (PipelineImageInput
, 可选): 可选的图像输入,用于与 IP 适配器协同工作。 - ip_adapter_image_embeds (
List[torch.Tensor]
, 可选) — 预先生成的 IP 适配器的图像嵌入。 它应该是与 IP 适配器数量相同的长度列表。 每个元素都应该是形状为(batch_size, num_images, emb_dim)
的张量。 如果do_classifier_free_guidance
设置为True
,它应该包含负图像嵌入。 如果未提供,则从ip_adapter_image
输入参数计算嵌入。 - pooled_prompt_embeds (
torch.Tensor
, 可选) — 预先生成的池化文本嵌入。 可用于轻松调整文本输入,例如 提示加权。 如果未提供,则将从prompt
输入参数生成池化文本嵌入。 - negative_pooled_prompt_embeds (
torch.Tensor
, 可选) — 预先生成的负池化文本嵌入。 可用于轻松调整文本输入,例如 提示加权。 如果未提供,则将从negative_prompt
输入参数生成池化negative_prompt_embeds
。 - num_images_per_prompt (
int
, 可选,默认值为 1) — 每个提示要生成的图像数量。 - eta (
float
, 可选,默认值为 0.0) — 对应于 DDIM 论文中的参数 eta (η):https://arxiv.org/abs/2010.02502。 仅适用于 schedulers.DDIMScheduler,其他情况会被忽略。 - generator (
torch.Generator
, 可选) — 一个或多个 torch 生成器,用于使生成确定性。 - latents (
torch.Tensor
, 可选) — 预先生成的噪声潜码,从高斯分布采样,用作图像生成的输入。 可用于使用不同的提示调整相同的生成。 如果未提供,将通过使用提供的随机generator
采样来生成潜码张量。 - output_type (
str
, 可选,默认值:"pil"
) — 生成的图像的输出格式。 在 PIL 之间选择:PIL.Image.Image
或np.array
。 - return_dict (
bool
, 可选,默认值:True
) — 是否返回 StableDiffusionPipelineOutput 而不是普通元组。 - cross_attention_kwargs (
dict
, 可选) — 如果指定,则会传递给 diffusers.models.attention_processor 中self.processor
下定义的AttentionProcessor
的 kwargs 字典。 - 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 节中所述。 - aesthetic_score (
float
, 可选,默认值:6.0) — 用于通过影响正文本条件来模拟生成的图像的美学分数。 SDXL 微调的一部分,如 https://huggingface.co/papers/2307.01952 的第 2.2 节中所述。 - negative_aesthetic_score (
float
, 可选,默认值:2.5) — SDXL 微调的一部分,如 https://huggingface.co/papers/2307.01952 的第 2.2 节中所述。 可用于通过影响负文本条件来模拟生成的图像的美学分数。 - callback_on_step_end_tensor_inputs (
List
, 可选) —callback_on_step_end
函数的张量输入列表。 列表中指定的张量将作为callback_kwargs
参数传递。 您只能包含在管道类._callback_tensor_inputs
属性中列出的变量。
返回
~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput
或 tuple
~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput
如果 return_dict
为 True,否则为 tuple.
tuple. 返回元组时,第一个元素是包含生成的图像的列表。
调用管道进行生成时调用的函数。
示例
>>> # !pip install transformers accelerate
>>> from diffusers import StableDiffusionXLControlNetInpaintPipeline, ControlNetModel, DDIMScheduler
>>> from diffusers.utils import load_image
>>> from PIL import Image
>>> import numpy as np
>>> import torch
>>> init_image = load_image(
... "https://huggingface.co/datasets/diffusers/test-arrays/resolve/main/stable_diffusion_inpaint/boy.png"
... )
>>> init_image = init_image.resize((1024, 1024))
>>> generator = torch.Generator(device="cpu").manual_seed(1)
>>> mask_image = load_image(
... "https://huggingface.co/datasets/diffusers/test-arrays/resolve/main/stable_diffusion_inpaint/boy_mask.png"
... )
>>> mask_image = mask_image.resize((1024, 1024))
>>> def make_canny_condition(image):
... image = np.array(image)
... image = cv2.Canny(image, 100, 200)
... image = image[:, :, None]
... image = np.concatenate([image, image, image], axis=2)
... image = Image.fromarray(image)
... return image
>>> control_image = make_canny_condition(init_image)
>>> controlnet = ControlNetModel.from_pretrained(
... "diffusers/controlnet-canny-sdxl-1.0", torch_dtype=torch.float16
... )
>>> pipe = StableDiffusionXLControlNetInpaintPipeline.from_pretrained(
... "stabilityai/stable-diffusion-xl-base-1.0", controlnet=controlnet, torch_dtype=torch.float16
... )
>>> pipe.enable_model_cpu_offload()
>>> # generate image
>>> image = pipe(
... "a handsome man with ray-ban sunglasses",
... num_inference_steps=20,
... generator=generator,
... eta=1.0,
... image=init_image,
... mask_image=mask_image,
... control_image=control_image,
... ).images[0]
encode_prompt
< 源代码 > ( 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
的提示或提示。 如果未定义,则在两个文本编码器中使用prompt
设备 — (torch.device
): PyTorch 设备 - 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
输入参数生成文本嵌入。 - pooled_prompt_embeds (
torch.Tensor
, 可选) — 预生成的池化文本嵌入。可用于轻松调整文本输入,例如提示权重。 如果未提供,将从prompt
输入参数生成池化文本嵌入。 - negative_pooled_prompt_embeds (
torch.Tensor
, 可选) — 预生成的负面池化文本嵌入。可用于轻松调整文本输入,例如提示权重。 如果未提供,将从negative_prompt
输入参数生成负面池化文本嵌入。 - 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 管道的输出类。