Diffusers 文档
文本到图像
并获得增强的文档体验
开始使用
文本到图像
Stable Diffusion 模型由 CompVis、Stability AI、Runway 和 LAION 的研究人员和工程师创建。StableDiffusionPipeline 能够根据任何文本输入生成逼真的图像。它在 LAION-5B 数据集的一个子集中的 512x512 图像上进行训练。此模型使用冻结的 CLIP ViT-L/14 文本编码器，通过文本提示来调节模型。凭借其 860M UNet 和 123M 文本编码器，该模型相对轻量，可以在消费级 GPU 上运行。潜在扩散是 Stable Diffusion 构建在其基础上的研究。它由 Robin Rombach、Andreas Blattmann、Dominik Lorenz、Patrick Esser、Björn Ommer 在使用潜在扩散模型进行高分辨率图像合成一文中提出。
论文摘要如下：
通过将图像形成过程分解为去噪自编码器的顺序应用，扩散模型（DM）在图像数据及其他领域取得了最先进的合成结果。此外，它们的公式允许一种引导机制来控制图像生成过程而无需重新训练。然而，由于这些模型通常直接在像素空间中操作，因此强大 DM 的优化通常需要数百个 GPU 日，并且由于顺序评估，推理成本很高。为了在有限的计算资源上实现 DM 训练，同时保持其质量和灵活性，我们将其应用于强大的预训练自编码器的潜在空间。与之前的工作不同，在这种表示上训练扩散模型首次允许在复杂度降低和细节保留之间达到一个接近最优的点，极大地提高了视觉保真度。通过在模型架构中引入交叉注意力层，我们将扩散模型转变为用于文本或边界框等一般条件输入以及以卷积方式实现高分辨率合成的强大而灵活的生成器。我们的潜在扩散模型（LDM）在图像修复方面达到了新的最先进水平，并在各种任务（包括无条件图像生成、语义场景合成和超分辨率）上实现了高度竞争的性能，同时与基于像素的 DM 相比显著降低了计算要求。代码可在 https://github.com/CompVis/latent-diffusion 获得。
务必查看 Stable Diffusion 的 提示 部分，了解如何探索调度器速度和质量之间的权衡，以及如何高效地重用管道组件！
如果您有兴趣将其中一个官方检查点用于某个任务，请探索 CompVis、Runway 和 Stability AI Hub 组织！
StableDiffusionPipeline
class diffusers.StableDiffusionPipeline
< source >( 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）。
- tokenizer (CLIPTokenizer) — 用于文本分词的
CLIPTokenizer。 - unet (UNet2DConditionModel) — 用于对编码图像潜在表示进行去噪的
UNet2DConditionModel。 - scheduler (SchedulerMixin) — 与
unet结合用于对编码图像潜在表示进行去噪的调度器。可以是 DDIMScheduler、LMSDiscreteScheduler 或 PNDMScheduler 之一。 - safety_checker (
StableDiffusionSafetyChecker) — 分类模块，用于评估生成的图像是否可能被视为具有攻击性或有害。有关模型潜在危害的更多详细信息，请参阅模型卡。 - feature_extractor (CLIPImageProcessor) — 用于从生成图像中提取特征的
CLIPImageProcessor；用作safety_checker的输入。
用于使用 Stable Diffusion 进行文本到图像生成的管道。
此模型继承自 DiffusionPipeline。有关所有流水线实现的通用方法（下载、保存、在特定设备上运行等），请查看超类文档。
该管道还继承了以下加载方法
- load_textual_inversion() 用于加载文本反演嵌入
- load_lora_weights() 用于加载 LoRA 权重
- save_lora_weights() 用于保存 LoRA 权重
- from_single_file() 用于加载
.ckpt文件 - load_ip_adapter() 用于加载 IP 适配器
__call__
< source >( prompt: typing.Union[str, typing.List[str]] = None height: typing.Optional[int] = None width: typing.Optional[int] = None num_inference_steps: int = 50 timesteps: typing.List[int] = None sigmas: typing.List[float] = None guidance_scale: float = 7.5 negative_prompt: 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 ip_adapter_image: typing.Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, typing.List[PIL.Image.Image], typing.List[numpy.ndarray], typing.List[torch.Tensor], NoneType] = None ip_adapter_image_embeds: typing.Optional[typing.List[torch.Tensor]] = None output_type: typing.Optional[str] = 'pil' return_dict: bool = True cross_attention_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None guidance_rescale: float = 0.0 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'] **kwargs ) → StableDiffusionPipelineOutput or 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参数的调度器。如果未定义，将使用传入num_inference_steps时的默认行为。必须按降序排列。 - sigmas (
List[float], 可选) — 用于去噪过程的自定义 sigmas，适用于在set_timesteps方法中支持sigmas参数的调度器。如果未定义，将使用传入num_inference_steps时的默认行为。 - guidance_scale (
float, 可选, 默认为 7.5) — 较高的引导比例值会鼓励模型生成与文本prompt紧密相关的图像，但会牺牲图像质量。当guidance_scale > 1时，启用引导比例。 - negative_prompt (
str或List[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输入参数生成negative_prompt_embeds。 - ip_adapter_image — (
PipelineImageInput, 可选)：用于 IP 适配器的可选图像输入。 - ip_adapter_image_embeds (
List[torch.Tensor], 可选) — IP-Adapter 的预生成图像嵌入。它应该是一个列表，长度与 IP 适配器数量相同。每个元素都应该是一个形状为(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。 - guidance_rescale (
float, 可选, 默认为 0.0) — 来自 Common Diffusion Noise Schedules and Sample Steps are Flawed 的引导重缩放因子。引导重缩放因子应在使用零终端信噪比时修复过曝问题。 - 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，其中第一个元素是生成的图像列表，第二个元素是指示相应生成的图像是否包含“不适合工作”(nsfw) 内容的 bool 列表。
用于生成的管道的调用函数。
示例
>>> import torch
>>> from diffusers import StableDiffusionPipeline
>>> pipe = StableDiffusionPipeline.from_pretrained(
... "stable-diffusion-v1-5/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]enable_attention_slicing
< source >( slice_size: typing.Union[int, str, NoneType] = 'auto' )
启用切片注意力计算。当启用此选项时，注意力模块将输入张量分割成切片，以分几步计算注意力。对于多个注意力头，计算按每个头顺序执行。这有助于节省一些内存，但会略微降低速度。
⚠️ 如果您已经在使用 PyTorch 2.0 或 xFormers 的 scaled_dot_product_attention (SDPA)，请不要启用注意力切片。这些注意力计算已经非常内存高效，因此您不需要启用此功能。如果您启用带有 SDPA 或 xFormers 的注意力切片，可能会导致严重的性能下降！
示例
>>> import torch
>>> from diffusers import StableDiffusionPipeline
>>> pipe = StableDiffusionPipeline.from_pretrained(
... "stable-diffusion-v1-5/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]禁用切片注意力计算。如果之前调用过 enable_attention_slicing，则注意力将一步计算完成。
启用切片 VAE 解码。启用此选项后，VAE 会将输入张量分片，分步计算解码。这有助于节省一些内存并允许更大的批次大小。
禁用切片 VAE 解码。如果之前启用了 enable_vae_slicing，此方法将返回一步计算解码。
enable_xformers_memory_efficient_attention
< source >( attention_op: typing.Optional[typing.Callable] = 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)禁用 xFormers 的内存高效注意力。
启用平铺 VAE 解码。启用此选项后，VAE 将把输入张量分割成瓦片，分多步计算编码和解码。这对于节省大量内存和处理更大的图像非常有用。
禁用平铺 VAE 解码。如果之前启用了 enable_vae_tiling，此方法将恢复一步计算解码。
load_textual_inversion
< source >( pretrained_model_name_or_path: typing.Union[str, typing.List[str], typing.Dict[str, torch.Tensor], typing.List[typing.Dict[str, torch.Tensor]]] token: typing.Union[str, typing.List[str], NoneType] = None tokenizer: typing.Optional[ForwardRef('PreTrainedTokenizer')] = None text_encoder: typing.Optional[ForwardRef('PreTrainedModel')] = None **kwargs )
参数
- pretrained_model_name_or_path (
str或os.PathLike或List[str 或 os.PathLike]或Dict或List[Dict]) — 可以是以下之一或它们的列表：- Hub 上托管的预训练模型的模型 ID 字符串（例如
sd-concepts-library/low-poly-hd-logos-icons）。 - 包含文本反转权重的目录路径（例如
./my_text_inversion_directory/）。 - 包含文本反转权重的文件路径（例如
./my_text_inversions.pt）。 - torch 状态字典。
- Hub 上托管的预训练模型的模型 ID 字符串（例如
- token (
str或List[str], 可选) — 覆盖用于文本反转权重的 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 格式。
- 保存的文本反转文件为 🤗 Diffusers 格式，但以特定权重名称（例如
- 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 下载模型。 - hf_token (
str或 bool, 可选) — 用作远程文件 HTTP 承载授权的 token。如果为True，则使用从diffusers-cli login生成的 token（存储在~/.huggingface中）。 - revision (
str, 可选, 默认为"main") — 要使用的特定模型版本。它可以是分支名称、标签名称、提交 ID 或 Git 允许的任何标识符。 - subfolder (
str, 可选, 默认为"") — 模型文件中在 Hub 或本地更大模型仓库中的子文件夹位置。 - mirror (
str, 可选) — 如果在中国下载模型，用于解决可访问性问题的镜像源。我们不保证来源的时效性或安全性，您应参考镜像站点获取更多信息。
将文本反转嵌入加载到 StableDiffusionPipeline 的文本编码器中（支持 🤗 Diffusers 和 Automatic1111 两种格式）。
示例
加载 🤗 Diffusers 格式的文本反转嵌入向量
from diffusers import StableDiffusionPipeline
import torch
model_id = "stable-diffusion-v1-5/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 = "stable-diffusion-v1-5/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
< source >( pretrained_model_link_or_path **kwargs )
参数
- pretrained_model_link_or_path (
str或os.PathLike, 可选) — 可以是以下之一：- Hub 上的
.ckpt文件链接（例如"https://huggingface.co/）。/blob/main/ .ckpt" - 包含所有管道权重的文件路径。
- Hub 上的
- torch_dtype (
str或torch.dtype, 可选) — 覆盖默认的torch.dtype并使用其他 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 承载授权的 token。如果为True，则使用从diffusers-cli login生成的 token（存储在~/.huggingface中）。 - revision (
str, 可选, 默认为"main") — 要使用的特定模型版本。它可以是分支名称、标签名称、提交 ID 或 Git 允许的任何标识符。 - original_config_file (
str, 可选) — 用于训练模型的原始配置文件路径。如果未提供，将从检查点文件推断配置文件。 - config (
str, 可选) — 可以是以下之一：- Hub 上预训练管道的仓库 ID 字符串（例如
CompVis/ldm-text2im-large-256）。 - 包含 Diffusers 格式管道组件配置的目录路径（例如
./my_pipeline_directory/）。
- Hub 上预训练管道的仓库 ID 字符串（例如
- disable_mmap (`bool`, 可选, 默认为 `False`) — 加载 Safetensors 模型时是否禁用内存映射 (mmap)。当模型位于网络挂载或硬盘上时，此选项可能表现更好。
- 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/stable-diffusion-v1-5/stable-diffusion-v1-5/blob/main/v1-5-pruned-emaonly.ckpt",
... torch_dtype=torch.float16,
... )
>>> pipeline.to("cuda")load_lora_weights
< source >( pretrained_model_name_or_path_or_dict: typing.Union[str, typing.Dict[str, torch.Tensor]] adapter_name: typing.Optional[str] = None hotswap: bool = False **kwargs )
参数
- pretrained_model_name_or_path_or_dict (
str或os.PathLike或dict) — 参见 lora_state_dict()。 - adapter_name (
str, 可选) — 用于引用已加载的适配器模型的适配器名称。如果未指定，将使用default_{i}，其中 i 为正在加载的适配器总数。 - low_cpu_mem_usage (
bool, 可选) — 仅加载预训练的 LoRA 权重，而不初始化随机权重，从而加快模型加载速度。 - hotswap (
bool, 可选) — 默认为False。是否将现有（LoRA）适配器原地替换为新加载的适配器。这意味着，它不会加载额外的适配器，而是将现有适配器权重替换为新适配器的权重。这可以更快且更节省内存。然而，热插拔的主要优点是，当模型使用 torch.compile 编译时，加载新适配器不需要重新编译模型。使用热插拔时，传入的adapter_name应该是已加载适配器的名称。如果新适配器和旧适配器具有不同的等级和/或 LoRA alpha（即缩放），您需要在加载适配器之前调用一个额外的方法：
将 pretrained_model_name_or_path_or_dict 中指定的 LoRA 权重加载到 self.unet 和 self.text_encoder 中。
所有 kwargs 都转发到 self.lora_state_dict。
有关如何加载 state dict 的更多详细信息，请参阅 lora_state_dict()。
有关如何将 state dict 加载到 self.unet 中的更多详细信息，请参阅 load_lora_into_unet()。
有关如何将 state dict 加载到 self.text_encoder 中的更多详细信息，请参阅 load_lora_into_text_encoder()。
save_lora_weights
< 来源 >( save_directory: typing.Union[str, os.PathLike] unet_lora_layers: typing.Dict[str, typing.Union[torch.nn.modules.module.Module, torch.Tensor]] = None text_encoder_lora_layers: typing.Dict[str, torch.nn.modules.module.Module] = None is_main_process: bool = True weight_name: str = None save_function: typing.Callable = None safe_serialization: bool = True unet_lora_adapter_metadata = None text_encoder_lora_adapter_metadata = None )
参数
- 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 层状态字典。必须显式传递文本编码器 LoRA 状态字典，因为它来自 🤗 Transformers。 - is_main_process (
bool, 可选, 默认为True) — 调用此过程是否为主过程。在分布式训练期间需要所有过程都调用此函数时很有用。在这种情况下，仅在主过程中设置is_main_process=True以避免竞态条件。 - save_function (
Callable) — 用于保存状态字典的函数。在分布式训练中需要用其他方法替换torch.save时很有用。可以通过环境变量DIFFUSERS_SAVE_MODE进行配置。 - safe_serialization (
bool, 可选, 默认为True) — 是否使用safetensors或传统 PyTorch 方式（使用pickle）保存模型。 - unet_lora_adapter_metadata — 与 unet 相关的 LoRA 适配器元数据，将与状态字典一起序列化。
- text_encoder_lora_adapter_metadata — 与文本编码器相关的 LoRA 适配器元数据，将与状态字典一起序列化。
保存对应于 UNet 和文本编码器的 LoRA 参数。
encode_prompt
< 来源 >( prompt device num_images_per_prompt do_classifier_free_guidance negative_prompt = None prompt_embeds: typing.Optional[torch.Tensor] = None negative_prompt_embeds: typing.Optional[torch.Tensor] = None lora_scale: typing.Optional[float] = None clip_skip: typing.Optional[int] = None )
参数
- prompt (
str或List[str], 可选) — 要编码的提示。 - device — (
torch.device): torch 设备 - num_images_per_prompt (
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_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
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]] )
Stable Diffusion 管道的输出类。
FlaxStableDiffusionPipeline
class diffusers.FlaxStableDiffusionPipeline
< 来源 >( vae: FlaxAutoencoderKL text_encoder: FlaxCLIPTextModel tokenizer: CLIPTokenizer unet: FlaxUNet2DConditionModel scheduler: typing.Union[diffusers.schedulers.scheduling_ddim_flax.FlaxDDIMScheduler, diffusers.schedulers.scheduling_pndm_flax.FlaxPNDMScheduler, diffusers.schedulers.scheduling_lms_discrete_flax.FlaxLMSDiscreteScheduler, diffusers.schedulers.scheduling_dpmsolver_multistep_flax.FlaxDPMSolverMultistepScheduler] 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。 - scheduler (SchedulerMixin) — 与
unet结合使用的调度器，用于对编码图像潜在表示进行去噪。可以是FlaxDDIMScheduler、FlaxLMSDiscreteScheduler、FlaxPNDMScheduler或FlaxDPMSolverMultistepScheduler之一。 - safety_checker (
FlaxStableDiffusionSafetyChecker) — 分类模块，用于评估生成的图像是否可能被认为是冒犯性或有害的。有关模型潜在危害的更多详细信息，请参阅模型卡。 - feature_extractor (CLIPImageProcessor) — 用于从生成的图像中提取特征的
CLIPImageProcessor；用作safety_checker的输入。
基于 Flax 的 Stable Diffusion 文本到图像生成管道。
此模型继承自 FlaxDiffusionPipeline。有关所有管道实现的通用方法（下载、保存、在特定设备上运行等），请查看超类文档。
__call__
< 来源 >( prompt_ids: <function array at 0x7fc460e1d1b0> params: typing.Union[typing.Dict, flax.core.frozen_dict.FrozenDict] prng_seed: Array num_inference_steps: int = 50 height: typing.Optional[int] = None width: typing.Optional[int] = None guidance_scale: typing.Union[float, jax.Array] = 7.5 latents: Array = None neg_prompt_ids: Array = None return_dict: bool = True jit: bool = False ) → FlaxStableDiffusionPipelineOutput 或 tuple
参数
- prompt (
str或List[str], 可选) — 引导图像生成的提示。 - 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) — 去噪步数。更多去噪步数通常会带来更高质量的图像，但推理速度会变慢。 - guidance_scale (
float, 可选, 默认为 7.5) — 更高的引导比例值鼓励模型生成与文本prompt紧密相关的图像，但图像质量会降低。当guidance_scale > 1时，启用引导比例。 - latents (
jnp.ndarray, 可选) — 从高斯分布中采样的预生成噪声潜在表示，用作图像生成的输入。可用于使用不同的提示调整相同的生成。如果未提供，则使用提供的随机generator采样生成潜在数组。 - jit (
bool, 默认为False) — 是否运行生成和安全评分函数的pmap版本。此参数存在是因为
__call__尚未实现端到端 pmap。它将在未来版本中移除。 - return_dict (
bool, 可选, 默认为True) — 是否返回 FlaxStableDiffusionPipelineOutput 而不是普通元组。
返回
如果 return_dict 为 True，则返回 FlaxStableDiffusionPipelineOutput，否则返回一个 tuple，其中第一个元素是生成的图像列表，第二个元素是指示相应生成的图像是否包含“不适合工作”(nsfw) 内容的 bool 列表。
用于生成的管道的调用函数。
示例
>>> 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(
... "stable-diffusion-v1-5/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: typing.List[bool] )
Flax-based Stable Diffusion 管道的输出类。
返回一个新对象，用新值替换指定的字段。