Diffusers 文档

InstructPix2Pix

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验

开始使用

InstructPix2Pix

InstructPix2Pix:学习遵循图像编辑指令 由 Tim Brooks、Aleksander Holynski 和 Alexei A. Efros 撰写。

论文摘要如下:

我们提出了一种根据人类指令编辑图像的方法:给定输入图像和指示模型执行操作的书面指令,我们的模型会遵循这些指令来编辑图像。为了获得此问题的训练数据,我们将两个大型预训练模型的知识——语言模型(GPT-3)和文本到图像模型(Stable Diffusion)——结合起来,生成大型图像编辑示例数据集。我们的条件扩散模型 InstructPix2Pix 在我们生成的数据集上进行训练,并在推理时推广到真实图像和用户编写的指令。由于它在正向传递中执行编辑,并且不需要每个示例的微调或反转,因此我们的模型可以快速编辑图像,只需几秒钟。我们展示了针对各种输入图像和书面指令的引人注目的编辑结果。

您可以在项目页面原始代码库上找到有关 InstructPix2Pix 的更多信息,并可以在演示中试用它。

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

StableDiffusionInstructPix2PixPipeline

class diffusers.StableDiffusionInstructPix2PixPipeline

< >

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

参数

  • vae (AutoencoderKL) — 变分自动编码器 (VAE) 模型,用于将图像编码和解码到潜在表示中,以及从潜在表示中编码和解码图像。
  • text_encoder (CLIPTextModel) — 冻结的文本编码器 (clip-vit-large-patch14)。
  • tokenizer (CLIPTokenizer) — 用于分词文本的 CLIPTokenizer
  • unet (UNet2DConditionModel) — 用于对编码的图像潜在变量进行去噪的 UNet2DConditionModel
  • scheduler (SchedulerMixin) — 用于与 unet 结合对编码的图像潜在变量进行去噪的调度器。可以是 DDIMSchedulerLMSDiscreteSchedulerPNDMScheduler 之一。
  • safety_checker (StableDiffusionSafetyChecker) — 用于估计生成图像是否可能被视为冒犯性或有害的分类模块。有关模型潜在危害的更多详细信息,请参阅模型卡片
  • 特征提取器 (CLIPImageProcessor) — 用于从生成图像中提取特征的CLIPImageProcessor;用作安全检查器的输入。

根据文本指令进行像素级图像编辑的管道(基于Stable Diffusion)。

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

管道还继承以下加载方法

__call__

< >

( prompt: Union = None image: Union = None num_inference_steps: int = 100 guidance_scale: float = 7.5 image_guidance_scale: float = 1.5 negative_prompt: 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 output_type: Optional = 'pil' return_dict: bool = True callback_on_step_end: Union = None callback_on_step_end_tensor_inputs: List = ['latents'] cross_attention_kwargs: Optional = None **kwargs ) StableDiffusionPipelineOutputtuple

