Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /es /api /models /pixart_transformer2d.md

mishig

3 days ago

preview code

download

raw

8.99 kB

# PixArtTransformer2DModel

Un modelo Transformer para datos similares a imágenes de [PixArt-Alpha](https://huggingface.co/papers/2310.00426) y [PixArt-Sigma](https://huggingface.co/papers/2403.04692).

## PixArtTransformer2DModel[[diffusers.PixArtTransformer2DModel]]

#### diffusers.PixArtTransformer2DModel[[diffusers.PixArtTransformer2DModel]]

```python
diffusers.PixArtTransformer2DModel(num_attention_heads: int = 16, attention_head_dim: int = 72, in_channels: int = 4, out_channels: int | None = 8, num_layers: int = 28, dropout: float = 0.0, norm_num_groups: int = 32, cross_attention_dim: int | None = 1152, attention_bias: bool = True, sample_size: int = 128, patch_size: int = 2, activation_fn: str = 'gelu-approximate', num_embeds_ada_norm: int | None = 1000, upcast_attention: bool = False, norm_type: str = 'ada_norm_single', norm_elementwise_affine: bool = False, norm_eps: float = 1e-06, interpolation_scale: int | None = None, use_additional_conditions: bool | None = None, caption_channels: int | None = None, attention_type: str | None = 'default')
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L32)

**Parámetros:**

num_attention_heads (int, opcional, predeterminado a 16) : El número de cabezas a utilizar para la atención multi-cabeza.

attention_head_dim (int, opcional, predeterminado a 72) : El número de canales en cada cabeza.

in_channels (int, por defecto 4) : El número de canales en la entrada.
out_channels (int, opcional) : El número de canales en la salida. Especifique este parámetro si el número de canales de salida difiere del de entrada.

num_layers (int, opcional, predeterminado a 28) : El número de capas de bloques Transformer a utilizar.
dropout (float, opcional, valor predeterminado 0.0) : La probabilidad de dropout a utilizar dentro de los bloques Transformer.
norm_num_groups (int, opcional, valor predeterminado 32) : Número de grupos para la normalización por grupo dentro de los bloques de Transformer.
cross_attention_dim (int, opcional) : La dimensionalidad para las capas de atención cruzada, que normalmente coincide con la dimensión oculta del codificador.
attention_bias (bool, opcional, predeterminado a True) : Configura si la atención de los bloques Transformer debe incluir un parámetro de sesgo.

sample_size (int, por defecto 128) : El ancho de las imágenes latentes. Este parámetro es fijo durante el entrenamiento.
patch_size (int, por defecto 2) : Tamaño de los parches que procesa el modelo, relevante para arquitecturas que trabajan con datos no secuenciales.

activation_fn (str, opcional, predeterminado a "gelu-approximate") : Función de activación a utilizar en las redes feed-forward dentro de los bloques Transformer.
num_embeds_ada_norm (int, opcional, predeterminado a 1000) : Número de embeddings para AdaLayerNorm, fijo durante el entrenamiento y afecta los pasos máximos de desruido durante la inferencia.

upcast_attention (bool, opcional, predeterminado a False) : Si es true, aumenta las dimensiones del mecanismo de atención para un posible mejor rendimiento.
norm_type (str, opcional, valor predeterminado "ada_norm_zero") : especifica el tipo de normalización utilizado, puede ser 'ada_norm_zero'.

norm_elementwise_affine (bool, opcional, predeterminado a False) : Si es true, habilita los parámetros afines elemento a elemento en las capas de normalización.

norm_eps (float, opcional, valor predeterminado 1e-6) : Una constante pequeña que se suma al denominador en las capas de normalización para evitar la división por cero.
interpolation_scale (int, opcional) : Factor de escala a utilizar durante la interpolación de los embeddings de posición.

use_additional_conditions (bool, opcional) : Si estamos usando condiciones adicionales como entradas.

attention_type (str, opcional, valor predeterminado "default") : Tipo de mecanismo de atención que se utilizará.
caption_channels (int, opcional, predeterminado a None) : Número de canales para usar en la proyección de los embeddings de la descripción.

use_linear_projection (bool, opcional, predeterminado a False) : Argumento obsoleto. Se eliminará en una versión futura.

num_vector_embeds (bool, opcional, predeterminado a False) : Argumento obsoleto. Se eliminará en una versión futura.

Un modelo Transformer 2D tal como se introdujo en la familia de modelos PixArt (https://huggingface.co/papers/2310.00426, https://huggingface.co/papers/2403.04692).

#### forward[[diffusers.PixArtTransformer2DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: typing.Optional[torch.Tensor] = None, timestep: typing.Optional[torch.LongTensor] = None, added_cond_kwargs: dict[str, torch.Tensor] = None, cross_attention_kwargs: dict[str, typing.Any] = None, attention_mask: typing.Optional[torch.Tensor] = None, encoder_attention_mask: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L227)

**Parámetros:**

hidden_states (`torch.FloatTensor` de forma `(batch size, channel, height, width)`) : `hidden_states` de entrada.

encoder_hidden_states (`torch.FloatTensor` de forma `(batch size, sequence len, embed dims)`, *opcional*) : Incrustaciones condicionales para la capa de atención cruzada. Si no se proporcionan, la atención cruzada predeterminada es la autoatención.

timestep (`torch.LongTensor`, *opcional*) : Se utiliza para indicar el paso de desruido. Paso temporal opcional que se aplica como un embedding en `AdaLayerNorm`.

added_cond_kwargs : (`dict[str, Any]`, *opcional*): Condiciones adicionales que se usarán como entradas.

cross_attention_kwargs ( `dict[str, Any]`, *opcional*) : Un diccionario de kwargs que, si se especifica, se pasa al `AttentionProcessor` definido bajo `self.processor` en [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

attention_mask ( `torch.Tensor`, *opcional*) : Se aplica una máscara de atención de forma `(batch, key_tokens)` a `encoder_hidden_states`. Si es `1`, la máscara se conserva; en caso contrario, si es `0`, 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".

encoder_attention_mask ( `torch.Tensor`, *opcional*) : Máscara de atención cruzada aplicada a `encoder_hidden_states`. Se admiten dos formatos:  * Máscara `(batch, sequence_length)` True = conservar, False = descartar. * Sesgo `(batch, 1, sequence_length)` 0 = conservar, -10000 = descartar.  Si `ndim == 2`: se interpretará como una máscara y luego se convertirá en un sesgo coherente con el formato anterior. Este sesgo se sumará a las puntuaciones de atención cruzada.

return_dict (`bool`, *opcional*, valor predeterminado `True`) : Indica si se debe devolver un [UNet2DConditionOutput](/docs/diffusers/main/es/api/models/unet2d-cond#diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput) en lugar de una tupla simple.
**Devuelve:**
Si `return_dict` es True, se devuelve un `~models.transformer_2d.Transformer2DModelOutput`; en caso contrario, se devuelve una `tuple` cuyo primer elemento es el tensor de la muestra.
El método forward de [PixArtTransformer2DModel](/docs/diffusers/main/es/api/models/pixart_transformer2d#diffusers.PixArtTransformer2DModel).
#### fuse_qkv_projections[[diffusers.PixArtTransformer2DModel.fuse_qkv_projections]]
```python
fuse_qkv_projections()
```
[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L196)
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.
> [!WARNING] > Esta API es 🧪 experimental.
#### set_default_attn_processor[[diffusers.PixArtTransformer2DModel.set_default_attn_processor]]
```python
set_default_attn_processor()
```
[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L187)
Desactiva los procesadores de atención personalizados y establece la implementación de atención predeterminada.
Es seguro usar simplemente `AttnProcessor()` ya que PixArt no tiene procesadores de atención exóticos en el modelo predeterminado.
#### unfuse_qkv_projections[[diffusers.PixArtTransformer2DModel.unfuse_qkv_projections]]
```python
unfuse_qkv_projections()
```
[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L218)
Desactiva la proyección QKV fusionada si está habilitada.
> [!WARNING] > Esta API es 🧪 experimental.

Xet Storage Details

Size:: 8.99 kB
Xet hash:: 30f0bd251853b4e003ce9ca39afaa6a22abc2b18ac113499430a010eacee84e5

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# PixArtTransformer2DModel

	Un modelo Transformer para datos similares a imágenes de [PixArt-Alpha](https://huggingface.co/papers/2310.00426) y [PixArt-Sigma](https://huggingface.co/papers/2403.04692).

	## PixArtTransformer2DModel[[diffusers.PixArtTransformer2DModel]]

	#### diffusers.PixArtTransformer2DModel[[diffusers.PixArtTransformer2DModel]]

	```python
	diffusers.PixArtTransformer2DModel(num_attention_heads: int = 16, attention_head_dim: int = 72, in_channels: int = 4, out_channels: int \| None = 8, num_layers: int = 28, dropout: float = 0.0, norm_num_groups: int = 32, cross_attention_dim: int \| None = 1152, attention_bias: bool = True, sample_size: int = 128, patch_size: int = 2, activation_fn: str = 'gelu-approximate', num_embeds_ada_norm: int \| None = 1000, upcast_attention: bool = False, norm_type: str = 'ada_norm_single', norm_elementwise_affine: bool = False, norm_eps: float = 1e-06, interpolation_scale: int \| None = None, use_additional_conditions: bool \| None = None, caption_channels: int \| None = None, attention_type: str \| None = 'default')
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L32)

	Parámetros:

	num_attention_heads (int, opcional, predeterminado a 16) : El número de cabezas a utilizar para la atención multi-cabeza.

	attention_head_dim (int, opcional, predeterminado a 72) : El número de canales en cada cabeza.

	in_channels (int, por defecto 4) : El número de canales en la entrada.

	out_channels (int, opcional) : El número de canales en la salida. Especifique este parámetro si el número de canales de salida difiere del de entrada.

	num_layers (int, opcional, predeterminado a 28) : El número de capas de bloques Transformer a utilizar.

	dropout (float, opcional, valor predeterminado 0.0) : La probabilidad de dropout a utilizar dentro de los bloques Transformer.

	norm_num_groups (int, opcional, valor predeterminado 32) : Número de grupos para la normalización por grupo dentro de los bloques de Transformer.

	cross_attention_dim (int, opcional) : La dimensionalidad para las capas de atención cruzada, que normalmente coincide con la dimensión oculta del codificador.

	attention_bias (bool, opcional, predeterminado a True) : Configura si la atención de los bloques Transformer debe incluir un parámetro de sesgo.

	sample_size (int, por defecto 128) : El ancho de las imágenes latentes. Este parámetro es fijo durante el entrenamiento.

	patch_size (int, por defecto 2) : Tamaño de los parches que procesa el modelo, relevante para arquitecturas que trabajan con datos no secuenciales.

	activation_fn (str, opcional, predeterminado a "gelu-approximate") : Función de activación a utilizar en las redes feed-forward dentro de los bloques Transformer.

	num_embeds_ada_norm (int, opcional, predeterminado a 1000) : Número de embeddings para AdaLayerNorm, fijo durante el entrenamiento y afecta los pasos máximos de desruido durante la inferencia.

	upcast_attention (bool, opcional, predeterminado a False) : Si es true, aumenta las dimensiones del mecanismo de atención para un posible mejor rendimiento.

	norm_type (str, opcional, valor predeterminado "ada_norm_zero") : especifica el tipo de normalización utilizado, puede ser 'ada_norm_zero'.

	norm_elementwise_affine (bool, opcional, predeterminado a False) : Si es true, habilita los parámetros afines elemento a elemento en las capas de normalización.

	norm_eps (float, opcional, valor predeterminado 1e-6) : Una constante pequeña que se suma al denominador en las capas de normalización para evitar la división por cero.

	interpolation_scale (int, opcional) : Factor de escala a utilizar durante la interpolación de los embeddings de posición.

	use_additional_conditions (bool, opcional) : Si estamos usando condiciones adicionales como entradas.

	attention_type (str, opcional, valor predeterminado "default") : Tipo de mecanismo de atención que se utilizará.

	caption_channels (int, opcional, predeterminado a None) : Número de canales para usar en la proyección de los embeddings de la descripción.

	use_linear_projection (bool, opcional, predeterminado a False) : Argumento obsoleto. Se eliminará en una versión futura.

	num_vector_embeds (bool, opcional, predeterminado a False) : Argumento obsoleto. Se eliminará en una versión futura.

	Un modelo Transformer 2D tal como se introdujo en la familia de modelos PixArt (https://huggingface.co/papers/2310.00426, https://huggingface.co/papers/2403.04692).

	#### forward[[diffusers.PixArtTransformer2DModel.forward]]

	```python
	forward(hidden_states: Tensor, encoder_hidden_states: typing.Optional[torch.Tensor] = None, timestep: typing.Optional[torch.LongTensor] = None, added_cond_kwargs: dict[str, torch.Tensor] = None, cross_attention_kwargs: dict[str, typing.Any] = None, attention_mask: typing.Optional[torch.Tensor] = None, encoder_attention_mask: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L227)

	Parámetros:

	hidden_states (`torch.FloatTensor` de forma `(batch size, channel, height, width)`) : `hidden_states` de entrada.

	encoder_hidden_states (`torch.FloatTensor` de forma `(batch size, sequence len, embed dims)`, opcional) : Incrustaciones condicionales para la capa de atención cruzada. Si no se proporcionan, la atención cruzada predeterminada es la autoatención.

	timestep (`torch.LongTensor`, opcional) : Se utiliza para indicar el paso de desruido. Paso temporal opcional que se aplica como un embedding en `AdaLayerNorm`.

	added_cond_kwargs : (`dict[str, Any]`, opcional): Condiciones adicionales que se usarán como entradas.

	cross_attention_kwargs ( `dict[str, Any]`, opcional) : Un diccionario de kwargs que, si se especifica, se pasa al `AttentionProcessor` definido bajo `self.processor` en [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

	attention_mask ( `torch.Tensor`, opcional) : Se aplica una máscara de atención de forma `(batch, key_tokens)` a `encoder_hidden_states`. Si es `1`, la máscara se conserva; en caso contrario, si es `0`, 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".

	encoder_attention_mask ( `torch.Tensor`, opcional) : Máscara de atención cruzada aplicada a `encoder_hidden_states`. Se admiten dos formatos: * Máscara `(batch, sequence_length)` True = conservar, False = descartar. * Sesgo `(batch, 1, sequence_length)` 0 = conservar, -10000 = descartar. Si `ndim == 2`: se interpretará como una máscara y luego se convertirá en un sesgo coherente con el formato anterior. Este sesgo se sumará a las puntuaciones de atención cruzada.

	return_dict (`bool`, opcional, valor predeterminado `True`) : Indica si se debe devolver un [UNet2DConditionOutput](/docs/diffusers/main/es/api/models/unet2d-cond#diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput) en lugar de una tupla simple.

	Devuelve:

	Si `return_dict` es True, se devuelve un `~models.transformer_2d.Transformer2DModelOutput`; en caso contrario, se devuelve una `tuple` cuyo primer elemento es el tensor de la muestra.

	El método forward de [PixArtTransformer2DModel](/docs/diffusers/main/es/api/models/pixart_transformer2d#diffusers.PixArtTransformer2DModel).

	#### fuse_qkv_projections[[diffusers.PixArtTransformer2DModel.fuse_qkv_projections]]

	```python
	fuse_qkv_projections()
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L196)

	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.

	> [!WARNING] > Esta API es 🧪 experimental.

	#### set_default_attn_processor[[diffusers.PixArtTransformer2DModel.set_default_attn_processor]]

	```python
	set_default_attn_processor()
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L187)

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

	Es seguro usar simplemente `AttnProcessor()` ya que PixArt no tiene procesadores de atención exóticos en el modelo predeterminado.

	#### unfuse_qkv_projections[[diffusers.PixArtTransformer2DModel.unfuse_qkv_projections]]

	```python
	unfuse_qkv_projections()
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L218)

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

	> [!WARNING] > Esta API es 🧪 experimental.