Buckets:

hf-doc-build
/

doc

Files

xet

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

mishig

3 days ago

preview code

download

raw

11.9 kB

# PixArtTransformer2DModel

Модель Transformer для изображений от [PixArt-Alpha](https://huggingface.co/papers/2310.00426) и [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')
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L32)

**Параметры:**

num_attention_heads (int, optional, по умолчанию 16) : Количество головок для использования в механизме внимания с несколькими головками.

attention_head_dim (int, optional, по умолчанию 72) : Количество каналов в каждой голове.

in_channels (int, по умолчанию 4) : количество каналов на входе.
out_channels (int, optional) : Количество каналов на выходе. Укажите этот параметр, если количество выходных каналов отличается от входного.

num_layers (int, optional, по умолчанию 28) : Количество блоков Transformer, используемых в модели.
dropout (float, optional, по умолчанию 0.0) : Вероятность dropout, используемая внутри блоков Transformer.
norm_num_groups (int, optional, по умолчанию 32) : Количество групп для групповой нормализации внутри блоков Transformer.
cross_attention_dim (int, optional) : Размерность для слоёв кросс-внимания, как правило, совпадающая с размерностью скрытого слоя энкодера.
attention_bias (bool, optional, по умолчанию True) : Настройка того, должен ли механизм внимания в блоках Transformer содержать параметр смещения (bias).

sample_size (int, по умолчанию 128) : Ширина латентных изображений. Этот параметр фиксируется во время обучения.
patch_size (int, по умолчанию 2) : Размер патчей, которые обрабатывает модель; актуально для архитектур, работающих с непоследовательными данными.

activation_fn (str, optional, по умолчанию "gelu-approximate") : Функция активации, используемая в полносвязных сетях внутри блоков Transformer.
num_embeds_ada_norm (int, optional, по умолчанию 1000) : Количество эмбеддингов для AdaLayerNorm, фиксированное во время обучения и влияющее на максимальное количество шагов денойзинга при инференсе.

upcast_attention (bool, optional, по умолчанию False) : Если установлено в true, повышает размерность механизма внимания для потенциального улучшения производительности.
norm_type (str, optional, по умолчанию "ada_norm_zero") : определяет тип используемой нормализации, может быть 'ada_norm_zero'.

norm_elementwise_affine (bool, optional, по умолчанию False) : Если true, включает поэлементные аффинные параметры в слоях нормализации.

norm_eps (float, optional, по умолчанию 1e-6) : Небольшая константа, добавляемая к знаменателю в слоях нормализации для предотвращения деления на ноль.
interpolation_scale (int, optional) : Коэффициент масштабирования, используемый при интерполяции позиционных эмбеддингов.

use_additional_conditions (bool, optional) : Используется ли дополнительные условия в качестве входных данных.

attention_type (str, optional, по умолчанию "default") : Тип механизма внимания, который будет использоваться.
caption_channels (int, optional, по умолчанию None) : Количество каналов, используемых для проекции эмбеддингов подписей.

use_linear_projection (bool, optional, по умолчанию False) : Устаревший аргумент. Будет удалён в будущей версии.

num_vector_embeds (bool, optional, по умолчанию False) : Устаревший аргумент. Будет удалён в будущей версии.

Двумерная модель Transformer, представленная в семействе моделей 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)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L227)

**Параметры:**

hidden_states (`torch.FloatTensor` формы `(batch size, channel, height, width)`) : Входные `hidden_states`.

encoder_hidden_states (`torch.FloatTensor` формы `(batch size, sequence len, embed dims)`, *необязательный*) : Условные эмбеддинги для слоя кросс-внимания. Если не заданы, кросс-внимание по умолчанию работает как само-внимание.

timestep (`torch.LongTensor`, *необязательный*) : Используется для указания шага денойзинга. Необязательный временной шаг, применяемый как эмбеддинг в `AdaLayerNorm`.

added_cond_kwargs : (`dict[str, Any]`, *необязательный*): Дополнительные условия, используемые в качестве входных данных.

