Hugging Face's logo

Diffusers documentation

UNet2DConditionModel

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

UNet2DConditionModel

O modelo UNet foi originalmente introduzido por Ronneberger et al. para segmentação de imagens biomédicas, mas também é comumente usado no 🤗 Diffusers porque ele gera imagens com o mesmo tamanho da entrada. Ele é um dos componentes mais importantes de um sistema de difusão, pois facilita o processo de difusão em si. Existem várias variantes do modelo UNet no 🤗 Diffusers, dependendo do número de dimensões e de se trata de um modelo condicional ou não. Este é um modelo UNet condicional 2D.

O resumo do artigo é:

Há amplo consenso de que o treinamento bem-sucedido de redes profundas requer milhares de amostras de treinamento anotadas. Neste artigo, apresentamos uma rede e uma estratégia de treinamento que dependem do uso intenso de aumento de dados para utilizar as amostras anotadas disponíveis de forma mais eficiente. A arquitetura consiste em um caminho contrativo para capturar o contexto e um caminho expansivo simétrico que permite a localização precisa. Mostramos que uma rede como essa pode ser treinada de ponta a ponta a partir de muito poucas imagens e supera o melhor método anterior (uma rede convolucional de janela deslizante) no desafio ISBI para segmentação de estruturas neuronais em pilhas de microscopia eletrônica. Usando a mesma rede treinada em imagens de microscopia de luz transmitida (contraste de fase e DIC), vencemos o desafio de rastreamento celular ISBI 2015 nessas categorias por uma grande margem. Além disso, a rede é rápida. A segmentação de uma imagem de 512x512 leva menos de um segundo em uma GPU recente. A implementação completa (baseada em Caffe) e as redes treinadas estão disponíveis em http://lmb.informatik.uni-freiburg.de/people/ronneber/u-net.

UNet2DConditionModel

classe diffusers.UNet2DConditionModel

< >

