Hugging Face 的 LOGO

Diffusers 文档

ControlNetUnionModel

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

ControlNetUnionModel

ControlNetUnionModel 是 Stable Diffusion XL 的 ControlNet 实现。

ControlNet 模型由 xinsir6 在 ControlNetPlus 中引入。它支持多个条件输入而无需增加计算量。

我们设计了一种新架构，可以在条件文本到图像生成中支持 10 多种控制类型，并且可以生成视觉效果与 midjourney 媲美的高分辨率图像。该网络基于原始 ControlNet 架构，我们提出了两个新模块：1. 扩展原始 ControlNet 以支持使用相同网络参数的不同图像条件。2. 支持多个条件输入而无需增加计算卸载，这对于想要详细编辑图像的设计师来说尤其重要，不同的条件使用相同的条件编码器，无需额外的计算或参数。

加载

默认情况下，应使用 ControlNetUnionModel 加载 from_pretrained()。

from diffusers import StableDiffusionXLControlNetUnionPipeline, ControlNetUnionModel

controlnet = ControlNetUnionModel.from_pretrained("xinsir/controlnet-union-sdxl-1.0")
pipe = StableDiffusionXLControlNetUnionPipeline.from_pretrained("stabilityai/stable-diffusion-xl-base-1.0", controlnet=controlnet)

ControlNetUnionModel

class diffusers.ControlNetUnionModel

< >

