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

El modelo UNet fue introducido originalmente por Ronneberger et al. para la segmentación de imágenes biomédicas, pero también se utiliza comúnmente en 🤗 Diffusers porque genera imágenes del mismo tamaño que la entrada. Es uno de los componentes más importantes de un sistema de difusión, ya que facilita el proceso de difusión propiamente dicho. Existen varias variantes del modelo UNet en 🤗 Diffusers, dependiendo de su número de dimensiones y de si es un modelo condicional o no. Este es un modelo UNet condicional de 2D.

El resumen del artículo es:

Existe un amplio consenso de que el entrenamiento exitoso de redes profundas requiere miles de muestras de entrenamiento anotadas. En este artículo, presentamos una red y una estrategia de entrenamiento que se basa en el uso intensivo de aumentación de datos para utilizar las muestras anotadas disponibles de manera más eficiente. La arquitectura consiste en una ruta contractiva para capturar el contexto y una ruta expansiva simétrica que permite una localización precisa. Demostramos que una red de este tipo puede entrenarse de extremo a extremo a partir de muy pocas imágenes y supera al mejor método anterior (una red convolucional de ventana deslizante) en el desafío ISBI para la segmentación de estructuras neuronales en pilas de microscopía electrónica. Utilizando la misma red entrenada con imágenes de microscopía de luz transmitida (contraste de fase y DIC), ganamos el desafío de seguimiento celular ISBI 2015 en estas categorías por un amplio margen. Además, la red es rápida. La segmentación de una imagen de 512x512 toma menos de un segundo en una GPU reciente. La implementación completa (basada en Caffe) y las redes entrenadas están disponibles en http://lmb.informatik.uni-freiburg.de/people/ronneber/u-net.

UNet2DConditionModel