( sample_size: int | tuple[int, int] | None = Nonein_channels: int = 4out_channels: int = 4center_input_sample: bool = Falseflip_sin_to_cos: bool = Truefreq_shift: int = 0down_block_types: tuple = ('CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'DownBlock2D')mid_block_type: str | None = 'UNetMidBlock2DCrossAttn'up_block_types: tuple = ('UpBlock2D', 'CrossAttnUpBlock2D', 'CrossAttnUpBlock2D', 'CrossAttnUpBlock2D')only_cross_attention: bool | tuple[bool] = Falseblock_out_channels: tuple = (320, 640, 1280, 1280)layers_per_block: int | tuple[int] = 2downsample_padding: int = 1mid_block_scale_factor: float = 1dropout: float = 0.0act_fn: str = 'silu'norm_num_groups: int | None = 32norm_eps: float = 1e-05cross_attention_dim: int | tuple[int] = 1280transformer_layers_per_block: int | tuple[int] | tuple[tuple] = 1reverse_transformer_layers_per_block: tuple[tuple[int]] | None = Noneencoder_hid_dim: int | None = Noneencoder_hid_dim_type: str | None = Noneattention_head_dim: int | tuple[int] = 8num_attention_heads: int | tuple[int] | None = Nonedual_cross_attention: bool = Falseuse_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'resnet_skip_time_act: bool = Falseresnet_out_scale_factor: float = 1.0time_embedding_type: str = 'positional'time_embedding_dim: int | None = Nonetime_embedding_act_fn: str | None = Nonetimestep_post_act: str | None = Nonetime_cond_proj_dim: int | None = Noneconv_in_kernel: int = 3conv_out_kernel: int = 3projection_class_embeddings_input_dim: int | None = Noneattention_type: str = 'default'class_embeddings_concat: bool = Falsemid_block_only_cross_attention: bool | None = Nonecross_attention_norm: str | None = Noneaddition_embed_type_num_heads: int = 64 )

Parâmetros

  • sample_size (int ou tuple[int, int], opcional, padrão None) — Altura e largura da amostra de entrada/saída.
  • in_channels (int, opcional, padrão 4) — Número de canais na amostra de entrada.
  • out_channels (int, opcional, padrão 4) — Número de canais na saída.
  • center_input_sample (bool, opcional, padrão False) — Se deve centralizar a amostra de entrada.
  • flip_sin_to_cos (bool, opcional, padrão True) — Se deve inverter o sin para cos no embedding de tempo.
  • freq_shift (int, opcional, padrão 0) — O deslocamento de frequência a ser aplicado ao embedding de tempo.
  • down_block_types (tuple[str], opcional, padrão ("CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "DownBlock2D")) — A tupla de blocos de downsampling a serem usados.
  • mid_block_type (str, opcional, padrão "UNetMidBlock2DCrossAttn") — Tipo de bloco para a parte intermediária do UNet, pode ser um de UNetMidBlock2DCrossAttn, UNetMidBlock2D ou UNetMidBlock2DSimpleCrossAttn. Se None, a camada do bloco intermediário é ignorada.
  • up_block_types (tuple[str], opcional, padrão ("UpBlock2D", "CrossAttnUpBlock2D", "CrossAttnUpBlock2D", "CrossAttnUpBlock2D")) — A tupla de blocos de upsample a serem usados.
  • only_cross_attention(bool or tuple[bool], opcional, padrão False) — Se deve incluir autoatenção nos blocos básicos do transformer, veja BasicTransformerBlock.
  • block_out_channels (tuple[int], opcional, padrão (320, 640, 1280, 1280)) — A tupla de canais de saída para cada bloco.
  • layers_per_block (int, opcional, padrão 2) — O número de camadas por bloco.
  • downsample_padding (int, opcional, padrão 1) — O padding a ser usado para a convolução de downsampling.
  • mid_block_scale_factor (float, opcional, padrão 1.0) — O fator de escala a ser usado para o bloco intermediário.
  • dropout (float, opcional, padrão 0.0) — A probabilidade de dropout a ser utilizada.
  • act_fn (str, opcional, padrão "silu") — A função de ativação a ser utilizada.
  • norm_num_groups (int, opcional, padrão 32) — O número de grupos a serem usados para a normalização. Se None, as camadas de normalização e ativação são ignoradas no pós-processamento.
  • norm_eps (float, opcional, padrão 1e-5) — O epsilon a ser usado para a normalização.
  • cross_attention_dim (int ou tuple[int], opcional, padrão 1280) — A dimensão dos recursos de atenção cruzada.
  • transformer_layers_per_block (int, tuple[int] ou tuple[tuple] , opcional, padrão 1) — O número de blocos de transformador do tipo BasicTransformerBlock. Relevante apenas para CrossAttnDownBlock2D, CrossAttnUpBlock2D, UNetMidBlock2DCrossAttn.
  • reverse_transformer_layers_per_block — (tuple[tuple], opcional, padrão None): O número de blocos de transformer do tipo BasicTransformerBlock, nos blocos de upsampling da U-Net. Relevante apenas se transformer_layers_per_block for do tipo tuple[tuple] e para CrossAttnDownBlock2D, CrossAttnUpBlock2D, UNetMidBlock2DCrossAttn.
  • encoder_hid_dim (int, opcional, padrão None) — Se encoder_hid_dim_type estiver definido, encoder_hidden_states será projetado da dimensão encoder_hid_dim para cross_attention_dim.
  • encoder_hid_dim_type (str, opcional, padrão None) — Se fornecido, o encoder_hidden_states e possivelmente outros embeddings são projetados para baixo para embeddings de texto de dimensão cross_attention de acordo com encoder_hid_dim_type.
  • attention_head_dim (int, opcional, padrão 8) — A dimensão dos cabeçalhos de atenção.
  • num_attention_heads (int, opcional) — O número de cabeças de atenção. Se não definido, o valor padrão é attention_head_dim
  • resnet_time_scale_shift (str, opcional, padrão "default") — Configuração de deslocamento de escala de tempo para blocos ResNet (veja ResnetBlock2D). Escolha entre default ou scale_shift.
  • class_embed_type (str, opcional, padrão None) — O tipo de incorporação de classe a ser usado, que é somado às incorporações de tempo. Escolha entre None, "timestep", "identity", "projection" ou "simple_projection".
  • addition_embed_type (str, opcional, padrão None) — Configura um embedding opcional que será somado aos embeddings de tempo. Escolha entre None ou “text”. “text” usará a camada TextTimeEmbedding.
  • addition_time_embed_dim — (int, opcional, padrão None): Dimensão para os embeddings de timestep.
  • num_class_embeds (int, opcional, padrão None) — Dimensão de entrada da matriz de incorporação aprendível a ser projetada para time_embed_dim, ao realizar condicionamento por classe com class_embed_type igual a None.
  • time_embedding_type (str, opcional, padrão positional) — O tipo de incorporação de posição a ser usado para os passos de tempo. Escolha entre positional ou fourier.
  • time_embedding_dim (int, opcional, padrão None) — Substituição opcional para a dimensão do embedding de tempo projetado.
  • time_embedding_act_fn (str, opcional, padrão None) — Função de ativação opcional para usar apenas uma vez nos embeddings de tempo antes de serem passados para o restante do UNet. Escolha entre silu, mish, gelu e swish.
  • timestep_post_act (str, opcional, padrão None) — A segunda função de ativação a ser usada no embedding de timestep. Escolha entre silu, mish e gelu.
  • time_cond_proj_dim (int, opcional, padrão None) — A dimensão da camada cond_proj no embedding de timestep.
  • conv_in_kernel (int, opcional, padrão 3) — O tamanho do kernel da camada conv_in.
  • conv_out_kernel (int, opcional, padrão 3) — O tamanho do kernel da camada conv_out.
  • projection_class_embeddings_input_dim (int, opcional) — A dimensão da entrada class_labels quando class_embed_type="projection". Obrigatório quando class_embed_type="projection".
  • class_embeddings_concat (bool, opcional, padrão False) — Se as incorporações de tempo devem ser concatenadas com as incorporações de classe.
  • mid_block_only_cross_attention (bool, opcional, padrão None) — Se deve usar cross attention com o bloco intermediário ao usar o UNetMidBlock2DSimpleCrossAttn. Se only_cross_attention for fornecido como um único booleano e mid_block_only_cross_attention for None, o valor de only_cross_attention é usado como o valor para mid_block_only_cross_attention. Caso contrário, o padrão é False.

Um modelo 2D UNet condicional que recebe uma amostra com ruído, um estado condicional e um passo de tempo e retorna uma saída com a forma da amostra.

Este modelo herda de ModelMixin. Consulte a documentação da superclasse para seus métodos genéricos implementados para todos os modelos (como download ou salvamento).

disable_freeu

< >

( )

Desativa o mecanismo FreeU.

enable_freeu

< >

( s1: floats2: floatb1: floatb2: float )

Parâmetros

  • s1 (float) — Fator de escala para a etapa 1 para atenuar as contribuições dos recursos de skip. Isso é feito para mitigar o “efeito de sobre-suavização” no processo aprimorado de remoção de ruído.
  • s2 (float) — Fator de escala para o estágio 2 para atenuar as contribuições dos recursos de skip. Isso é feito para mitigar o “efeito de sobre-suavização” no processo aprimorado de remoção de ruído.
  • b1 (float) — Fator de escala para o estágio 1 para amplificar as contribuições dos recursos do backbone.
  • b2 (float) — Fator de escala para o estágio 2 para amplificar as contribuições dos recursos do backbone.

Ativa o mecanismo FreeU de https://huggingface.co/papers/2309.11497.

Os sufixos após os fatores de escala representam os blocos de estágio em que eles estão sendo aplicados.

Consulte o repositório oficial para combinações de valores que são conhecidas por funcionar bem em diferentes pipelines, como Stable Diffusion v1, v2 e Stable Diffusion XL.

forward

< >

( sample: Tensortimestep: typing.Union[torch.Tensor, float, int]encoder_hidden_states: Tensorclass_labels: typing.Optional[torch.Tensor] = Nonetimestep_cond: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonecross_attention_kwargs: dict[str, typing.Any] | None = Noneadded_cond_kwargs: dict[str, torch.Tensor] | None = Nonedown_block_additional_residuals: tuple[torch.Tensor] | None = Nonemid_block_additional_residual: typing.Optional[torch.Tensor] = Nonedown_intrablock_additional_residuals: tuple[torch.Tensor] | None = Noneencoder_attention_mask: typing.Optional[torch.Tensor] = Nonereturn_dict: bool = True ) → UNet2DConditionOutput or tuple

Parâmetros

  • sample (torch.Tensor) — O tensor de entrada com ruído, com a seguinte forma (batch, channel, height, width).
  • timestep (torch.Tensor ou float ou int) — O número de timesteps para desruidar uma entrada.
  • encoder_hidden_states (torch.Tensor) — Os estados ocultos do codificador com forma (batch, sequence_length, feature_dim).
  • class_labels (torch.Tensor, opcional, padrão None) — Rótulos de classe opcionais para condicionamento. Os embeddings deles serão somados aos embeddings de timestep.
  • timestep_cond — (torch.Tensor, opcional, padrão None): Incorporações condicionais para o timestep. Se fornecidas, as incorporações serão somadas às amostras passadas pela camada self.time_embedding para obter as incorporações de timestep.
  • attention_mask (torch.Tensor, opcional, padrão None) — Uma máscara de atenção com forma (batch, key_tokens) é aplicada a encoder_hidden_states. Se 1, a máscara é mantida; caso contrário, se 0, ela é descartada. A máscara será convertida em um viés, que adiciona grandes valores negativos às pontuações de atenção correspondentes aos tokens “descartados”.
  • cross_attention_kwargs (dict, opcional) — Um dicionário de kwargs que, se especificado, é passado para o AttentionProcessor conforme definido em self.processor em diffusers.models.attention_processor.
  • added_cond_kwargs — (dict, opcional): Um dicionário de kwargs contendo embeddings adicionais que, se especificados, são adicionados aos embeddings que são passados para os blocos do UNet.
  • down_block_additional_residuals — (tuple de torch.Tensor, opcional): Uma tupla de tensores que, se especificada, é adicionada aos resíduos dos blocos down do unet.
  • mid_block_additional_residual — (torch.Tensor, opcional): Um tensor que, se especificado, é adicionado ao residual do bloco intermediário do unet.
  • down_intrablock_additional_residuals (tuple de torch.Tensor, opcional) — resíduos adicionais a serem adicionados dentro dos blocos de down do UNet, por exemplo, de modelos laterais do T2I-Adapter
  • encoder_attention_mask (torch.Tensor) — Uma máscara de atenção cruzada de forma (batch, sequence_length) é aplicada a encoder_hidden_states. Se True, a máscara é mantida; caso contrário, se False, ela é descartada. A máscara será convertida em um viés, que adiciona valores negativos grandes às pontuações de atenção correspondentes aos tokens “descartados”.
  • return_dict (bool, opcional, padrão True) — Se deve ou não retornar um UNet2DConditionOutput em vez de uma tupla simples.

Retorna

UNet2DConditionOutput ou tuple

Se return_dict for True, um UNet2DConditionOutput é retornado, caso contrário, uma tuple é retornada, onde o primeiro elemento é o tensor da amostra.

O método forward do UNet2DConditionModel.

fuse_qkv_projections

< >

( )

Ativa as projeções QKV fundidas. Para os módulos de autoatenção, todas as matrizes de projeção (ou seja, query, key, value) são fundidas. Para os módulos de atenção cruzada, as matrizes de projeção de key e value são fundidas.

> Esta API é 🧪 experimental.

set_attention_slice

< >

( slice_size: str | int | list[int] = 'auto' )

Parâmetros

  • slice_size (str ou int ou list(int), opcional, padrão "auto") — Quando "auto", a entrada para as cabeças de atenção é dividida ao meio, de modo que a atenção é calculada em duas etapas. Se "max", a quantidade máxima de memória é economizada executando apenas uma fatia por vez. Se um número for fornecido, usa tantas fatias quanto attention_head_dim // slice_size. Nesse caso, attention_head_dim deve ser um múltiplo de slice_size.

Ative o cálculo de atenção fatiado.

Quando essa opção está habilitada, o módulo de atenção divide o tensor de entrada em fatias para calcular a atenção em várias etapas. Isso é útil para economizar memória em troca de uma pequena diminuição na velocidade.

set_default_attn_processor

< >

( )

Desativa os processadores de atenção personalizados e define a implementação padrão de atenção.

unfuse_qkv_projections

< >

( )

Desativa a projeção QKV fundida, se estiver habilitada.

> Esta API é 🧪 experimental.

UNet2DConditionOutput

classe diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput

< >

( sample: Tensor = None )

Parâmetros

  • sample (torch.Tensor de forma (batch_size, num_channels, height, width)) — A saída dos estados ocultos condicionada à entrada encoder_hidden_states. Saída da última camada do modelo.

A saída de UNet2DConditionModel.

Update on GitHub

←UNet1DModel UNet2DModel→