Hugging Face's logo

Diffusers documentation

ControlNetModel

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.42.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

ControlNetModel

Le modèle ControlNet a été introduit dans Adding Conditional Control to Text-to-Image Diffusion Models par Lvmin Zhang, Anyi Rao et Maneesh Agrawala. Il offre un degré de contrôle supérieur sur la génération d’images à partir de texte en conditionnant le modèle sur des entrées supplémentaires telles que des cartes de contours, des cartes de profondeur, des cartes de segmentation et des points clés pour la détection de pose.

L'abstract de l'article est :

Nous présentons ControlNet, une architecture de réseau de neurones permettant d’ajouter des contrôles de conditionnement spatial à de grands modèles de diffusion texte-vers-image pré-entraînés. ControlNet verrouille les grands modèles de diffusion prêts pour la production et réutilise leurs couches d’encodage profondes et robustes, pré-entraînées sur des milliards d’images, comme un socle solide pour apprendre un ensemble varié de contrôles conditionnels. L’architecture neuronale est connectée par des « convolutions nulles » (couches de convolution initialisées à zéro) qui font progressivement croître les paramètres depuis zéro et garantissent qu’aucun bruit nuisible ne puisse affecter l’ajustement fin. Nous testons divers contrôles de conditionnement, par exemple les contours, la profondeur, la segmentation, la pose humaine, etc., avec Stable Diffusion, en utilisant une ou plusieurs conditions, avec ou sans prompts. Nous montrons que l’entraînement des ControlNets est robuste avec des jeux de données petits (<50k) et grands (>1m). Des résultats étendus montrent que ControlNet peut faciliter des applications plus larges pour contrôler les modèles de diffusion d’images.

Chargement depuis le format d'origine

Par défaut, le ControlNetModel doit être chargé avec from_pretrained(), mais il peut également être chargé à partir du format d’origine en utilisant FromOriginalModelMixin.from_single_file comme suit :

from diffusers import StableDiffusionControlNetPipeline, ControlNetModel

url = "https://huggingface.co/lllyasviel/ControlNet-v1-1/blob/main/control_v11p_sd15_canny.pth"  # can also be a local path
controlnet = ControlNetModel.from_single_file(url)

url = "https://huggingface.co/stable-diffusion-v1-5/stable-diffusion-v1-5/blob/main/v1-5-pruned.safetensors"  # can also be a local path
pipe = StableDiffusionControlNetPipeline.from_single_file(url, controlnet=controlnet)

Chargement depuis Control LoRA

Control-LoRA est introduit par Stability AI dans stabilityai/control-lora en ajoutant un fine-tuning efficace en paramètres de faible rang à ControlNet. Cette approche offre une méthode plus efficace et compacte pour apporter le contrôle du modèle à une plus grande variété de GPU grand public.

from diffusers import ControlNetModel, UNet2DConditionModel

lora_id = "stabilityai/control-lora"
lora_filename = "control-LoRAs-rank128/control-lora-canny-rank128.safetensors"

unet = UNet2DConditionModel.from_pretrained("stabilityai/stable-diffusion-xl-base-1.0", subfolder="unet", dtype=torch.bfloat16).to("cuda")  # or "mps", "xpu", "cpu"
controlnet = ControlNetModel.from_unet(unet).to(device="cuda", dtype=torch.bfloat16)
controlnet.load_lora_adapter(lora_id, weight_name=lora_filename, prefix=None, controlnet_config=controlnet.config)

ControlNetModel

classe diffusers.ControlNetModel

< >