( in_channels: int = 4 conditioning_channels: int = 3 flip_sin_to_cos: bool = True freq_shift: int = 0 down_block_types: typing.Tuple[str, ...] = ('CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'DownBlock2D') only_cross_attention: typing.Union[bool, typing.Tuple[bool]] = False block_out_channels: typing.Tuple[int, ...] = (320, 640, 1280, 1280) layers_per_block: int = 2 downsample_padding: int = 1 mid_block_scale_factor: float = 1 act_fn: str = 'silu' norm_num_groups: typing.Optional[int] = 32 norm_eps: float = 1e-05 cross_attention_dim: int = 1280 transformer_layers_per_block: typing.Union[int, typing.Tuple[int, ...]] = 1 encoder_hid_dim: typing.Optional[int] = None encoder_hid_dim_type: typing.Optional[str] = None attention_head_dim: typing.Union[int, typing.Tuple[int, ...]] = 8 num_attention_heads: typing.Union[int, typing.Tuple[int, ...], NoneType] = None use_linear_projection: bool = False class_embed_type: typing.Optional[str] = None addition_embed_type: typing.Optional[str] = None addition_time_embed_dim: typing.Optional[int] = None num_class_embeds: typing.Optional[int] = None upcast_attention: bool = False resnet_time_scale_shift: str = 'default' projection_class_embeddings_input_dim: typing.Optional[int] = None controlnet_conditioning_channel_order: str = 'rgb' conditioning_embedding_out_channels: typing.Optional[typing.Tuple[int, ...]] = (48, 96, 192, 384) global_pool_conditions: bool = False addition_embed_type_num_heads: int = 64 num_control_type: int = 6 num_trans_channel: int = 320 num_trans_head: int = 8 num_trans_layer: int = 1 num_proj_channel: int = 320 )

参数

  • in_channels (int, 默认为 4) — 输入样本中的通道数。
  • flip_sin_to_cos (bool, 默认为 True) — 是否在时间嵌入中将 sin 翻转为 cos。
  • freq_shift (int, 默认为 0) — 应用于时间嵌入的频率偏移。
  • down_block_types (tuple[str], 默认为 ("CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "DownBlock2D")) — 要使用的下采样块元组。
  • only_cross_attention (Union[bool, Tuple[bool]], 默认为 False) —
  • block_out_channels (tuple[int], 默认为 (320, 640, 1280, 1280)) — 每个块的输出通道元组。
  • layers_per_block (int, 默认为 2) — 每个块的层数。
  • downsample_padding (int, 默认为 1) — 下采样卷积要使用的填充。
  • mid_block_scale_factor (float, 默认为 1) — 中间块的比例因子。
  • act_fn (str, 默认为 “silu”) — 要使用的激活函数。
  • norm_num_groups (int, 可选, 默认为 32) — 归一化要使用的组数。如果为 None，则在后处理中跳过归一化和激活层。
  • norm_eps (float, 默认为 1e-5) — 归一化要使用的 epsilon。
  • cross_attention_dim (int, 默认为 1280) — 交叉注意力特征的维度。
  • transformer_layers_per_block (int 或 Tuple[int], 可选, 默认为 1) — 类型为 BasicTransformerBlock 的 transformer 块的数量。仅与 ~models.unet_2d_blocks.CrossAttnDownBlock2D, ~models.unet_2d_blocks.CrossAttnUpBlock2D, ~models.unet_2d_blocks.UNetMidBlock2DCrossAttn 相关。
  • encoder_hid_dim (int, 可选, 默认为 None) — 如果定义了 encoder_hid_dim_type，则 encoder_hidden_states 将从 encoder_hid_dim 维度投影到 cross_attention_dim。
  • encoder_hid_dim_type (str, 可选, 默认为 None) — 如果给定，encoder_hidden_states 和其他可能的嵌入将根据 encoder_hid_dim_type 下投影到维度为 cross_attention 的文本嵌入。
  • attention_head_dim (Union[int, Tuple[int]], 默认为 8) — 注意力头的维度。
  • use_linear_projection (bool, 默认为 False) —
  • class_embed_type (str, 可选, 默认为 None) — 要使用的类嵌入类型，最终与时间嵌入求和。可选择 None, "timestep", "identity", "projection", 或 "simple_projection"。
  • addition_embed_type (str, 可选, 默认为 None) — 配置一个可选嵌入，该嵌入将与时间嵌入求和。可选择 None 或 “text”。“text”将使用 TextTimeEmbedding 层。
  • num_class_embeds (int, 可选, 默认为 0) — 当 class_embed_type 等于 None 时，要投影到 time_embed_dim 的可学习嵌入矩阵的输入维度。当 class_embed_type="projection" 时必需。
  • upcast_attention (bool, 默认为 False) —
  • resnet_time_scale_shift (str, 默认为 "default") — ResNet 块的时间尺度偏移配置（参见 ResnetBlock2D）。可选择 default 或 scale_shift。
  • projection_class_embeddings_input_dim (int, 可选, 默认为 None) — 当 class_embed_type="projection" 时，class_labels 输入的维度。当 class_embed_type="projection" 时必需。
  • controlnet_conditioning_channel_order (str, 默认为 "rgb") — 条件图像的通道顺序。如果为 bgr，将转换为 rgb。
  • conditioning_embedding_out_channels (tuple[int], 可选, 默认为 (48, 96, 192, 384)) — conditioning_embedding 层中每个块的输出通道元组。
  • global_pool_conditions (bool, 默认为 False) —

ControlNetUnion 模型。

forward

< >

( sample: Tensor timestep: typing.Union[torch.Tensor, float, int] encoder_hidden_states: Tensor controlnet_cond: typing.List[torch.Tensor] control_type: Tensor control_type_idx: typing.List[int] conditioning_scale: typing.Union[float, typing.List[float]] = 1.0 class_labels: typing.Optional[torch.Tensor] = None timestep_cond: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None added_cond_kwargs: typing.Optional[typing.Dict[str, torch.Tensor]] = None cross_attention_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None from_multi: bool = False guess_mode: bool = False return_dict: bool = True ) → ControlNetOutput 或 tuple

参数

  • sample (torch.Tensor) — 噪声输入张量。
  • timestep (Union[torch.Tensor, float, int]) — 去噪输入的步长数。
  • encoder_hidden_states (torch.Tensor) — 编码器隐藏状态。
  • controlnet_cond (List[torch.Tensor]) — 条件输入张量。
  • control_type (torch.Tensor) — 形状为 (batch, num_control_type) 的张量，其值根据是否使用控制类型为 0 或 1。
  • control_type_idx (List[int]) — control_type 的索引。
  • conditioning_scale (float, 默认为 1.0) — ControlNet 输出的比例因子。
  • class_labels (torch.Tensor, 可选, 默认为 None) — 可选的用于条件化的类标签。它们的嵌入将与时间嵌入求和。
  • timestep_cond (torch.Tensor, 可选, 默认为 None) — 时间步长的额外条件嵌入。如果提供，嵌入将与通过 self.time_embedding 层的时间嵌入求和，以获得最终的时间嵌入。
  • attention_mask (torch.Tensor, 可选, 默认为 None) — 形状为 (batch, key_tokens) 的注意力掩码应用于 encoder_hidden_states。如果为 1 则保留掩码，否则如果为 0 则丢弃。掩码将转换为偏置，其将较大的负值添加到与“丢弃”令牌对应的注意力分数中。
  • added_cond_kwargs (dict) — Stable Diffusion XL UNet 的附加条件。
  • cross_attention_kwargs (dict[str], 可选, 默认为 None) — 一个 kwargs 字典，如果指定，则会传递给 AttnProcessor。
  • from_multi (bool, 默认为 False) — 当从 MultiControlNetUnionModel 调用时，使用标准缩放。
  • guess_mode (bool, 默认为 False) — 在此模式下，ControlNet 编码器会尽力识别输入的输入内容，即使您删除了所有提示。建议 guidance_scale 在 3.0 到 5.0 之间。
  • return_dict (bool, 默认为 True) — 是否返回 ControlNetOutput 而不是普通元组。

返回

ControlNetOutput 或 tuple

如果 return_dict 为 True，则返回 ControlNetOutput，否则返回一个元组，其中第一个元素是样本张量。

ControlNetUnionModel 的 forward 方法。

from_unet

< >

( unet: UNet2DConditionModel controlnet_conditioning_channel_order: str = 'rgb' conditioning_embedding_out_channels: typing.Optional[typing.Tuple[int, ...]] = (16, 32, 96, 256) load_weights_from_unet: bool = True )

参数

  • unet (UNet2DConditionModel) — 要复制到 ControlNetUnionModel 的 UNet 模型权重。所有适用的配置选项也会复制。

从 UNet2DConditionModel 实例化 ControlNetUnionModel。

set_attention_slice

< >

( slice_size: typing.Union[str, int, typing.List[int]] )

参数

  • slice_size (str 或 int 或 list(int), 可选, 默认为 "auto") — 当为 "auto" 时，输入到注意力头的输入减半，因此注意力分两步计算。如果为 "max"，则通过每次只运行一个切片来最大程度地节省内存。如果提供一个数字，则使用 attention_head_dim // slice_size 个切片。在这种情况下，attention_head_dim 必须是 slice_size 的倍数。

启用分片注意力计算。

启用此选项后，注意力模块会将输入张量分片以分步计算注意力。这对于节省内存非常有用，但会稍微降低速度。

设置注意力处理器

< >

( processor: typing.Union[diffusers.models.attention_processor.AttnProcessor, diffusers.models.attention_processor.CustomDiffusionAttnProcessor, diffusers.models.attention_processor.AttnAddedKVProcessor, diffusers.models.attention_processor.AttnAddedKVProcessor2_0, diffusers.models.attention_processor.JointAttnProcessor2_0, diffusers.models.attention_processor.PAGJointAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGJointAttnProcessor2_0, diffusers.models.attention_processor.FusedJointAttnProcessor2_0, diffusers.models.attention_processor.AllegroAttnProcessor2_0, diffusers.models.attention_processor.AuraFlowAttnProcessor2_0, diffusers.models.attention_processor.FusedAuraFlowAttnProcessor2_0, diffusers.models.attention_processor.FluxAttnProcessor2_0, diffusers.models.attention_processor.FluxAttnProcessor2_0_NPU, diffusers.models.attention_processor.FusedFluxAttnProcessor2_0, diffusers.models.attention_processor.FusedFluxAttnProcessor2_0_NPU, diffusers.models.attention_processor.CogVideoXAttnProcessor2_0, diffusers.models.attention_processor.FusedCogVideoXAttnProcessor2_0, diffusers.models.attention_processor.XFormersAttnAddedKVProcessor, diffusers.models.attention_processor.XFormersAttnProcessor, diffusers.models.attention_processor.XLAFlashAttnProcessor2_0, diffusers.models.attention_processor.AttnProcessorNPU, diffusers.models.attention_processor.AttnProcessor2_0, diffusers.models.attention_processor.MochiVaeAttnProcessor2_0, diffusers.models.attention_processor.MochiAttnProcessor2_0, diffusers.models.attention_processor.StableAudioAttnProcessor2_0, diffusers.models.attention_processor.HunyuanAttnProcessor2_0, diffusers.models.attention_processor.FusedHunyuanAttnProcessor2_0, diffusers.models.attention_processor.PAGHunyuanAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGHunyuanAttnProcessor2_0, diffusers.models.attention_processor.LuminaAttnProcessor2_0, diffusers.models.attention_processor.FusedAttnProcessor2_0, diffusers.models.attention_processor.CustomDiffusionXFormersAttnProcessor, diffusers.models.attention_processor.CustomDiffusionAttnProcessor2_0, diffusers.models.attention_processor.SlicedAttnProcessor, diffusers.models.attention_processor.SlicedAttnAddedKVProcessor, diffusers.models.attention_processor.SanaLinearAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGSanaLinearAttnProcessor2_0, diffusers.models.attention_processor.PAGIdentitySanaLinearAttnProcessor2_0, diffusers.models.attention_processor.SanaMultiscaleLinearAttention, diffusers.models.attention_processor.SanaMultiscaleAttnProcessor2_0, diffusers.models.attention_processor.SanaMultiscaleAttentionProjection, diffusers.models.attention_processor.IPAdapterAttnProcessor, diffusers.models.attention_processor.IPAdapterAttnProcessor2_0, diffusers.models.attention_processor.IPAdapterXFormersAttnProcessor, diffusers.models.attention_processor.SD3IPAdapterJointAttnProcessor2_0, diffusers.models.attention_processor.PAGIdentitySelfAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGIdentitySelfAttnProcessor2_0, diffusers.models.attention_processor.LoRAAttnProcessor, diffusers.models.attention_processor.LoRAAttnProcessor2_0, diffusers.models.attention_processor.LoRAXFormersAttnProcessor, diffusers.models.attention_processor.LoRAAttnAddedKVProcessor, typing.Dict[str, typing.Union[diffusers.models.attention_processor.AttnProcessor, diffusers.models.attention_processor.CustomDiffusionAttnProcessor, diffusers.models.attention_processor.AttnAddedKVProcessor, diffusers.models.attention_processor.AttnAddedKVProcessor2_0, diffusers.models.attention_processor.JointAttnProcessor2_0, diffusers.models.attention_processor.PAGJointAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGJointAttnProcessor2_0, diffusers.models.attention_processor.FusedJointAttnProcessor2_0, diffusers.models.attention_processor.AllegroAttnProcessor2_0, diffusers.models.attention_processor.AuraFlowAttnProcessor2_0, diffusers.models.attention_processor.FusedAuraFlowAttnProcessor2_0, diffusers.models.attention_processor.FluxAttnProcessor2_0, diffusers.models.attention_processor.FluxAttnProcessor2_0_NPU, diffusers.models.attention_processor.FusedFluxAttnProcessor2_0, diffusers.models.attention_processor.FusedFluxAttnProcessor2_0_NPU, diffusers.models.attention_processor.CogVideoXAttnProcessor2_0, diffusers.models.attention_processor.FusedCogVideoXAttnProcessor2_0, diffusers.models.attention_processor.XFormersAttnAddedKVProcessor, diffusers.models.attention_processor.XFormersAttnProcessor, diffusers.models.attention_processor.XLAFlashAttnProcessor2_0, diffusers.models.attention_processor.AttnProcessorNPU, diffusers.models.attention_processor.AttnProcessor2_0, diffusers.models.attention_processor.MochiVaeAttnProcessor2_0, diffusers.models.attention_processor.MochiAttnProcessor2_0, diffusers.models.attention_processor.StableAudioAttnProcessor2_0, diffusers.models.attention_processor.HunyuanAttnProcessor2_0, diffusers.models.attention_processor.FusedHunyuanAttnProcessor2_0, diffusers.models.attention_processor.PAGHunyuanAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGHunyuanAttnProcessor2_0, diffusers.models.attention_processor.LuminaAttnProcessor2_0, diffusers.models.attention_processor.FusedAttnProcessor2_0, diffusers.models.attention_processor.CustomDiffusionXFormersAttnProcessor, diffusers.models.attention_processor.CustomDiffusionAttnProcessor2_0, diffusers.models.attention_processor.SlicedAttnProcessor, diffusers.models.attention_processor.SlicedAttnAddedKVProcessor, diffusers.models.attention_processor.SanaLinearAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGSanaLinearAttnProcessor2_0, diffusers.models.attention_processor.PAGIdentitySanaLinearAttnProcessor2_0, diffusers.models.attention_processor.SanaMultiscaleLinearAttention, diffusers.models.attention_processor.SanaMultiscaleAttnProcessor2_0, diffusers.models.attention_processor.SanaMultiscaleAttentionProjection, diffusers.models.attention_processor.IPAdapterAttnProcessor, diffusers.models.attention_processor.IPAdapterAttnProcessor2_0, diffusers.models.attention_processor.IPAdapterXFormersAttnProcessor, diffusers.models.attention_processor.SD3IPAdapterJointAttnProcessor2_0, diffusers.models.attention_processor.PAGIdentitySelfAttnProcessor2_0, diffusers.models.attention_processor.PAGCFGIdentitySelfAttnProcessor2_0, diffusers.models.attention_processor.LoRAAttnProcessor, diffusers.models.attention_processor.LoRAAttnProcessor2_0, diffusers.models.attention_processor.LoRAXFormersAttnProcessor, diffusers.models.attention_processor.LoRAAttnAddedKVProcessor]]] )

参数

  • processor (AttentionProcessor 的 dict 或仅 AttentionProcessor) — 实例化的处理器类或处理器类字典，它将设置为所有 Attention 层的处理器。

    如果 processor 是一个字典，则键需要定义到相应交叉注意力处理器的路径。强烈建议在设置可训练注意力处理器时使用此方法。

设置用于计算注意力的注意力处理器。

set_default_attn_processor

< >

( )

禁用自定义注意力处理器并设置默认注意力实现。

< > 在 GitHub 上更新

←ControlNetModel FluxControlNetModel→