clase 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 o tuple[int, int], opcional, valor predeterminado None) — Altura y anchura de la muestra de entrada/salida.
  • in_channels (int, opcional, valor predeterminado 4) — Número de canales en la muestra de entrada.
  • out_channels (int, opcional, valor predeterminado 4) — Número de canales en la salida.
  • center_input_sample (bool, opcional, por defecto False) — Si se centra la muestra de entrada.
  • flip_sin_to_cos (bool, opcional, valor predeterminado True) — Si se debe cambiar el sin a cos en la incrustación temporal.
  • freq_shift (int, opcional, valor predeterminado 0) — El desplazamiento de frecuencia que se aplicará a la incrustación temporal.
  • down_block_types (tuple[str], opcional, por defecto ("CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "DownBlock2D")) — La tupla de bloques de muestreo descendente a utilizar.
  • mid_block_type (str, opcional, valor predeterminado "UNetMidBlock2DCrossAttn") — Tipo de bloque para la parte central de UNet; puede ser uno de UNetMidBlock2DCrossAttn, UNetMidBlock2D o UNetMidBlock2DSimpleCrossAttn. Si es None, se omite la capa del bloque central.
  • up_block_types (tuple[str], opcional, por defecto ("UpBlock2D", "CrossAttnUpBlock2D", "CrossAttnUpBlock2D", "CrossAttnUpBlock2D")) — La tupla de bloques de remuestreo ascendente a utilizar.
  • only_cross_attention(bool or tuple[bool], opcional, por defecto False) — Si se debe incluir la autoatención en los bloques básicos de transformer, ver BasicTransformerBlock.
  • block_out_channels (tuple[int], opcional, por defecto (320, 640, 1280, 1280)) — La tupla de canales de salida para cada bloque.
  • layers_per_block (int, opcional, valor predeterminado 2) — El número de capas por bloque.
  • downsample_padding (int, opcional, valor predeterminado 1) — El relleno a utilizar para la convolución de reducción de muestreo.
  • mid_block_scale_factor (float, opcional, valor predeterminado 1.0) — El factor de escala a utilizar para el bloque intermedio.
  • dropout (float, opcional, valor predeterminado 0.0) — La probabilidad de dropout a utilizar.
  • act_fn (str, opcional, por defecto "silu") — La función de activación a utilizar.
  • norm_num_groups (int, opcional, valor predeterminado 32) — El número de grupos a utilizar para la normalización. Si None, se omiten las capas de normalización y activación en el posprocesamiento.
  • norm_eps (float, opcional, valor predeterminado 1e-5) — El epsilon a utilizar para la normalización.
  • cross_attention_dim (int o tuple[int], opcional, valor predeterminado 1280) — La dimensión de las características de atención cruzada.
  • transformer_layers_per_block (int, tuple[int] o tuple[tuple] , opcional, valor predeterminado 1) — El número de bloques de transformador de tipo BasicTransformerBlock. Solo es relevante para CrossAttnDownBlock2D, CrossAttnUpBlock2D, UNetMidBlock2DCrossAttn.
  • reverse_transformer_layers_per_block — (tuple[tuple], opcional, valor predeterminado None): El número de bloques de transformador de tipo BasicTransformerBlock en los bloques de remuestreo ascendente de la U-Net. Solo es relevante si transformer_layers_per_block es de tipo tuple[tuple] y para CrossAttnDownBlock2D, CrossAttnUpBlock2D, UNetMidBlock2DCrossAttn.
  • encoder_hid_dim (int, opcional, valor predeterminado None) — Si encoder_hid_dim_type está definido, encoder_hidden_states se proyectará desde la dimensión encoder_hid_dim hasta cross_attention_dim.
  • encoder_hid_dim_type (str, opcional, valor predeterminado None) — Si se especifica, encoder_hidden_states y posiblemente otras incrustaciones se proyectan hacia abajo a incrustaciones de texto de dimensión cross_attention según encoder_hid_dim_type.
  • attention_head_dim (int, opcional, valor predeterminado 8) — La dimensión de las cabezas de atención.
  • num_attention_heads (int, opcional) — El número de cabezas de atención. Si no se define, el valor predeterminado es attention_head_dim
  • resnet_time_scale_shift (str, opcional, valor predeterminado "default") — Configuración de desplazamiento de escala de tiempo para los bloques ResNet (ver ResnetBlock2D). Elija entre default o scale_shift.
  • class_embed_type (str, opcional, valor predeterminado None) — El tipo de incrustación de clase que se utilizará y que finalmente se suma a las incrustaciones de tiempo. Elija entre None, "timestep", "identity", "projection" o "simple_projection".
  • addition_embed_type (str, opcional, valor predeterminado None) — Configura un embedding opcional que se sumará con los embeddings de tiempo. Elige entre None o “text”. “text” utilizará la capa TextTimeEmbedding.
  • addition_time_embed_dim — (int, opcional, valor predeterminado None): Dimensión para las incrustaciones de paso de tiempo.
  • num_class_embeds (int, opcional, valor predeterminado None) — Dimensión de entrada de la matriz de incrustación aprendible que se proyectará a time_embed_dim, al realizar condicionamiento por clase con class_embed_type igual a None.
  • time_embedding_type (str, opcional, valor predeterminado positional) — El tipo de incrustación de posición que se utilizará para los pasos de tiempo. Elija entre positional o fourier.
  • time_embedding_dim (int, opcional, valor predeterminado None) — Un valor opcional para sobrescribir la dimensión del embedding de tiempo proyectado.
  • time_embedding_act_fn (str, opcional, valor predeterminado None) — Función de activación opcional para usar solo una vez en las incrustaciones de tiempo antes de pasarlas al resto de la UNet. Elija entre silu, mish, gelu y swish.
  • timestep_post_act (str, opcional, valor predeterminado None) — La segunda función de activación a utilizar en la incrustación de paso de tiempo. Elija entre silu, mish y gelu.
  • time_cond_proj_dim (int, opcional, valor predeterminado None) — La dimensión de la capa cond_proj en la incrustación del paso de tiempo.
  • conv_in_kernel (int, opcional, valor predeterminado 3) — El tamaño del kernel de la capa conv_in.
  • conv_out_kernel (int, opcional, valor predeterminado 3) — El tamaño del kernel de la capa conv_out.
  • projection_class_embeddings_input_dim (int, opcional) — La dimensión de la entrada class_labels cuando class_embed_type="projection". Obligatorio cuando class_embed_type="projection".
  • class_embeddings_concat (bool, opcional, valor predeterminado False) — Si se deben concatenar las incrustaciones de tiempo con las incrustaciones de clase.
  • mid_block_only_cross_attention (bool, opcional, valor predeterminado None) — Si se debe usar atención cruzada con el bloque intermedio al utilizar UNetMidBlock2DSimpleCrossAttn. Si only_cross_attention se proporciona como un único booleano y mid_block_only_cross_attention es None, se utiliza el valor de only_cross_attention como valor para mid_block_only_cross_attention. De lo contrario, el valor predeterminado es False.

Un modelo 2D UNet condicional que toma una muestra con ruido, un estado condicional y un paso de tiempo y devuelve una salida con forma de muestra.

Este modelo hereda de ModelMixin. Consulta la documentación de la clase superior para sus métodos genéricos implementados para todos los modelos (como la descarga o el guardado).

disable_freeu

< >

( )

Desactiva el mecanismo FreeU.

enable_freeu

< >

( s1: floats2: floatb1: floatb2: float )

Parámetros

  • s1 (float) — Factor de escala para la etapa 1 para atenuar las contribuciones de las características de salto. Esto se hace para mitigar el “efecto de sobre-almohadillado” en el proceso de desruido mejorado.
  • s2 (float) — Factor de escala para la etapa 2 para atenuar las contribuciones de las características de salto. Esto se hace para mitigar el “efecto de sobre-estriado” en el proceso de desruido mejorado.
  • b1 (float) — Factor de escala para la etapa 1 para amplificar las contribuciones de las características del backbone.
  • b2 (float) — Factor de escala para la etapa 2 para amplificar las contribuciones de las características del backbone.

Habilita el mecanismo FreeU de https://huggingface.co/papers/2309.11497.

Los sufijos después de los factores de escalado representan los bloques de etapa en los que se están aplicando.

Consulte el repositorio oficial para conocer las combinaciones de valores que funcionan bien en diferentes pipelines, como Stable Diffusion v1, v2 y 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) — El tensor de entrada con ruido con la siguiente forma (batch, channel, height, width).
  • timestep (torch.Tensor o float o int) — El número de pasos de tiempo para desruidar una entrada.
  • encoder_hidden_states (torch.Tensor) — Los estados ocultos del codificador con forma (batch, sequence_length, feature_dim).
  • class_labels (torch.Tensor, opcional, valor predeterminado None) — Etiquetas de clase opcionales para la condición. Sus incrustaciones se sumarán con las incrustaciones del paso de tiempo.
  • timestep_cond — (torch.Tensor, opcional, valor predeterminado None): Incrustados condicionales para el paso de tiempo. Si se proporcionan, los incrustados se sumarán con las muestras pasadas a través de la capa self.time_embedding para obtener los incrustados del paso de tiempo.
  • attention_mask (torch.Tensor, opcional, valor predeterminado None) — Una máscara de atención de forma (batch, key_tokens) se aplica a encoder_hidden_states. Si el valor es 1, la máscara se conserva; en caso contrario, si es 0, se descarta. La máscara se convierte en un sesgo que suma valores negativos grandes a las puntuaciones de atención correspondientes a los tokens “descartados”.
  • cross_attention_kwargs (dict, opcional) — Un diccionario de kwargs que, si se especifica, se pasa al AttentionProcessor definido en self.processor dentro de diffusers.models.attention_processor.
  • added_cond_kwargs — (dict, opcional): Un diccionario de kwargs que contiene embeddings adicionales que, si se especifican, se añaden a los embeddings que se pasan a los bloques de UNet.
  • down_block_additional_residuals — (tuple de torch.Tensor, opcional): Una tupla de tensores que, si se especifica, se suma a los residuos de los bloques down de unet.
  • mid_block_additional_residual — (torch.Tensor, opcional): Un tensor que, si se especifica, se suma al residual del bloque intermedio de unet.
  • down_intrablock_additional_residuals (tuple de torch.Tensor, opcional) — residuos adicionales que se añaden dentro de los bloques de bajada de UNet, por ejemplo, procedentes de modelos laterales de T2I-Adapter
  • encoder_attention_mask (torch.Tensor) — Una máscara de atención cruzada de forma (batch, sequence_length) se aplica a encoder_hidden_states. Si True, la máscara se conserva; en caso contrario, si False, se descarta. La máscara se convertirá en un sesgo, que añade valores negativos grandes a las puntuaciones de atención correspondientes a los tokens “descartados”.
  • return_dict (bool, opcional, valor predeterminado True) — Indica si se debe devolver un UNet2DConditionOutput en lugar de una tupla simple.

Devuelve

UNet2DConditionOutput o tuple

Si return_dict es True, se devuelve un UNet2DConditionOutput, en caso contrario se devuelve una tuple donde el primer elemento es el tensor de la muestra.

El método forward de UNet2DConditionModel.

fuse_qkv_projections

< >

( )

Habilita las proyecciones QKV fusionadas. Para los módulos de autoatención, todas las matrices de proyección (es decir, consulta, clave y valor) se fusionan. Para los módulos de atención cruzada, las matrices de proyección de clave y valor se fusionan.

> Esta API es 🧪 experimental.

set_attention_slice

< >

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

Parámetros

  • slice_size (str o int o list(int), opcional, valor predeterminado "auto") — Cuando es "auto", la entrada a las cabezas de atención se divide a la mitad, por lo que la atención se calcula en dos pasos. Si es "max", se ahorra la máxima cantidad de memoria ejecutando solo una porción a la vez. Si se proporciona un número, se usan tantas porciones como attention_head_dim // slice_size. En este caso, attention_head_dim debe ser un múltiplo de slice_size.

Habilitar el cálculo de atención segmentada.

Cuando esta opción está habilitada, el módulo de atención divide el tensor de entrada en fragmentos para calcular la atención en varias etapas. Esto es útil para ahorrar algo de memoria a cambio de una pequeña disminución en la velocidad.

set_default_attn_processor

< >

( )

Desactiva los procesadores de atención personalizados y establece la implementación de atención predeterminada.

unfuse_qkv_projections

< >

( )

Desactiva la proyección QKV fusionada si está habilitada.

> Esta API es 🧪 experimental.

UNet2DConditionOutput

clase diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput

< >

( sample: Tensor = None )

Parámetros

  • sample (torch.Tensor de forma (batch_size, num_channels, height, width)) — Estados ocultos de salida condicionados a la entrada encoder_hidden_states. Salida de la última capa del modelo.

La salida de UNet2DConditionModel.

Update on GitHub

←UNet1DModel UNet2DModel→