Diffusers documentation

FluxTransformer2DModel

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

FluxTransformer2DModel

Fluxからの画像類似データ向けのTransformerモデル。

FluxTransformer2DModel

クラス diffusers.FluxTransformer2DModel

< >

( patch_size: int = 1in_channels: int = 64out_channels: int | None = Nonenum_layers: int = 19num_single_layers: int = 38attention_head_dim: int = 128num_attention_heads: int = 24joint_attention_dim: int = 4096pooled_projection_dim: int = 768guidance_embeds: bool = Falseaxes_dims_rope: tuple[int, int, int] = (16, 56, 56) )

パラメータ

  • patch_size (int、デフォルトは1) — 入力データを小さなパッチに変換するためのパッチサイズ。
  • in_channels (int、デフォルトは64) — 入力におけるチャネル数。
  • out_channels (int, 省略可、デフォルトは None) — 出力のチャネル数です。指定しない場合、デフォルトで in_channels になります。
  • num_layers (int、デフォルトは19) — 使用するデュアルストリームDiTブロックの層数です。
  • num_single_layers (int、デフォルトは38) — 使用する単一ストリームDiTブロックの層数です。
  • attention_head_dim (int, デフォルトは 128) — 各アテンションヘッドに使用する次元数です。
  • num_attention_heads (int、デフォルトは 24) — 使用するアテンションヘッドの数です。
  • joint_attention_dim (int、デフォルトは4096) — encoder_hidden_statesの埋め込み/チャネル次元として使用する、ジョイントアテンションの次元数です。
  • pooled_projection_dim (int, デフォルトは 768) — プーリング投影に使用する次元数。
  • guidance_embeds (bool、デフォルトは False) — モデルのガイダンス蒸留版に対してガイダンス埋め込みを使用するかどうかを指定します。
  • axes_dims_rope (tuple[int]、デフォルトは (16, 56, 56)) — 回転位置埋め込みに使用する次元です。

Flux で導入された Transformer モデル。

参照: https://blackforestlabs.ai/announcing-black-forest-labs/

forward

< >

( hidden_states: Tensorencoder_hidden_states: Tensor = Nonepooled_projections: Tensor = Nonetimestep: LongTensor = Noneimg_ids: Tensor = Nonetxt_ids: Tensor = Noneguidance: Tensor = Nonejoint_attention_kwargs: dict[str, typing.Any] | None = Nonecontrolnet_block_samples = Nonecontrolnet_single_block_samples = Nonereturn_dict: bool = Truecontrolnet_blocks_repeat: bool = False )

パラメータ

  • hidden_states (torch.Tensor、形状 (batch_size, image_sequence_length, in_channels)) — 入力となる hidden_states。
  • encoder_hidden_states (torch.Tensor、形状 (batch_size, text_sequence_length, joint_attention_dim)) — 使用する条件埋め込み(プロンプトなどの入力条件から計算される埋め込み)。
  • pooled_projections(torch.Tensor、形状 (batch_size, projection_dim))— 入力条件の埋め込みから投影された埋め込み。
  • timestep ( torch.LongTensor) — デノイジングステップを示すために使用されます。
  • img_ids (torch.Tensor) — 回転位置埋め込みを計算するために使用される画像の位置 ID。
  • txt_ids (torch.Tensor) — 回転位置埋め込みを計算するために使用されるテキストの位置 ID。
  • guidance (torch.Tensor、任意) — モデルのガイダンス蒸留版で使用するガイダンススケール埋め込み。
  • controlnet_block_samples (list of torch.Tensor, 任意) — 指定された場合、transformer ブロックの残差に追加されるテンソルのリストです。
  • controlnet_single_block_samples (list of torch.Tensor, 任意) — 指定された場合、単一の Transformer ブロックの残差に追加されるテンソルのリストです。
  • controlnet_blocks_repeat (bool、任意、デフォルトは False) — controlnet ブロックのサンプルをすべての transformer ブロックにわたって繰り返すかどうかを指定します。
  • joint_attention_kwargs (dict、省略可) — 指定された場合、diffusers.models.attention_processor で定義されている self.processor 配下の AttentionProcessor に渡される kwargs の辞書です。
  • return_dict (bool、任意、デフォルトは True) — プレーンなタプルではなく ~models.transformer_2d.Transformer2DModelOutput を返すかどうか。

FluxTransformer2DModelのforwardメソッド。

Update on GitHub