Buckets:

hf-doc-build
/

doc

Files

xet

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

mishig

3 days ago

preview code

download

raw

8.39 kB

# PixArtTransformer2DModel

Model Transformer untuk data seperti gambar dari [PixArt-Alpha](https://huggingface.co/papers/2310.00426) dan [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')
```

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

**Parameter:**

num_attention_heads (int, opsional, default 16) : Jumlah head yang digunakan untuk multi-head attention.

attention_head_dim (int, opsional, default 72) : Jumlah channel di setiap head.

in_channels (int, defaultnya 4) : Jumlah channel pada input.
out_channels (int, opsional) : Jumlah channel pada output. Tentukan parameter ini jika jumlah channel output berbeda dari input.

num_layers (int, opsional, default 28) : Jumlah lapisan blok Transformer yang akan digunakan.
dropout (float, opsional, default 0.0) : Probabilitas dropout yang digunakan di dalam blok Transformer.
norm_num_groups (int, opsional, default 32) : Jumlah grup untuk normalisasi grup di dalam blok Transformer.
cross_attention_dim (int, opsional) : Dimensi untuk lapisan cross-attention, biasanya sesuai dengan dimensi tersembunyi encoder.
attention_bias (bool, opsional, default True) : Mengonfigurasi apakah perhatian pada blok Transformer harus mengandung parameter bias.

sample_size (int, defaultnya 128) : Lebar dari gambar laten. Parameter ini tetap selama pelatihan.
patch_size (int, defaultnya 2) : Ukuran patch yang diproses oleh model, relevan untuk arsitektur yang bekerja pada data non-berurutan.

activation_fn (str, opsional, default "gelu-approximate") : Fungsi aktivasi yang digunakan dalam jaringan feed-forward di dalam blok Transformer.
num_embeds_ada_norm (int, opsional, default 1000) : Jumlah embedding untuk AdaLayerNorm, tetap selama pelatihan dan memengaruhi jumlah langkah denoising maksimum selama inferensi.

upcast_attention (bool, opsional, default False) : Jika true, menaikkan dimensi mekanisme perhatian untuk potensi peningkatan kinerja.
norm_type (str, opsional, default "ada_norm_zero") : Menentukan jenis normalisasi yang digunakan, dapat berupa 'ada_norm_zero'.

norm_elementwise_affine (bool, opsional, default False) : Jika true, mengaktifkan parameter afine per elemen di lapisan normalisasi.

norm_eps (float, opsional, default 1e-6) : Konstanta kecil yang ditambahkan ke penyebut pada lapisan normalisasi untuk mencegah pembagian dengan nol.
interpolation_scale (int, opsional) : Faktor skala yang digunakan saat menginterpolasi embedding posisi.

use_additional_conditions (bool, opsional) : Jika kita menggunakan kondisi tambahan sebagai input.

attention_type (str, opsional, default "default") : Jenis mekanisme perhatian yang akan digunakan.
caption_channels (int, opsional, default None) : Jumlah channel yang digunakan untuk memproyeksikan embedding caption.

use_linear_projection (bool, opsional, default False) : Argumen yang tidak lagi didukung. Akan dihapus pada versi mendatang.

num_vector_embeds (bool, opsional, default False) : Argumen yang tidak lagi didukung. Akan dihapus pada versi mendatang.

Model Transformer 2D yang diperkenalkan dalam keluarga model 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)
```

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

**Parameter:**

hidden_states (`torch.FloatTensor` dengan bentuk `(batch size, channel, height, width)`) : Input `hidden_states`.

encoder_hidden_states (`torch.FloatTensor` dengan bentuk `(batch size, sequence len, embed dims)`, *opsional*) : Embedding kondisional untuk lapisan cross attention. Jika tidak diberikan, cross-attention secara default menggunakan self-attention.

timestep (`torch.LongTensor`, *opsional*) : Digunakan untuk menunjukkan langkah denoising. Timestep opsional yang diterapkan sebagai embedding di `AdaLayerNorm`.

added_cond_kwargs : (`dict[str, Any]`, *opsional*): Kondisi tambahan yang akan digunakan sebagai input.

cross_attention_kwargs ( `dict[str, Any]`, *opsional*) : Sebuah kamus kwargs yang jika ditentukan akan diteruskan ke `AttentionProcessor` seperti yang didefinisikan di bawah `self.processor` dalam [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

attention_mask ( `torch.Tensor`, *opsional*) : Mask perhatian dengan bentuk `(batch, key_tokens)` diterapkan pada `encoder_hidden_states`. Jika `1`, mask dipertahankan, sedangkan jika `0`, mask dibuang. Mask akan dikonversi menjadi bias, yang menambahkan nilai negatif besar ke skor perhatian yang sesuai dengan token "buang".

encoder_attention_mask ( `torch.Tensor`, *opsional*) : Mask cross-attention yang diterapkan pada `encoder_hidden_states`. Dua format didukung:  * Mask `(batch, sequence_length)` True = simpan, False = buang. * Bias `(batch, 1, sequence_length)` 0 = simpan, -10000 = buang.  Jika `ndim == 2`: akan diinterpretasikan sebagai mask, kemudian dikonversi menjadi bias yang konsisten dengan format di atas. Bias ini akan ditambahkan ke skor cross-attention.

return_dict (`bool`, *opsional*, defaultnya `True`) : Apakah akan mengembalikan [UNet2DConditionOutput](/docs/diffusers/main/id/api/models/unet2d-cond#diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput) alih-alih tuple biasa.
**Mengembalikan:**
Jika `return_dict` bernilai True, sebuah `~models.transformer_2d.Transformer2DModelOutput` akan dikembalikan, selain itu sebuah `tuple` di mana elemen pertama adalah tensor sampel.
Metode forward dari [PixArtTransformer2DModel](/docs/diffusers/main/id/api/models/pixart_transformer2d#diffusers.PixArtTransformer2DModel).
#### fuse_qkv_projections[[diffusers.PixArtTransformer2DModel.fuse_qkv_projections]]
```python
fuse_qkv_projections()
```
[Sumber](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L196)
Mengaktifkan proyeksi QKV yang digabungkan. Untuk modul self-attention, semua matriks proyeksi (yaitu, query, key, value) digabungkan. Untuk modul cross-attention, matriks proyeksi key dan value digabungkan.
> [!WARNING] > API ini 🧪 eksperimental.
#### set_default_attn_processor[[diffusers.PixArtTransformer2DModel.set_default_attn_processor]]
```python
set_default_attn_processor()
```
[Sumber](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L187)
Menonaktifkan prosesor perhatian kustom dan mengatur implementasi perhatian default.
Aman untuk langsung menggunakan `AttnProcessor()` karena PixArt tidak memiliki prosesor perhatian eksotis apa pun di model default.
#### unfuse_qkv_projections[[diffusers.PixArtTransformer2DModel.unfuse_qkv_projections]]
```python
unfuse_qkv_projections()
```
[Sumber](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L218)
Menonaktifkan proyeksi QKV yang digabungkan jika diaktifkan.
> [!WARNING] > API ini 🧪 eksperimental.

Xet Storage Details

Size:: 8.39 kB
Xet hash:: 59d2af7d20370f91e74f871e5a9faf3f769e06f05dc2feb9221ff2d79547a947

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

	# PixArtTransformer2DModel

	Model Transformer untuk data seperti gambar dari [PixArt-Alpha](https://huggingface.co/papers/2310.00426) dan [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')
	```

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

	Parameter:

	num_attention_heads (int, opsional, default 16) : Jumlah head yang digunakan untuk multi-head attention.

	attention_head_dim (int, opsional, default 72) : Jumlah channel di setiap head.

	in_channels (int, defaultnya 4) : Jumlah channel pada input.

	out_channels (int, opsional) : Jumlah channel pada output. Tentukan parameter ini jika jumlah channel output berbeda dari input.

	num_layers (int, opsional, default 28) : Jumlah lapisan blok Transformer yang akan digunakan.

	dropout (float, opsional, default 0.0) : Probabilitas dropout yang digunakan di dalam blok Transformer.

	norm_num_groups (int, opsional, default 32) : Jumlah grup untuk normalisasi grup di dalam blok Transformer.

	cross_attention_dim (int, opsional) : Dimensi untuk lapisan cross-attention, biasanya sesuai dengan dimensi tersembunyi encoder.

	attention_bias (bool, opsional, default True) : Mengonfigurasi apakah perhatian pada blok Transformer harus mengandung parameter bias.

	sample_size (int, defaultnya 128) : Lebar dari gambar laten. Parameter ini tetap selama pelatihan.

	patch_size (int, defaultnya 2) : Ukuran patch yang diproses oleh model, relevan untuk arsitektur yang bekerja pada data non-berurutan.

	activation_fn (str, opsional, default "gelu-approximate") : Fungsi aktivasi yang digunakan dalam jaringan feed-forward di dalam blok Transformer.

	num_embeds_ada_norm (int, opsional, default 1000) : Jumlah embedding untuk AdaLayerNorm, tetap selama pelatihan dan memengaruhi jumlah langkah denoising maksimum selama inferensi.

	upcast_attention (bool, opsional, default False) : Jika true, menaikkan dimensi mekanisme perhatian untuk potensi peningkatan kinerja.

	norm_type (str, opsional, default "ada_norm_zero") : Menentukan jenis normalisasi yang digunakan, dapat berupa 'ada_norm_zero'.

	norm_elementwise_affine (bool, opsional, default False) : Jika true, mengaktifkan parameter afine per elemen di lapisan normalisasi.

	norm_eps (float, opsional, default 1e-6) : Konstanta kecil yang ditambahkan ke penyebut pada lapisan normalisasi untuk mencegah pembagian dengan nol.

	interpolation_scale (int, opsional) : Faktor skala yang digunakan saat menginterpolasi embedding posisi.

	use_additional_conditions (bool, opsional) : Jika kita menggunakan kondisi tambahan sebagai input.

	attention_type (str, opsional, default "default") : Jenis mekanisme perhatian yang akan digunakan.

	caption_channels (int, opsional, default None) : Jumlah channel yang digunakan untuk memproyeksikan embedding caption.

	use_linear_projection (bool, opsional, default False) : Argumen yang tidak lagi didukung. Akan dihapus pada versi mendatang.

	num_vector_embeds (bool, opsional, default False) : Argumen yang tidak lagi didukung. Akan dihapus pada versi mendatang.

	Model Transformer 2D yang diperkenalkan dalam keluarga model 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)
	```

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

	Parameter:

	hidden_states (`torch.FloatTensor` dengan bentuk `(batch size, channel, height, width)`) : Input `hidden_states`.

	encoder_hidden_states (`torch.FloatTensor` dengan bentuk `(batch size, sequence len, embed dims)`, opsional) : Embedding kondisional untuk lapisan cross attention. Jika tidak diberikan, cross-attention secara default menggunakan self-attention.

	timestep (`torch.LongTensor`, opsional) : Digunakan untuk menunjukkan langkah denoising. Timestep opsional yang diterapkan sebagai embedding di `AdaLayerNorm`.

	added_cond_kwargs : (`dict[str, Any]`, opsional): Kondisi tambahan yang akan digunakan sebagai input.

	cross_attention_kwargs ( `dict[str, Any]`, opsional) : Sebuah kamus kwargs yang jika ditentukan akan diteruskan ke `AttentionProcessor` seperti yang didefinisikan di bawah `self.processor` dalam [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

	attention_mask ( `torch.Tensor`, opsional) : Mask perhatian dengan bentuk `(batch, key_tokens)` diterapkan pada `encoder_hidden_states`. Jika `1`, mask dipertahankan, sedangkan jika `0`, mask dibuang. Mask akan dikonversi menjadi bias, yang menambahkan nilai negatif besar ke skor perhatian yang sesuai dengan token "buang".

	encoder_attention_mask ( `torch.Tensor`, opsional) : Mask cross-attention yang diterapkan pada `encoder_hidden_states`. Dua format didukung: * Mask `(batch, sequence_length)` True = simpan, False = buang. * Bias `(batch, 1, sequence_length)` 0 = simpan, -10000 = buang. Jika `ndim == 2`: akan diinterpretasikan sebagai mask, kemudian dikonversi menjadi bias yang konsisten dengan format di atas. Bias ini akan ditambahkan ke skor cross-attention.

	return_dict (`bool`, opsional, defaultnya `True`) : Apakah akan mengembalikan [UNet2DConditionOutput](/docs/diffusers/main/id/api/models/unet2d-cond#diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput) alih-alih tuple biasa.

	Mengembalikan:

	Jika `return_dict` bernilai True, sebuah `~models.transformer_2d.Transformer2DModelOutput` akan dikembalikan, selain itu sebuah `tuple` di mana elemen pertama adalah tensor sampel.

	Metode forward dari [PixArtTransformer2DModel](/docs/diffusers/main/id/api/models/pixart_transformer2d#diffusers.PixArtTransformer2DModel).

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

	```python
	fuse_qkv_projections()
	```

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

	Mengaktifkan proyeksi QKV yang digabungkan. Untuk modul self-attention, semua matriks proyeksi (yaitu, query, key, value) digabungkan. Untuk modul cross-attention, matriks proyeksi key dan value digabungkan.

	> [!WARNING] > API ini 🧪 eksperimental.

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

	```python
	set_default_attn_processor()
	```

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

	Menonaktifkan prosesor perhatian kustom dan mengatur implementasi perhatian default.

	Aman untuk langsung menggunakan `AttnProcessor()` karena PixArt tidak memiliki prosesor perhatian eksotis apa pun di model default.

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

	```python
	unfuse_qkv_projections()
	```

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

	Menonaktifkan proyeksi QKV yang digabungkan jika diaktifkan.

	> [!WARNING] > API ini 🧪 eksperimental.