参数

  • 提示 (strList[str], 可选) — 指导图像生成的提示或提示列表。如果未定义,则需要传递prompt_embeds
  • 图像 (torch.Tensor np.ndarray, PIL.Image.Image, List[torch.Tensor], List[PIL.Image.Image], 或 List[np.ndarray]) — 表示要根据prompt重新绘制的图像批次的图像或张量。也可以接受图像潜变量作为图像,但如果直接传递潜变量,则不会再次对其进行编码。
  • 推理步数 (int, 可选, 默认为 100) — 降噪步骤的数量。更多的降噪步骤通常会导致更高的图像质量,但代价是推理速度较慢。
  • 引导尺度 (float, 可选, 默认为 7.5) — 较高的引导尺度值鼓励模型生成与文本prompt密切相关的图像,但代价是降低图像质量。当guidance_scale > 1时启用引导尺度。
  • 图像引导尺度 (float, 可选, 默认为 1.5) — 将生成的图像推向初始图像。通过设置image_guidance_scale > 1启用图像引导尺度。较高的图像引导尺度鼓励生成与源图像密切相关的图像,通常会降低图像质量。此管道需要至少为1的值。

  • negative_prompt (strList[str], 可选) — 指导图像生成中不包含什么的提示或提示。如果未定义,则需要改为传递 negative_prompt_embeds。在不使用引导(guidance_scale < 1)时忽略。
  • num_images_per_prompt (int, 可选,默认为 1) — 每个提示生成图像的数量。
  • eta (float, 可选,默认为 0.0) — 对应于来自 DDIM 论文的参数 eta (η)。仅适用于 DDIMScheduler,在其他调度程序中被忽略。
  • generator (torch.Generator, 可选) — 用于使生成确定性的 torch.Generator
  • latents (torch.Tensor, 可选) — 从高斯分布采样的预生成的噪声潜在变量,用作图像生成的输入。可用于使用不同的提示调整相同的生成。如果未提供,则通过使用提供的随机 generator 采样生成潜在变量张量。
  • prompt_embeds (torch.Tensor, 可选) — 预生成的文本嵌入。可用于轻松调整文本输入(提示加权)。如果未提供,则从 prompt 输入参数生成文本嵌入。
  • negative_prompt_embeds (torch.Tensor, 可选) — 预生成的负文本嵌入。可用于轻松调整文本输入(提示加权)。如果未提供,则从 negative_prompt 输入参数生成 negative_prompt_embeds。ip_adapter_image — (PipelineImageInput, 可选): 可选图像输入,用于与 IP 适配器配合使用。
  • output_type (str, 可选,默认为 "pil") — 生成的图像的输出格式。在 PIL.Imagenp.array 之间选择。
  • return_dict (bool, 可选,默认为 True) — 是否返回 StableDiffusionPipelineOutput 而不是普通元组。
  • callback_on_step_end (Callable, PipelineCallback, MultiPipelineCallbacks, 可选) — 在推理期间每个去噪步骤结束时调用的函数或 PipelineCallbackMultiPipelineCallbacks 的子类。具有以下参数: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 属性中列出的变量。
  • cross_attention_kwargs (dict可选) — 如果指定,则将此关键字参数字典传递给 self.processor 中定义的 AttentionProcessor

返回值

StableDiffusionPipelineOutputtuple

如果 return_dictTrue,则返回 StableDiffusionPipelineOutput,否则返回一个 tuple,其中第一个元素是生成的图像列表,第二个元素是 bool 值列表,指示相应的生成图像是否包含“不适合工作场所”(nsfw)内容。

管道生成调用的函数。

示例

>>> import PIL
>>> import requests
>>> import torch
>>> from io import BytesIO

>>> from diffusers import StableDiffusionInstructPix2PixPipeline


>>> def download_image(url):
...     response = requests.get(url)
...     return PIL.Image.open(BytesIO(response.content)).convert("RGB")


>>> img_url = "https://huggingface.co/datasets/diffusers/diffusers-images-docs/resolve/main/mountain.png"

>>> image = download_image(img_url).resize((512, 512))

>>> pipe = StableDiffusionInstructPix2PixPipeline.from_pretrained(
...     "timbrooks/instruct-pix2pix", torch_dtype=torch.float16
... )
>>> pipe = pipe.to("cuda")

>>> prompt = "make the mountains snowy"
>>> image = pipe(prompt=prompt, image=image).images[0]

load_textual_inversion

< >

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

参数

  • pretrained_model_name_or_path (stros.PathLikeList[str or os.PathLike]DictList[Dict]) — 可以是以下之一或它们的列表:

    • 一个字符串,预训练模型在 Hub 上托管的模型 ID(例如 sd-concepts-library/low-poly-hd-logos-icons)。
    • 包含文本反演权重的目录路径(例如 ./my_text_inversion_directory/)。
    • 包含文本反演权重的文件路径(例如 ./my_text_inversions.pt)。
    • 一个 torch 状态字典
  • token (strList[str]可选) — 覆盖要用于文本反演权重的令牌。如果 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 (strbool, 可选) — 用作远程文件 HTTP 授权令牌的令牌。如果为 True,则使用 diffusers-cli login 生成的令牌(存储在 ~/.huggingface 中)。
  • revision (str, 可选,默认为 "main") — 要使用的特定模型版本。它可以是分支名称、标签名称、提交 ID 或 Git 允许的任何标识符。
  • subfolder (str, 可选,默认为 "") — Hub 或本地更大模型存储库中模型文件所在的子文件夹位置。
  • mirror (str, 可选) — 如果您在中国下载模型,则镜像源可以解决可访问性问题。我们不保证源的及时性或安全性,您应该参考镜像站点以获取更多信息。