cross_attention_kwargs ( `dict[str, Any]`, *необязательный*) : Словарь kwargs, который при указании передаётся в `AttentionProcessor`, определённый в `self.processor` в [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

attention_mask ( `torch.Tensor`, *необязательный*) : маска внимания формы `(batch, key_tokens)` применяется к `encoder_hidden_states`. Если значение равно `1`, маска сохраняется, иначе, если равно `0`, она отбрасывается. Маска преобразуется в смещение (bias), которое добавляет большие отрицательные значения к оценкам внимания, соответствующим токенам, подлежащим отбрасыванию.

encoder_attention_mask ( `torch.Tensor`, *необязательный*) : Маска кросс-внимания, применяемая к `encoder_hidden_states`. Поддерживаются два формата:  * Маска `(batch, sequence_length)` True = сохранить, False = отбросить. * Смещение `(batch, 1, sequence_length)` 0 = сохранить, -10000 = отбросить.  Если `ndim == 2`: значение будет интерпретировано как маска, а затем преобразовано в смещение, соответствующее описанному выше формату. Это смещение будет добавлено к оценкам кросс-внимания.

return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли [UNet2DConditionOutput](/docs/diffusers/main/ru/api/models/unet2d-cond#diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput) вместо обычного кортежа.
**Возвращает:**
Если `return_dict` равно True, возвращается `~models.transformer_2d.Transformer2DModelOutput`, иначе — `tuple`, первым элементом которого является тензор выборки.
Метод forward модели [PixArtTransformer2DModel](/docs/diffusers/main/ru/api/models/pixart_transformer2d#diffusers.PixArtTransformer2DModel).
#### fuse_qkv_projections[[diffusers.PixArtTransformer2DModel.fuse_qkv_projections]]
```python
fuse_qkv_projections()
```
[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L196)
Включает объединённые проекции QKV. Для модулей само-внимания все матрицы проекций (т. е. запрос, ключ, значение) объединяются. Для модулей кросс-внимания объединяются матрицы проекций ключа и значения.
> [!WARNING] > Этот API 🧪 экспериментальный.
#### set_default_attn_processor[[diffusers.PixArtTransformer2DModel.set_default_attn_processor]]
```python
set_default_attn_processor()
```
[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L187)
Отключает пользовательские обработчики внимания и устанавливает реализацию внимания по умолчанию.
Можно просто использовать `AttnProcessor()`, так как в стандартной модели PixArt нет каких-либо нестандартных процессоров внимания.
#### unfuse_qkv_projections[[diffusers.PixArtTransformer2DModel.unfuse_qkv_projections]]
```python
unfuse_qkv_projections()
```
[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L218)
Отключает объединенную проекцию QKV, если она включена.
> [!WARNING] > Этот API 🧪 экспериментальный.

Xet Storage Details

Size:: 11.9 kB
Xet hash:: 3459bd0dc7e0768b8072341b492689c1bc9ecd660daa0a23ebf5da7f313d1a89

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

	# PixArtTransformer2DModel

	Модель Transformer для изображений от [PixArt-Alpha](https://huggingface.co/papers/2310.00426) и [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')
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L32)

	Параметры:

	num_attention_heads (int, optional, по умолчанию 16) : Количество головок для использования в механизме внимания с несколькими головками.

	attention_head_dim (int, optional, по умолчанию 72) : Количество каналов в каждой голове.

	in_channels (int, по умолчанию 4) : количество каналов на входе.

	out_channels (int, optional) : Количество каналов на выходе. Укажите этот параметр, если количество выходных каналов отличается от входного.

	num_layers (int, optional, по умолчанию 28) : Количество блоков Transformer, используемых в модели.

	dropout (float, optional, по умолчанию 0.0) : Вероятность dropout, используемая внутри блоков Transformer.

	norm_num_groups (int, optional, по умолчанию 32) : Количество групп для групповой нормализации внутри блоков Transformer.

	cross_attention_dim (int, optional) : Размерность для слоёв кросс-внимания, как правило, совпадающая с размерностью скрытого слоя энкодера.

	attention_bias (bool, optional, по умолчанию True) : Настройка того, должен ли механизм внимания в блоках Transformer содержать параметр смещения (bias).

	sample_size (int, по умолчанию 128) : Ширина латентных изображений. Этот параметр фиксируется во время обучения.

	patch_size (int, по умолчанию 2) : Размер патчей, которые обрабатывает модель; актуально для архитектур, работающих с непоследовательными данными.

	activation_fn (str, optional, по умолчанию "gelu-approximate") : Функция активации, используемая в полносвязных сетях внутри блоков Transformer.

	num_embeds_ada_norm (int, optional, по умолчанию 1000) : Количество эмбеддингов для AdaLayerNorm, фиксированное во время обучения и влияющее на максимальное количество шагов денойзинга при инференсе.

	upcast_attention (bool, optional, по умолчанию False) : Если установлено в true, повышает размерность механизма внимания для потенциального улучшения производительности.

	norm_type (str, optional, по умолчанию "ada_norm_zero") : определяет тип используемой нормализации, может быть 'ada_norm_zero'.

	norm_elementwise_affine (bool, optional, по умолчанию False) : Если true, включает поэлементные аффинные параметры в слоях нормализации.

	norm_eps (float, optional, по умолчанию 1e-6) : Небольшая константа, добавляемая к знаменателю в слоях нормализации для предотвращения деления на ноль.

	interpolation_scale (int, optional) : Коэффициент масштабирования, используемый при интерполяции позиционных эмбеддингов.

	use_additional_conditions (bool, optional) : Используется ли дополнительные условия в качестве входных данных.

	attention_type (str, optional, по умолчанию "default") : Тип механизма внимания, который будет использоваться.

	caption_channels (int, optional, по умолчанию None) : Количество каналов, используемых для проекции эмбеддингов подписей.

	use_linear_projection (bool, optional, по умолчанию False) : Устаревший аргумент. Будет удалён в будущей версии.

	num_vector_embeds (bool, optional, по умолчанию False) : Устаревший аргумент. Будет удалён в будущей версии.

	Двумерная модель Transformer, представленная в семействе моделей 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)
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L227)

	Параметры:

	hidden_states (`torch.FloatTensor` формы `(batch size, channel, height, width)`) : Входные `hidden_states`.

	encoder_hidden_states (`torch.FloatTensor` формы `(batch size, sequence len, embed dims)`, необязательный) : Условные эмбеддинги для слоя кросс-внимания. Если не заданы, кросс-внимание по умолчанию работает как само-внимание.

	timestep (`torch.LongTensor`, необязательный) : Используется для указания шага денойзинга. Необязательный временной шаг, применяемый как эмбеддинг в `AdaLayerNorm`.

	added_cond_kwargs : (`dict[str, Any]`, необязательный): Дополнительные условия, используемые в качестве входных данных.

	cross_attention_kwargs ( `dict[str, Any]`, необязательный) : Словарь kwargs, который при указании передаётся в `AttentionProcessor`, определённый в `self.processor` в [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

	attention_mask ( `torch.Tensor`, необязательный) : маска внимания формы `(batch, key_tokens)` применяется к `encoder_hidden_states`. Если значение равно `1`, маска сохраняется, иначе, если равно `0`, она отбрасывается. Маска преобразуется в смещение (bias), которое добавляет большие отрицательные значения к оценкам внимания, соответствующим токенам, подлежащим отбрасыванию.

	encoder_attention_mask ( `torch.Tensor`, необязательный) : Маска кросс-внимания, применяемая к `encoder_hidden_states`. Поддерживаются два формата: * Маска `(batch, sequence_length)` True = сохранить, False = отбросить. * Смещение `(batch, 1, sequence_length)` 0 = сохранить, -10000 = отбросить. Если `ndim == 2`: значение будет интерпретировано как маска, а затем преобразовано в смещение, соответствующее описанному выше формату. Это смещение будет добавлено к оценкам кросс-внимания.

	return_dict (`bool`, необязательный, по умолчанию `True`) : Возвращать ли [UNet2DConditionOutput](/docs/diffusers/main/ru/api/models/unet2d-cond#diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput) вместо обычного кортежа.

	Возвращает:

	Если `return_dict` равно True, возвращается `~models.transformer_2d.Transformer2DModelOutput`, иначе — `tuple`, первым элементом которого является тензор выборки.

	Метод forward модели [PixArtTransformer2DModel](/docs/diffusers/main/ru/api/models/pixart_transformer2d#diffusers.PixArtTransformer2DModel).

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

	```python
	fuse_qkv_projections()
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L196)

	Включает объединённые проекции QKV. Для модулей само-внимания все матрицы проекций (т. е. запрос, ключ, значение) объединяются. Для модулей кросс-внимания объединяются матрицы проекций ключа и значения.

	> [!WARNING] > Этот API 🧪 экспериментальный.

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

	```python
	set_default_attn_processor()
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L187)

	Отключает пользовательские обработчики внимания и устанавливает реализацию внимания по умолчанию.

	Можно просто использовать `AttnProcessor()`, так как в стандартной модели PixArt нет каких-либо нестандартных процессоров внимания.

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

	```python
	unfuse_qkv_projections()
	```

	[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/pixart_transformer_2d.py#L218)

	Отключает объединенную проекцию QKV, если она включена.

	> [!WARNING] > Этот API 🧪 экспериментальный.