# CogView3PlusTransformer2DModel

清華大学およびZhipuAIによる[CogView3: Finer and Faster Text-to-Image Generation via Relay Diffusion](https://huggingface.co/papers/2403.05121)において、[CogView3Plus](https://github.com/THUDM/CogView3)の2Dデータ向けのDiffusion Transformerモデルが紹介されました。

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

```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`と`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`として解像度を決定します。

[リレー拡散によるより精密で高速なテキストから画像への生成](https://huggingface.co/papers/2403.05121)で紹介されたTransformerモデル。

#### 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`) : 形状が `(batch size, channel, height, width)` の入力 `hidden_states`。

encoder_hidden_states (`torch.Tensor`) : プロンプトなどの入力条件から計算される条件埋め込みで、形状は `(batch_size, sequence_len, text_embed_dim)`

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

original_size (`torch.Tensor`) : CogView3 は、[https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952) のセクション 2.2 で説明されているように、元の画像サイズに対して SDXL 風のマイクロ条件付けを使用します。

target_size (`torch.Tensor`) : CogView3 は、[https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952) の 2.2 節で説明されているように、ターゲット画像サイズに対して SDXL 風のマイクロ条件付けを使用します。

crop_coords (`torch.Tensor`) : CogView3 は、[https://huggingface.co/papers/2307.01952](https://huggingface.co/papers/2307.01952) のセクション 2.2 で説明されているように、クロップ座標に対して SDXL 風のマイクロ条件付けを使用します。

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

**戻り値:** `torch.Tensor` または `~models.transformer_2d.Transformer2DModelOutput`

提供された入力を用いて条件付けを行い、ノイズ除去された潜在変数。

[CogView3PlusTransformer2DModel](/docs/diffusers/main/ja/api/models/cogview3plus_transformer2d#diffusers.CogView3PlusTransformer2DModel)の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)の出力です。