Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /ja /api /models /cogview4_transformer2d.md

mishig

2 days ago

preview code

download

raw

6.19 kB

# CogView4Transformer2DModel

[CogView4]()の2次元データ向けのDiffusion Transformerモデル

モデルは、以下のコードスニペットで読み込むことができます。

```python
from diffusers import CogView4Transformer2DModel
transformer = CogView4Transformer2DModel.from_pretrained("THUDM/CogView4-6B", subfolder="transformer", dtype=torch.bfloat16).to("cuda")  # or "mps", "xpu", "cpu"
```

## CogView4Transformer2DModel[[diffusers.CogView4Transformer2DModel]]

#### diffusers.CogView4Transformer2DModel[[diffusers.CogView4Transformer2DModel]]

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

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_cogview4.py#L617)

**パラメータ:**

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`と`W`をそれぞれ潜在変数の高さおよび幅とすると、この解像度から`H x W`の形状のスライスを取り出し、入力されたパッチ化された潜在変数に足し加えます。値が128の場合、画像生成でサポートされる最大の高さと幅は`128 * vae_scale_factor * patch_size => 128 * 8 * 2 => 2048`となります。

sample_size (`int`、デフォルトは`128`) : 入力ラテンツのベース解像度です。生成時に高さ/幅が指定されない場合、この値を使用して`sample_size * vae_scale_factor => 128 * 8 => 1024`として解像度を決定します。

#### forward[[diffusers.CogView4Transformer2DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: LongTensor, original_size: Tensor, target_size: Tensor, crop_coords: Tensor, attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True, attention_mask: typing.Optional[torch.Tensor] = None, image_rotary_emb: tuple[torch.Tensor, torch.Tensor] | list[tuple[torch.Tensor, torch.Tensor]] | None = None)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_cogview4.py#L704)

**パラメータ:**

hidden_states (`torch.Tensor`、形状 `(batch_size, in_channels, height, width)`) : 入力 `hidden_states`。

encoder_hidden_states (`torch.Tensor`、shape `(batch_size, sequence_len, embed_dims)`) : 使用する条件埋め込み（プロンプトなどの入力条件から計算される埋め込み）。

timestep (`torch.LongTensor`) : デノイジングステップを示すために使用されます。

original_size (`torch.Tensor`) : 元の画像サイズによる条件付け。
target_size (`torch.Tensor`) : ターゲット画像サイズ条件付け。

crop_coords (`torch.Tensor`) : クロップ座標の条件付け。
attention_kwargs (`dict`, *任意*) : 指定された場合、[diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py) の `self.processor` で定義されている `AttentionProcessor` に渡される kwargs の辞書です。

return_dict (`bool`、*任意*、デフォルトは`True`) : プレーンなタプルではなく`~models.transformer_2d.Transformer2DModelOutput`を返すかどうか。

attention_mask (`torch.Tensor`, *任意*) : 注意スコアに適用されるマスク。
image_rotary_emb (`tuple` of `torch.Tensor`, *任意*) : 事前計算された回転位置埋め込み。
**戻り値:**
`return_dict` が True の場合、`~models.transformer_2d.Transformer2DModelOutput` が返され、それ以外の場合は、最初の要素がサンプルテンソルである `tuple` が返されます。
[CogView4Transformer2DModel](/docs/diffusers/main/ja/api/models/cogview4_transformer2d#diffusers.CogView4Transformer2DModel) の forward メソッドです。
## 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`、shape は `(batch_size, num_channels, height, width)`、または [Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel) が離散型の場合 `(batch size, num_vector_embeds - 1, num_latent_pixels)`) : `encoder_hidden_states` 入力を条件とする隠れ状態の出力です。離散型の場合、ノイズ除去されていない潜在ピクセルの確率分布を返します。

[Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel)の出力です。

Xet Storage Details

Size:: 6.19 kB
Xet hash:: 79b399b9b11b4bec0cb7b06eb1edba4a9e979ec1b1f50d7848d4b5dc6d58a16b

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

	# CogView4Transformer2DModel

	[CogView4]()の2次元データ向けのDiffusion Transformerモデル

	モデルは、以下のコードスニペットで読み込むことができます。

	```python
	from diffusers import CogView4Transformer2DModel

	transformer = CogView4Transformer2DModel.from_pretrained("THUDM/CogView4-6B", subfolder="transformer", dtype=torch.bfloat16).to("cuda") # or "mps", "xpu", "cpu"
	```

	## CogView4Transformer2DModel[[diffusers.CogView4Transformer2DModel]]

	#### diffusers.CogView4Transformer2DModel[[diffusers.CogView4Transformer2DModel]]

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

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_cogview4.py#L617)

	パラメータ:

	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`と`W`をそれぞれ潜在変数の高さおよび幅とすると、この解像度から`H x W`の形状のスライスを取り出し、入力されたパッチ化された潜在変数に足し加えます。値が128の場合、画像生成でサポートされる最大の高さと幅は`128 * vae_scale_factor * patch_size => 128 * 8 * 2 => 2048`となります。

	sample_size (`int`、デフォルトは`128`) : 入力ラテンツのベース解像度です。生成時に高さ/幅が指定されない場合、この値を使用して`sample_size * vae_scale_factor => 128 * 8 => 1024`として解像度を決定します。

	#### forward[[diffusers.CogView4Transformer2DModel.forward]]

	```python
	forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: LongTensor, original_size: Tensor, target_size: Tensor, crop_coords: Tensor, attention_kwargs: dict[str, typing.Any] \| None = None, return_dict: bool = True, attention_mask: typing.Optional[torch.Tensor] = None, image_rotary_emb: tuple[torch.Tensor, torch.Tensor] \| list[tuple[torch.Tensor, torch.Tensor]] \| None = None)
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_cogview4.py#L704)

	パラメータ:

	hidden_states (`torch.Tensor`、形状 `(batch_size, in_channels, height, width)`) : 入力 `hidden_states`。

	encoder_hidden_states (`torch.Tensor`、shape `(batch_size, sequence_len, embed_dims)`) : 使用する条件埋め込み（プロンプトなどの入力条件から計算される埋め込み）。

	timestep (`torch.LongTensor`) : デノイジングステップを示すために使用されます。

	original_size (`torch.Tensor`) : 元の画像サイズによる条件付け。

	target_size (`torch.Tensor`) : ターゲット画像サイズ条件付け。

	crop_coords (`torch.Tensor`) : クロップ座標の条件付け。

	attention_kwargs (`dict`, 任意) : 指定された場合、[diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py) の `self.processor` で定義されている `AttentionProcessor` に渡される kwargs の辞書です。

	return_dict (`bool`、任意、デフォルトは`True`) : プレーンなタプルではなく`~models.transformer_2d.Transformer2DModelOutput`を返すかどうか。

	attention_mask (`torch.Tensor`, 任意) : 注意スコアに適用されるマスク。

	image_rotary_emb (`tuple` of `torch.Tensor`, 任意) : 事前計算された回転位置埋め込み。

	戻り値:

	`return_dict` が True の場合、`~models.transformer_2d.Transformer2DModelOutput` が返され、それ以外の場合は、最初の要素がサンプルテンソルである `tuple` が返されます。

	[CogView4Transformer2DModel](/docs/diffusers/main/ja/api/models/cogview4_transformer2d#diffusers.CogView4Transformer2DModel) の forward メソッドです。

	## 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`、shape は `(batch_size, num_channels, height, width)`、または [Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel) が離散型の場合 `(batch size, num_vector_embeds - 1, num_latent_pixels)`) : `encoder_hidden_states` 入力を条件とする隠れ状態の出力です。離散型の場合、ノイズ除去されていない潜在ピクセルの確率分布を返します。

	[Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel)の出力です。