将文本反转嵌入加载到 StableDiffusionPipeline 的文本编码器中(支持 🤗 Diffusers 和 Automatic1111 格式)。

示例

要加载 🤗 Diffusers 格式的文本反转嵌入向量

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 格式的文本反转嵌入向量,请确保首先下载向量(例如从 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")

load_lora_weights

< >

( pretrained_model_name_or_path_or_dict: Union adapter_name = None **kwargs )

参数

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

pretrained_model_name_or_path_or_dict 中指定的 LoRA 权重加载到 self.unetself.text_encoder 中。

所有 kwargs 将转发到 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 (stros.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 层的状态字典。必须显式传递文本编码器 LoRA 状态字典,因为它来自 🤗 Transformers。
  • is_main_process (bool, 可选,默认为 True) — 调用此函数的进程是否是主进程。在分布式训练期间很有用,并且您需要在所有进程上调用此函数。在这种情况下,仅在主进程上将 is_main_process=True 设置为避免竞争条件。
  • save_function (Callable) — 用于保存状态字典的函数。在需要用其他方法替换 torch.save 的分布式训练期间很有用。可以使用环境变量 DIFFUSERS_SAVE_MODE 进行配置。
  • safe_serialization (bool, 可选,默认为 True) — 是否使用 safetensors 或使用 pickle 的传统 PyTorch 方式保存模型。

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

StableDiffusionXLInstructPix2PixPipeline

diffusers.StableDiffusionXLInstructPix2PixPipeline

< >

( vae: AutoencoderKL text_encoder: CLIPTextModel text_encoder_2: CLIPTextModelWithProjection tokenizer: CLIPTokenizer tokenizer_2: CLIPTokenizer unet: UNet2DConditionModel scheduler: KarrasDiffusionSchedulers force_zeros_for_empty_prompt: bool = True add_watermarker: Optional = None is_cosxl_edit: Optional = False )

参数

  • 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 结合使用以对编码图像潜在表示进行去噪的调度器。可以是 DDIMSchedulerLMSDiscreteSchedulerPNDMScheduler 之一。
  • requires_aesthetics_score (bool, 可选, 默认为 "False") — unet 是否需要在推理期间传递美学评分条件。另请参阅 stabilityai/stable-diffusion-xl-refiner-1-0 的配置。
  • add_watermarker (bool, 可选) — 是否使用invisible_watermark 库 为输出图像添加水印。如果未定义,则如果安装了该包,则默认为 True,否则不使用水印。
  • is_cosxl_edit (bool, 可选) — 设置后,图像潜变量会被缩放。

基于 Stable Diffusion XL 的像素级图像编辑管道,通过遵循文本指令进行操作。

此模型继承自DiffusionPipeline。请查看超类文档,了解库为所有管道实现的通用方法(例如下载或保存、在特定设备上运行等)。

管道还继承以下加载方法

__call__

< >

( prompt: Union = None prompt_2: Union = None image: Union = None height: Optional = None width: Optional = None num_inference_steps: int = 100 denoising_end: Optional = None guidance_scale: float = 5.0 image_guidance_scale: float = 1.5 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 callback: Optional = None callback_steps: int = 1 cross_attention_kwargs: Optional = None guidance_rescale: float = 0.0 original_size: Tuple = None crops_coords_top_left: Tuple = (0, 0) target_size: Tuple = None ) ~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutputtuple

参数

  • prompt (strList[str], 可选) — 指导图像生成的提示或提示列表。如果未定义,则必须传递 prompt_embeds 代替。
  • prompt_2 (strList[str], 可选) — 要发送到 tokenizer_2text_encoder_2 的提示或提示列表。如果未定义,则两个文本编码器都使用 prompt
  • image (torch.TensorPIL.Image.Imagenp.ndarrayList[torch.Tensor]List[PIL.Image.Image]List[np.ndarray]) — 要使用管道修改的图像(或图像列表)。
  • 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) — 降噪步骤的数量。更多的降噪步骤通常会导致更高的图像质量,但推理速度会变慢。
  • denoising_end (float可选) — 指定时,确定在有意提前终止之前要完成的总降噪过程的比例(介于 0.0 和 1.0 之间)。因此,返回的样本将仍然保留由调度程序选择的离散时间步长所确定的相当数量的噪声。当此管道成为“降噪混合”多管道设置的一部分时,最好使用 denoising_end 参数,如 改进图像输出 中所述。
  • guidance_scale (float可选,默认为 5.0) — 如 无分类器扩散引导 中所定义的引导尺度。guidance_scale 定义为 Imagen 论文 公式 2 中的 w。通过将 guidance_scale 设置为 > 1 来启用引导尺度。较高的引导尺度鼓励生成与文本 prompt 密切相关的图像,通常以降低图像质量为代价。
  • image_guidance_scale (float可选,默认为 1.5) — 图像引导尺度用于将生成的图像推向初始图像 image。通过将 image_guidance_scale 设置为 > 1 来启用图像引导尺度。较高的图像引导尺度鼓励生成与源图像 image 密切相关的图像,通常以降低图像质量为代价。此管道需要至少为 1 的值。
  • negative_prompt (strList[str]可选) — 不引导图像生成的提示或提示。如果未定义,则必须传递 negative_prompt_embeds。在不使用引导时(即,如果 guidance_scale 小于 1)将被忽略。
  • negative_prompt_2 (strList[str]可选) — 要发送到 tokenizer_2text_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.GeneratorList[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
  • output_type (str, 可选,默认为 "pil") — 生成图像的输出格式。在 PIL 之间选择:PIL.Image.Imagenp.array
  • return_dict (bool, 可选,默认为 True) — 是否返回 ~pipelines.stable_diffusion.StableDiffusionXLPipelineOutput 而不是普通元组。
  • callback (Callable, 可选) — 一个函数,在推理期间每隔 callback_steps 步就会被调用一次。该函数将使用以下参数被调用:callback(step: int, timestep: int, latents: torch.Tensor)
  • callback_steps (int, 可选,默认为 1) — callback 函数将被调用的频率。如果未指定,则回调将在每个步骤中被调用。
  • guidance_rescale (float, 可选, 默认为 0.0) — 由 Common Diffusion Noise Schedules and Sample Steps are Flawed 提出的引导重缩放因子,guidance_scaleCommon Diffusion Noise Schedules and Sample Steps are Flawed 的公式 16 中定义为 φ。引导重缩放因子应在使用零终端信噪比时修复过度曝光。
  • original_size (Tuple[int], 可选, 默认为 (1024, 1024)) — 如果 original_sizetarget_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 节所述。
  • 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 节所述。可用于通过影响负文本条件来模拟生成图像的美学评分。

返回值

~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutputtuple

如果 return_dict 为 True,则为 ~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput,否则为 tuple。当返回元组时,第一个元素是包含生成图像的列表。

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

示例

>>> import torch
>>> from diffusers import StableDiffusionXLInstructPix2PixPipeline
>>> from diffusers.utils import load_image

>>> resolution = 768
>>> image = load_image(
...     "https://hf.co/datasets/diffusers/diffusers-images-docs/resolve/main/mountain.png"
... ).resize((resolution, resolution))
>>> edit_instruction = "Turn sky into a cloudy one"

>>> pipe = StableDiffusionXLInstructPix2PixPipeline.from_pretrained(
...     "diffusers/sdxl-instructpix2pix-768", torch_dtype=torch.float16
... ).to("cuda")

>>> edited_image = pipe(
...     prompt=edit_instruction,
...     image=image,
...     height=resolution,
...     width=resolution,
...     guidance_scale=3.0,
...     image_guidance_scale=1.5,
...     num_inference_steps=30,
... ).images[0]
>>> edited_image

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 )

参数

  • prompt (strList[str], 可选) — 要编码的提示
  • prompt_2 (strList[str], 可选) — 发送到 tokenizer_2text_encoder_2 的提示或提示列表。如果未定义,则在两个文本编码器中都使用 prompt 设备 — (torch.device): torch 设备
  • num_images_per_prompt (int) — 每个提示应生成的图像数量
  • do_classifier_free_guidance (bool) — 是否使用分类器自由引导
  • negative_prompt (strList[str], 可选) — 不引导图像生成的提示或提示列表。如果未定义,则必须传递 negative_prompt_embeds。在不使用引导时被忽略(即,如果 guidance_scale 小于 1,则被忽略)。
  • negative_prompt_2 (strList[str], 可选) — 发送到 tokenizer_2text_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 比例。

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

< > GitHub 上的更新