Buckets:

hf-doc-build
/

doc

Files

xet

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

mishig

7 days ago

preview code

download

raw

7.68 kB

# CogView3PlusTransformer2DModel

Модель Diffusion Transformer для 2D-данных из [CogView3Plus](https://github.com/THUDM/CogView3) была представлена в работе [CogView3: Finer and Faster Text-to-Image Generation via Relay Diffusion](https://huggingface.co/papers/2403.05121) от Tsinghua University & ZhipuAI.

Модель можно загрузить с помощью следующего фрагмента кода.

```python
from diffusers import CogView3PlusTransformer2DModel
transformer = CogView3PlusTransformer2DModel.from_pretrained("THUDM/CogView3Plus-3b", subfolder="transformer", dtype=torch.bfloat16).to("cuda")  # or "mps", "xpu", "cpu"
```

## CogView3PlusTransformer2DModel[[diffusers.CogView3PlusTransformer2DModel]]

#### diffusers.CogView3PlusTransformer2DModel[[diffusers.CogView3PlusTransformer2DModel]]

```python
diffusers.CogView3PlusTransformer2DModel(patch_size: int = 2, in_channels: int = 16, num_layers: int = 30, attention_head_dim: int = 40, num_attention_heads: int = 64, out_channels: int = 16, text_embed_dim: int = 4096, time_embed_dim: int = 512, condition_dim: int = 256, pos_embed_max_size: int = 128, sample_size: int = 128)
```

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

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

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

num_layers (`int`, по умолчанию `30`) : Количество блоков Transformer, которые следует использовать.
attention_head_dim (`int`, по умолчанию `40`) : Количество каналов в каждой голове.
num_attention_heads (`int`, по умолчанию `64`) : Количество головок для использования в механизме внимания с несколькими головками.
out_channels (`int`, по умолчанию `16`) : Количество каналов на выходе.

text_embed_dim (`int`, по умолчанию `4096`) : Размерность входных текстовых эмбеддингов, полученных от текстового энкодера.

time_embed_dim (`int`, по умолчанию `512`) : Размерность выходного вектора эмбеддингов временных шагов.

condition_dim (`int`, по умолчанию `256`) : размерность эмбеддинга для входных условий разрешения в стиле SDXL (original_size, target_size, crop_coords).

pos_embed_max_size (`int`, по умолчанию `128`) : Максимальное разрешение позиционных эмбеддингов, из которого берутся срезы формы `H x W` и добавляются к входным патчеванным латентам, где `H` и `W` — высота и ширина латентов соответственно. Значение 128 означает, что максимальная поддерживаемая высота и ширина для генерации изображений равны `128 * vae_scale_factor * patch_size => 128 * 8 * 2 => 2048`.

sample_size (`int`, по умолчанию `128`) : Базовое разрешение входных латентов. Если высота/ширина не указаны при генерации, это значение используется для определения разрешения как `sample_size * vae_scale_factor => 128 * 8 => 1024`

The Transformer model introduced in [CogView3: Finer and Faster Text-to-Image Generation via Relay Diffusion](https://huggingface.co/papers/2403.05121).

#### forward[[diffusers.CogView3PlusTransformer2DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: LongTensor, original_size: Tensor, target_size: Tensor, crop_coords: Tensor, return_dict: bool = True)
```

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

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

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

encoder_hidden_states (`torch.Tensor`) : Условные эмбеддинги (эмбеддинги, вычисленные на основе входных условий, таких как промпты) формы `(batch_size, sequence_len, text_embed_dim)`

timestep (`torch.LongTensor`) : Используется для указания шага денойзинга.

original_size (`torch.Tensor`) : CogView3 использует микроусловия, аналогичные SDXL, для исходного размера изображения, как описано в разделе 2.2 статьи [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).
target_size (`torch.Tensor`) : CogView3 использует микроусловия, аналогичные SDXL, для размера целевого изображения, как описано в разделе 2.2 статьи [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).

crop_coords (`torch.Tensor`) : CogView3 использует микроусловия, аналогичные SDXL, для координат кадрирования, как описано в разделе 2.2 статьи [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).
return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли `~models.transformer_2d.Transformer2DModelOutput` вместо обычного кортежа.

**Возвращает:** `torch.Tensor` или `~models.transformer_2d.Transformer2DModelOutput`

Шумоподавленные латенты, использующие предоставленные входные данные в качестве условия.

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

## Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]
#### diffusers.models.modeling_outputs.Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]
```python
diffusers.models.modeling_outputs.Transformer2DModelOutput(sample: torch.Tensor)
```
[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L21)
**Параметры:**
sample (`torch.Tensor` формы `(batch_size, num_channels, height, width)` или `(batch size, num_vector_embeds - 1, num_latent_pixels)`, если [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel) дискретный): выходные скрытые состояния, обусловленные входом `encoder_hidden_states`. Если модель дискретная, возвращает распределения вероятностей для ненашумленных латентных пикселей.
Вывод [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel).

Xet Storage Details

Size:: 7.68 kB
Xet hash:: 65b024ccb2b523672c4d3755de93585d0e9b9640254b55e3b2426493e238ce83

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

	# CogView3PlusTransformer2DModel

	Модель Diffusion Transformer для 2D-данных из [CogView3Plus](https://github.com/THUDM/CogView3) была представлена в работе [CogView3: Finer and Faster Text-to-Image Generation via Relay Diffusion](https://huggingface.co/papers/2403.05121) от Tsinghua University & ZhipuAI.

	Модель можно загрузить с помощью следующего фрагмента кода.

	```python
	from diffusers import CogView3PlusTransformer2DModel

	transformer = CogView3PlusTransformer2DModel.from_pretrained("THUDM/CogView3Plus-3b", subfolder="transformer", dtype=torch.bfloat16).to("cuda") # or "mps", "xpu", "cpu"
	```

	## CogView3PlusTransformer2DModel[[diffusers.CogView3PlusTransformer2DModel]]

	#### diffusers.CogView3PlusTransformer2DModel[[diffusers.CogView3PlusTransformer2DModel]]

	```python
	diffusers.CogView3PlusTransformer2DModel(patch_size: int = 2, in_channels: int = 16, num_layers: int = 30, attention_head_dim: int = 40, num_attention_heads: int = 64, out_channels: int = 16, text_embed_dim: int = 4096, time_embed_dim: int = 512, condition_dim: int = 256, pos_embed_max_size: int = 128, sample_size: int = 128)
	```

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

	Параметры:

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

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

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

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

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

	out_channels (`int`, по умолчанию `16`) : Количество каналов на выходе.

	text_embed_dim (`int`, по умолчанию `4096`) : Размерность входных текстовых эмбеддингов, полученных от текстового энкодера.

	time_embed_dim (`int`, по умолчанию `512`) : Размерность выходного вектора эмбеддингов временных шагов.

	condition_dim (`int`, по умолчанию `256`) : размерность эмбеддинга для входных условий разрешения в стиле SDXL (original_size, target_size, crop_coords).

	pos_embed_max_size (`int`, по умолчанию `128`) : Максимальное разрешение позиционных эмбеддингов, из которого берутся срезы формы `H x W` и добавляются к входным патчеванным латентам, где `H` и `W` — высота и ширина латентов соответственно. Значение 128 означает, что максимальная поддерживаемая высота и ширина для генерации изображений равны `128 * vae_scale_factor * patch_size => 128 * 8 * 2 => 2048`.

	sample_size (`int`, по умолчанию `128`) : Базовое разрешение входных латентов. Если высота/ширина не указаны при генерации, это значение используется для определения разрешения как `sample_size * vae_scale_factor => 128 * 8 => 1024`

	The Transformer model introduced in [CogView3: Finer and Faster Text-to-Image Generation via Relay Diffusion](https://huggingface.co/papers/2403.05121).

	#### forward[[diffusers.CogView3PlusTransformer2DModel.forward]]

	```python
	forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: LongTensor, original_size: Tensor, target_size: Tensor, crop_coords: Tensor, return_dict: bool = True)
	```

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

	Параметры:

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

	encoder_hidden_states (`torch.Tensor`) : Условные эмбеддинги (эмбеддинги, вычисленные на основе входных условий, таких как промпты) формы `(batch_size, sequence_len, text_embed_dim)`

	timestep (`torch.LongTensor`) : Используется для указания шага денойзинга.

	original_size (`torch.Tensor`) : CogView3 использует микроусловия, аналогичные SDXL, для исходного размера изображения, как описано в разделе 2.2 статьи [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).

	target_size (`torch.Tensor`) : CogView3 использует микроусловия, аналогичные SDXL, для размера целевого изображения, как описано в разделе 2.2 статьи [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).

	crop_coords (`torch.Tensor`) : CogView3 использует микроусловия, аналогичные SDXL, для координат кадрирования, как описано в разделе 2.2 статьи [https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952).

	return_dict (`bool`, необязательный, по умолчанию `True`) : Возвращать ли `~models.transformer_2d.Transformer2DModelOutput` вместо обычного кортежа.

	Возвращает: `torch.Tensor` или `~models.transformer_2d.Transformer2DModelOutput`

	Шумоподавленные латенты, использующие предоставленные входные данные в качестве условия.

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

	## Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]

	#### diffusers.models.modeling_outputs.Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]

	```python
	diffusers.models.modeling_outputs.Transformer2DModelOutput(sample: torch.Tensor)
	```

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

	Параметры:

	sample (`torch.Tensor` формы `(batch_size, num_channels, height, width)` или `(batch size, num_vector_embeds - 1, num_latent_pixels)`, если [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel) дискретный): выходные скрытые состояния, обусловленные входом `encoder_hidden_states`. Если модель дискретная, возвращает распределения вероятностей для ненашумленных латентных пикселей.

	Вывод [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel).