# ConsisIDTransformer3DModel

A Diffusion Transformer model for 3D data from [ConsisID](https://github.com/PKU-YuanGroup/ConsisID) was introduced in [Identity-Preserving Text-to-Video Generation by Frequency Decomposition](https://huggingface.co/papers/2411.17440) by Peking University & University of Rochester & etc.

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

```python
from diffusers import ConsisIDTransformer3DModel

transformer = ConsisIDTransformer3DModel.from_pretrained("BestWishYsh/ConsisID-preview", subfolder="transformer", dtype=torch.bfloat16).to("cuda")  # or "mps", "xpu", "cpu"
```

## ConsisIDTransformer3DModel[[diffusers.ConsisIDTransformer3DModel]]

#### diffusers.ConsisIDTransformer3DModel[[diffusers.ConsisIDTransformer3DModel]]

```python
diffusers.ConsisIDTransformer3DModel(num_attention_heads: int = 30, attention_head_dim: int = 64, in_channels: int = 16, out_channels: int | None = 16, flip_sin_to_cos: bool = True, freq_shift: int = 0, time_embed_dim: int = 512, text_embed_dim: int = 4096, num_layers: int = 30, dropout: float = 0.0, attention_bias: bool = True, sample_width: int = 90, sample_height: int = 60, sample_frames: int = 49, patch_size: int = 2, temporal_compression_ratio: int = 4, max_text_seq_length: int = 226, activation_fn: str = 'gelu-approximate', timestep_activation_fn: str = 'silu', norm_elementwise_affine: bool = True, norm_eps: float = 1e-05, spatial_interpolation_scale: float = 1.875, temporal_interpolation_scale: float = 1.0, use_rotary_positional_embeddings: bool = False, use_learned_positional_embeddings: bool = False, is_train_face: bool = False, is_kps: bool = False, cross_attn_interval: int = 2, cross_attn_dim_head: int = 128, cross_attn_num_heads: int = 16, LFE_id_dim: int = 1280, LFE_vit_dim: int = 1024, LFE_depth: int = 10, LFE_dim_head: int = 64, LFE_num_heads: int = 16, LFE_num_id_token: int = 5, LFE_num_querie: int = 32, LFE_output_dim: int = 2048, LFE_ff_mult: int = 4, LFE_num_scale: int = 5, local_face_scale: float = 1.0)
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/consisid_transformer_3d.py#L351)

**パラメータ:**

num_attention_heads (`int`、デフォルトは`30`) : マルチヘッドアテンションで使用するヘッド数。

attention_head_dim (`int`、デフォルトは`64`) : 各ヘッドのチャネル数。

in_channels (`int`、デフォルトは`16`) : 入力におけるチャネル数。

out_channels (`int`、*任意*、デフォルトは`16`) : 出力のチャネル数。

flip_sin_to_cos (`bool`、デフォルトは`True`) : 時間埋め込みにおいて sin を cos に反転させるかどうか。

time_embed_dim (`int`、デフォルトは`512`) : タイムステップ埋め込みの出力次元数。

text_embed_dim (`int`、デフォルトは`4096`) : テキストエンコーダーからのテキスト埋め込みの入力次元数。

num_layers (`int`、デフォルトは`30`) : 使用する Transformer ブロックの層数。

dropout (`float`、デフォルトは`0.0`) : 使用する dropout の確率。

attention_bias (`bool`、デフォルトは`True`) : 注意機構の投影層でバイアスを使用するかどうか。

sample_width (`int`、デフォルトは`90`) : 入力潜変数の幅。

sample_height (`int`、デフォルトは`60`) : 入力ラテンツの縦幅。

sample_frames (`int`、デフォルトは`49`) : 入力潜在変数のフレーム数です。なお、このパラメータは、ConsisID がデフォルトおよび推奨設定において一度に13の潜在フレームを処理していたため、本来は13であるべきところを誤って49に初期化されています。後方互換性を確保するため、正しい値に変更することはできません。K個の潜在フレームを持つtransformerを作成する場合、ここで渡すべき正しい値は ((K - 1) * temporal_compression_ratio + 1) です。

patch_size (`int`、デフォルトは`2`) : パッチ埋め込み層で使用するパッチのサイズ。

temporal_compression_ratio (`int`、デフォルトは`4`) : 時間軸方向の圧縮率。`sample_frames`のドキュメントを参照してください。

max_text_seq_length (`int`、デフォルトは`226`) : 入力テキスト埋め込みの最大シーケンス長。

activation_fn (`str`、デフォルトは `"gelu-approximate"`) : feed-forward で使用する活性化関数。

timestep_activation_fn (`str`、デフォルトは`"silu"`) : タイムステップ埋め込みを生成する際に使用する活性化関数。

norm_elementwise_affine (`bool`、デフォルトは`True`) : 正規化レイヤーで要素ごとのアフィン変換を使用するかどうか。

norm_eps (`float`、デフォルトは`1e-5`) : 正規化層で使用するepsilon値。

spatial_interpolation_scale (`float`、デフォルトは`1.875`) : 空間次元全体にわたる3次元位置埋め込みに適用するスケーリング係数。

temporal_interpolation_scale (`float`、デフォルトは`1.0`) : 時間軸次元全体にわたる3次元位置埋め込みに適用するスケーリング係数。

is_train_face (`bool`、デフォルトは`False`) : 学習プロセス中にアイデンティティ保持モジュールを有効にするかどうか。`True`に設定すると、モデルはアイデンティティ保持タスクに焦点を当てます。

is_kps (`bool`、デフォルトは`False`) : グローバルな顔抽出器でキーポイントの機能を有効にするかどうか。`True`の場合、モデルにキーポイントが含まれます。

cross_attn_interval (`int`、デフォルトは`2`) : Transformerアーキテクチャにおけるクロスアテンション層の間隔です。値を大きくすると、クロスアテンションの計算頻度が低下し、計算オーバーヘッドの削減に役立つ場合があります。

cross_attn_dim_head (`int`、省略可能、デフォルトは`128`) : Transformerアーキテクチャのクロスアテンション層における各アテンションヘッドの次元数です。値を大きくすると、より複雑なパターンに注目する能力が高まりますが、メモリと計算コストも増加します。

cross_attn_num_heads (`int`、省略可能、デフォルトは`16`) : クロスアテンション層におけるアテンションヘッドの数です。ヘッド数が多いほど、より多くの並列アテンション機構を構成でき、入力内の異なるコンポーネント間の多様な関係を捉えることができますが、計算コストも増加します。

LFE_id_dim (`int`、省略可能、デフォルトは`1280`) : Local Facial Extractor (LFE) で使用されるアイデンティティベクトルの次元数です。このベクトルは顔のアイデンティティ特徴を表しており、顔認識や異なるフレーム間でのアイデンティティの保持といったタスクにおいて重要です。

LFE_vit_dim (`int`、省略可能、デフォルトは`1024`) : Local Facial Extractor (LFE) で使用される Vision Transformer (ViT) の出力次元です。この値は、顔の特徴量抽出のために処理される、Transformer が生成する特徴ベクトルのサイズを決定します。

LFE_depth (`int`、省略可能、デフォルトは`10`) : Local Facial Extractor (LFE) の層数です。深さを増やすことで、顔の特徴をより複雑な表現として捉えることが可能になりますが、計算負荷も増加します。

LFE_dim_head (`int`、省略可能、デフォルトは`64`) : Local Facial Extractor (LFE)における各アテンションヘッドの次元数です。このパラメータは、抽出処理中にモデルが顔の特徴の異なる部分にどの程度細かく処理・フォーカスできるかに影響します。

LFE_num_heads (`int`、省略可能、デフォルトは`16`) : Local Facial Extractor (LFE)におけるアテンションヘッドの数です。ヘッド数を増やすことで、多様な顔の特徴を捉える能力が向上する可能性がありますが、計算複雑性の増加というコストが発生します。

LFE_num_id_token (`int`、省略可能、デフォルトは`5`) : Local Facial Extractor (LFE) で使用されるアイデンティティトークンの数です。これは、特徴量抽出時に顔のアイデンティティを保持するために、モデルが処理するアイデンティティ関連トークンの数を定義します。

LFE_num_querie (`int`、省略可能、デフォルトは`32`) : Local Facial Extractor (LFE) で使用されるクエリトークンの数です。これらのトークンは、顔に関連する高周波情報を捕捉するために使用され、正確な顔の特徴抽出を支援します。

LFE_output_dim (`int`、省略可能、デフォルトは`2048`) : Local Facial Extractor (LFE) の出力次元です。この次元は、LFE モジュールが生成する特徴量ベクトルのサイズを決定し、顔認識やトラッキングなどの後続のタスクで使用されます。

LFE_ff_mult (`int`、省略可能、デフォルトは`4`) : Local Facial Extractor (LFE) のフィードフォワードネットワークの隠れ層サイズに適用される乗数です。値を大きくすると、より複雑な顔の特徴変換を学習するモデルの容量が増加しますが、計算量とメモリ要件も増加します。

LFE_num_scale (`int`、省略可能、デフォルトは`5`) : 視覚特徴の異なるスケールの数。値を大きくすると、モデルがより複雑な顔の特徴変換を学習する能力が高まりますが、計算量とメモリ要件も増加します。

local_face_scale (`float`、デフォルトは`1.0`) : モデル内で局所的な顔の特徴の重要度を調整するために使用されるスケーリング係数です。これにより、モデルが顔に関連する高周波数コンテンツにどの程度強く注目するかが影響を受けます。

[ConsisID](https://github.com/PKU-YuanGroup/ConsisID)における動画類似データ向けのTransformerモデル。

#### forward[[diffusers.ConsisIDTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: typing.Union[int, float, torch.LongTensor], timestep_cond: typing.Optional[torch.Tensor] = None, image_rotary_emb: tuple[torch.Tensor, torch.Tensor] | None = None, attention_kwargs: dict[str, typing.Any] | None = None, id_cond: typing.Optional[torch.Tensor] = None, id_vit_hidden: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/consisid_transformer_3d.py#L623)

**パラメータ:**

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

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

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

timestep_cond (`torch.Tensor`, *任意*) : タイムステップ用の条件付き埋め込みです。指定された場合、これらの埋め込みは `self.time_embedding` レイヤーを通過したサンプルに加算され、最終的なタイムステップ埋め込みが得られます。

image_rotary_emb (`tuple` of `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 の辞書です。

id_cond (`torch.Tensor`, *任意*) : アイデンティティ条件付けに使用される、ローカルな顔抽出器によって抽出された顔埋め込みです。

id_vit_hidden (`torch.Tensor`, *任意*) : アイデンティティ条件付けに使用される、顔画像から抽出されたViTの隠れ状態です。

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

**戻り値:**

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

[ConsisIDTransformer3DModel](/docs/diffusers/v0.43.0/ja/api/models/consisid_transformer3d#diffusers.ConsisIDTransformer3DModel)の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/v0.43.0/src/diffusers/models/modeling_outputs.py#L21)

**パラメータ:**

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

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