( in_channels: int = 4conditioning_channels: int = 3flip_sin_to_cos: bool = Truefreq_shift: int = 0down_block_types: tuple = ('CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'DownBlock2D')mid_block_type: str | None = 'UNetMidBlock2DCrossAttn'only_cross_attention: bool | tuple[bool] = Falseblock_out_channels: tuple = (320, 640, 1280, 1280)layers_per_block: int = 2downsample_padding: int = 1mid_block_scale_factor: float = 1act_fn: str = 'silu'norm_num_groups: int | None = 32norm_eps: float = 1e-05cross_attention_dim: int = 1280transformer_layers_per_block: int | tuple[int, ...] = 1encoder_hid_dim: int | None = Noneencoder_hid_dim_type: str | None = Noneattention_head_dim: int | tuple[int, ...] = 8num_attention_heads: int | tuple[int, ...] | None = Noneuse_linear_projection: bool = Falseclass_embed_type: str | None = Noneaddition_embed_type: str | None = Noneaddition_time_embed_dim: int | None = Nonenum_class_embeds: int | None = Noneupcast_attention: bool = Falseresnet_time_scale_shift: str = 'default'projection_class_embeddings_input_dim: int | None = Nonecontrolnet_conditioning_channel_order: str = 'rgb'conditioning_embedding_out_channels: tuple[int, ...] | None = (16, 32, 96, 256)global_pool_conditions: bool = Falseaddition_embed_type_num_heads: int = 64 )

Paramètres

  • in_channels (int, par défaut 4) — Le nombre de canaux dans l'échantillon d'entrée.
  • flip_sin_to_cos (bool, par défaut True) — Indique s'il faut inverser le sin en cos dans l'embedding temporel.
  • freq_shift (int, par défaut 0) — Le décalage de fréquence à appliquer à l'incorporation temporelle.
  • down_block_types (tuple[str], par défaut ("CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "DownBlock2D")) — Le tuple de blocs de sous-échantillonnage à utiliser.
  • only_cross_attention (bool | tuple[bool], par défaut False) —
  • block_out_channels (tuple[int], par défaut (320, 640, 1280, 1280)) — Le tuple des canaux de sortie pour chaque bloc.
  • layers_per_block (int, par défaut 2) — Le nombre de couches par bloc.
  • downsample_padding (int, par défaut 1) — Le padding à utiliser pour la convolution de downsampling.
  • mid_block_scale_factor (float, par défaut 1) — Le facteur d'échelle à utiliser pour le bloc intermédiaire.
  • act_fn (str, par défaut “silu”) — La fonction d'activation à utiliser.
  • norm_num_groups (int, facultatif, valeur par défaut 32) — Le nombre de groupes à utiliser pour la normalisation. Si la valeur est None, les couches de normalisation et d’activation sont ignorées lors du post-traitement.
  • norm_eps (float, par défaut 1e-5) — L'épsilon à utiliser pour la normalisation.
  • cross_attention_dim (int, par défaut 1280) — La dimension des fonctionnalités d'attention croisée.
  • transformer_layers_per_block (int ou tuple[int], facultatif, par défaut 1) — Le nombre de blocs de type BasicTransformerBlock. Ne concerne que ~models.unet_2d_blocks.CrossAttnDownBlock2D, ~models.unet_2d_blocks.CrossAttnUpBlock2D, ~models.unet_2d_blocks.UNetMidBlock2DCrossAttn.
  • encoder_hid_dim (int, facultatif, valeur par défaut None) — Si encoder_hid_dim_type est défini, encoder_hidden_states sera projeté de la dimension encoder_hid_dim à la dimension cross_attention_dim.
  • encoder_hid_dim_type (str, facultatif, par défaut None) — Si fourni, les encoder_hidden_states et d’éventuels autres embeddings sont projetés vers des embeddings de texte de dimension cross_attention selon encoder_hid_dim_type.
  • attention_head_dim (int | tuple[int], par défaut 8) — La dimension des têtes d'attention.
  • use_linear_projection (bool, par défaut False) —
  • class_embed_type (str, facultatif, par défaut None) — Le type d’embedding de classe à utiliser, qui est finalement additionné aux embeddings temporels. Choisissez parmi None, "timestep", "identity", "projection" ou "simple_projection".
  • addition_embed_type (str, facultatif, par défaut None) — Configure un embedding facultatif qui sera additionné aux embeddings temporels. Choisissez entre None et “text”. “text” utilise la couche TextTimeEmbedding.
  • num_class_embeds (int, facultatif, valeur par défaut 0) — Dimension d’entrée de la matrice d’incorporation apprenable à projeter vers time_embed_dim, lors de l’application d’un conditionnement par classe avec class_embed_type égal à None.
  • upcast_attention (bool, par défaut False) —
  • resnet_time_scale_shift (str, par défaut "default") — Configuration du décalage d'échelle temporelle pour les blocs ResNet (voir ResnetBlock2D). Choisissez entre default et scale_shift.
  • projection_class_embeddings_input_dim (int, facultatif, par défaut None) — La dimension de l’entrée class_labels lorsque class_embed_type="projection". Obligatoire lorsque class_embed_type="projection".
  • controlnet_conditioning_channel_order (str, par défaut "rgb") — L’ordre des canaux de l’image conditionnelle. Sera converti en rgb s’il est bgr.
  • conditioning_embedding_out_channels (tuple[int], facultatif, par défaut (16, 32, 96, 256)) — Le tuple des canaux de sortie pour chaque bloc de la couche conditioning_embedding.
  • global_pool_conditions (bool, par défaut False) — TODO(Patrick) - paramètre inutilisé.
  • addition_embed_type_num_heads (int, par défaut 64) — Le nombre de têtes à utiliser pour la couche TextTimeEmbedding.

Un modèle ControlNet.

forward

< >

( sample: Tensortimestep: typing.Union[torch.Tensor, float, int]encoder_hidden_states: Tensorcontrolnet_cond: Tensorconditioning_scale: float = 1.0class_labels: typing.Optional[torch.Tensor] = Nonetimestep_cond: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneadded_cond_kwargs: dict[str, torch.Tensor] | None = Nonecross_attention_kwargs: dict[str, typing.Any] | None = Noneguess_mode: bool = Falsereturn_dict: bool = True ) → ControlNetOutput or tuple

Paramètres

  • sample (torch.Tensor) — Le tenseur d'entrée bruité.
  • timestep (torch.Tensor | float | int) — Le nombre de pas de temps pour débruitiser une entrée.
  • encoder_hidden_states (torch.Tensor) — Les états cachés de l'encodeur.
  • controlnet_cond (torch.Tensor) — Le tenseur d'entrée conditionnel de forme (batch_size, sequence_length, hidden_size).
  • conditioning_scale (float, par défaut 1.0) — Le facteur d'échelle pour les sorties de ControlNet.
  • class_labels (torch.Tensor, facultatif, par défaut None) — Étiquettes de classes facultatives pour le conditionnement. Leurs embeddings seront additionnés aux embeddings de pas de temps.
  • timestep_cond (torch.Tensor, facultatif, par défaut None) — Embeddings conditionnels supplémentaires pour le timestep. S'ils sont fournis, les embeddings seront additionnés à self.time_embedding passé à travers la couche self.time_embedding pour obtenir les embeddings timestep finaux.
  • attention_mask (torch.Tensor, facultatif, par défaut None) — Un masque d’attention de forme (batch, key_tokens) est appliqué à encoder_hidden_states. Si la valeur est 1, le masque est conservé ; sinon, si elle est 0, il est ignoré. Le masque est converti en biais, qui ajoute de grandes valeurs négatives aux scores d’attention correspondant aux jetons « ignorés ».
  • added_cond_kwargs (dict) — Conditions supplémentaires pour le UNet de Stable Diffusion XL.
  • cross_attention_kwargs (dict[str], facultatif, par défaut None) — Un dictionnaire de kwargs qui, s'il est spécifié, est transmis à AttnProcessor.
  • guess_mode (bool, par défaut False) — Dans ce mode, l’encodeur ControlNet fait de son mieux pour reconnaître le contenu de l’entrée, même si vous supprimez tous les prompts. Un guidance_scale compris entre 3.0 et 5.0 est recommandé.
  • return_dict (bool, par défaut True) — Indique s'il faut retourner un ControlNetOutput plutôt qu'un simple tuplet.

Retourne

ControlNetOutput ou tuple

Si return_dict est True, un ControlNetOutput est renvoyé, sinon un tuple est renvoyé dont le premier élément est le tenseur d’échantillon.

La méthode forward du ControlNetModel.

from_unet

< >

( unet: UNet2DConditionModelcontrolnet_conditioning_channel_order: str = 'rgb'conditioning_embedding_out_channels: tuple[int, ...] | None = (16, 32, 96, 256)load_weights_from_unet: bool = Trueconditioning_channels: int = 3 )

Paramètres

  • unet (UNet2DConditionModel) — Les poids du modèle UNet à copier vers le ControlNetModel. Toutes les options de configuration sont également copiées lorsqu’elles sont applicables.

Instanciez un ControlNetModel à partir de UNet2DConditionModel.

set_attention_slice

< >

( slice_size: str | int | list[int] )

Paramètres

  • slice_size (str ou int ou list(int), facultatif, par défaut "auto") — Lorsque la valeur est "auto", l’entrée des têtes d’attention est divisée par deux, de sorte que l’attention est calculée en deux étapes. Si la valeur est "max", la quantité maximale de mémoire est économisée en n’exécutant qu’une seule tranche à la fois. Si un nombre est fourni, le nombre de tranches utilisé est attention_head_dim // slice_size. Dans ce cas, attention_head_dim doit être un multiple de slice_size.

Activer le calcul de l'attention par tranches.

Lorsque cette option est activée, le module d'attention divise le tenseur d'entrée en tranches pour calculer l'attention en plusieurs étapes. Cela est utile pour économiser de la mémoire au prix d'une légère diminution de la vitesse.

set_default_attn_processor

< >

( )

Désactive les processeurs d'attention personnalisés et définit l'implémentation d'attention par défaut.

ControlNetOutput

classe diffusers.models.controlnets.ControlNetOutput

< >

( down_block_res_samples: tuplemid_block_res_sample: Tensor )

Paramètres

  • down_block_res_samples (tuple[torch.Tensor]) — Un tuple d'activations de sous-échantillonnage à différentes résolutions pour chaque bloc de sous-échantillonnage. Chaque tenseur doit avoir la forme (batch_size, channel * resolution, height //resolution, width // resolution). La sortie peut être utilisée pour conditionner les activations de sous-échantillonnage de l'UNet d'origine.
  • mid_down_block_re_sample (torch.Tensor) — L’activation du bloc intermédiaire (la résolution d’échantillonnage la plus basse). Chaque tenseur doit avoir la forme (batch_size, channel * lowest_resolution, height // lowest_resolution, width // lowest_resolution). La sortie peut être utilisée pour conditionner l’activation du bloc intermédiaire du UNet d’origine.

La sortie de ControlNetModel.

Update on GitHub

←AutoModel ControlNetUnionModel→