Buckets:

hf-doc-build
/

doc

Files

xet

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

mishig

3 days ago

preview code

download

raw

6.65 kB

# FluxControlNetModel

FluxControlNetModel は、Flux.1 向けの ControlNet の実装です。

ControlNetモデルは、Lvmin Zhang、Anyi Rao、Maneesh Agrawala による [Adding Conditional Control to Text-to-Image Diffusion Models](https://huggingface.co/papers/2302.05543) で紹介されました。エッジマップ、深度マップ、セグメンテーションマップ、ポーズ検出用のキーポイントなどの追加入力に対してモデルを条件付けすることで、テキストから画像を生成する際の制御性を高めます。

論文の抄録は以下の通りです：

*本稿では、大規模な事前学習済みテキストから画像への拡散モデルに空間的条件付け制御を追加するためのニューラルネットワークアーキテクチャであるControlNetを提案します。ControlNetは、実運用可能な大規模拡散モデルを固定し、数十億枚の画像で事前学習された深く頑健なエンコーディング層を強力なバックボーンとして再利用することで、多様な条件付け制御のセットを学習します。このニューラルアーキテクチャは、「ゼロ畳み込み」（ゼロ初期化された畳み込み層）によって接続されており、パラメータをゼロから段階的に増加させ、有害なノイズがファインチューニングに影響を与えないことを保証します。Stable Diffusionを用いて、エッジ、深度、セグメンテーション、人間のポーズなどの様々な条件付け制御を、プロンプトの有無にかかわらず、単一または複数の条件を用いてテストしました。ControlNetの学習は、小規模（<50k）および大規模（>1m）のデータセットのいずれにおいても頑健であることが示されています。広範な結果から、ControlNetは画像拡散モデルの制御に関するより幅広いアプリケーションを促進し得ることが示されました。*

## 元の形式から読み込む

デフォルトでは、[FluxControlNetModel](/docs/diffusers/main/ja/api/models/controlnet_flux#diffusers.FluxControlNetModel)は[from_pretrained()](/docs/diffusers/main/ja/api/models/overview#diffusers.ModelMixin.from_pretrained)で読み込む必要があります。

```py
from diffusers import FluxControlNetPipeline
from diffusers.models import FluxControlNetModel, FluxMultiControlNetModel
controlnet = FluxControlNetModel.from_pretrained("InstantX/FLUX.1-dev-Controlnet-Canny")
pipe = FluxControlNetPipeline.from_pretrained("black-forest-labs/FLUX.1-dev", controlnet=controlnet)
controlnet = FluxControlNetModel.from_pretrained("InstantX/FLUX.1-dev-Controlnet-Canny")
controlnet = FluxMultiControlNetModel([controlnet])
pipe = FluxControlNetPipeline.from_pretrained("black-forest-labs/FLUX.1-dev", controlnet=controlnet)
```

## FluxControlNetModel[[diffusers.FluxControlNetModel]]

#### diffusers.FluxControlNetModel[[diffusers.FluxControlNetModel]]

```python
diffusers.FluxControlNetModel(patch_size: int = 1, in_channels: int = 64, num_layers: int = 19, num_single_layers: int = 38, attention_head_dim: int = 128, num_attention_heads: int = 24, joint_attention_dim: int = 4096, pooled_projection_dim: int = 768, guidance_embeds: bool = False, axes_dims_rope: list[int] = [16, 56, 56], num_mode: int = None, conditioning_embedding_channels: int = None)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/controlnets/controlnet_flux.py#L45)

#### forward[[diffusers.FluxControlNetModel.forward]]

```python
forward(hidden_states: Tensor, controlnet_cond: Tensor, controlnet_mode: Tensor = None, conditioning_scale: float = 1.0, encoder_hidden_states: Tensor = None, pooled_projections: Tensor = None, timestep: LongTensor = None, img_ids: Tensor = None, txt_ids: Tensor = None, guidance: Tensor = None, joint_attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/controlnets/controlnet_flux.py#L157)

**パラメータ:**

hidden_states (`torch.FloatTensor`、shape `(batch size, channel, height, width)`) : 入力 `hidden_states`。

controlnet_cond (`torch.Tensor`) : 形状が `(batch_size, sequence_length, hidden_size)` の条件付き入力テンソル。

controlnet_mode (`torch.Tensor`) : 形状が `(batch_size, 1)` のモードテンソル。

conditioning_scale (`float`、デフォルトは`1.0`) : ControlNet の出力に対するスケール係数。
encoder_hidden_states (`torch.FloatTensor`、shape `(batch size, sequence_len, embed_dims)`) : 使用する条件埋め込み（プロンプトなどの入力条件から計算される埋め込み）。
pooled_projections (`torch.FloatTensor`、shape `(batch_size, projection_dim)`) : 入力条件の埋め込みから投影された埋め込み。

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

img_ids (`torch.Tensor`) : 画像トークンの位置ID。
txt_ids (`torch.Tensor`) : テキストトークンの位置ID。

guidance (`torch.Tensor`, *任意*) : モデルのガイダンス蒸留版で使用するガイダンススケールテンソル。

joint_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`を返すかどうか。

**戻り値:**

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

[FluxTransformer2DModel](/docs/diffusers/main/ja/api/models/flux_transformer#diffusers.FluxTransformer2DModel)のforwardメソッド。

## FluxControlNetOutput[[diffusers.models.controlnets.FluxControlNetOutput]]

#### diffusers.models.controlnets.FluxControlNetOutput[[diffusers.models.controlnets.FluxControlNetOutput]]

```python
diffusers.models.controlnets.FluxControlNetOutput(controlnet_block_samples: tuple[torch.Tensor], controlnet_single_block_samples: tuple[torch.Tensor])
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/controlnets/controlnet_flux.py#L40)

Xet Storage Details

Size:: 6.65 kB
Xet hash:: 135aa279ae3cce67145aef0056b76882e9b54e2b963852d4badd443215523676

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

	# FluxControlNetModel

	FluxControlNetModel は、Flux.1 向けの ControlNet の実装です。

	ControlNetモデルは、Lvmin Zhang、Anyi Rao、Maneesh Agrawala による [Adding Conditional Control to Text-to-Image Diffusion Models](https://huggingface.co/papers/2302.05543) で紹介されました。エッジマップ、深度マップ、セグメンテーションマップ、ポーズ検出用のキーポイントなどの追加入力に対してモデルを条件付けすることで、テキストから画像を生成する際の制御性を高めます。

	論文の抄録は以下の通りです：

	本稿では、大規模な事前学習済みテキストから画像への拡散モデルに空間的条件付け制御を追加するためのニューラルネットワークアーキテクチャであるControlNetを提案します。ControlNetは、実運用可能な大規模拡散モデルを固定し、数十億枚の画像で事前学習された深く頑健なエンコーディング層を強力なバックボーンとして再利用することで、多様な条件付け制御のセットを学習します。このニューラルアーキテクチャは、「ゼロ畳み込み」（ゼロ初期化された畳み込み層）によって接続されており、パラメータをゼロから段階的に増加させ、有害なノイズがファインチューニングに影響を与えないことを保証します。Stable Diffusionを用いて、エッジ、深度、セグメンテーション、人間のポーズなどの様々な条件付け制御を、プロンプトの有無にかかわらず、単一または複数の条件を用いてテストしました。ControlNetの学習は、小規模（<50k）および大規模（>1m）のデータセットのいずれにおいても頑健であることが示されています。広範な結果から、ControlNetは画像拡散モデルの制御に関するより幅広いアプリケーションを促進し得ることが示されました。

	## 元の形式から読み込む

	デフォルトでは、[FluxControlNetModel](/docs/diffusers/main/ja/api/models/controlnet_flux#diffusers.FluxControlNetModel)は[from_pretrained()](/docs/diffusers/main/ja/api/models/overview#diffusers.ModelMixin.from_pretrained)で読み込む必要があります。

	```py
	from diffusers import FluxControlNetPipeline
	from diffusers.models import FluxControlNetModel, FluxMultiControlNetModel

	controlnet = FluxControlNetModel.from_pretrained("InstantX/FLUX.1-dev-Controlnet-Canny")
	pipe = FluxControlNetPipeline.from_pretrained("black-forest-labs/FLUX.1-dev", controlnet=controlnet)

	controlnet = FluxControlNetModel.from_pretrained("InstantX/FLUX.1-dev-Controlnet-Canny")
	controlnet = FluxMultiControlNetModel([controlnet])
	pipe = FluxControlNetPipeline.from_pretrained("black-forest-labs/FLUX.1-dev", controlnet=controlnet)
	```

	## FluxControlNetModel[[diffusers.FluxControlNetModel]]

	#### diffusers.FluxControlNetModel[[diffusers.FluxControlNetModel]]

	```python
	diffusers.FluxControlNetModel(patch_size: int = 1, in_channels: int = 64, num_layers: int = 19, num_single_layers: int = 38, attention_head_dim: int = 128, num_attention_heads: int = 24, joint_attention_dim: int = 4096, pooled_projection_dim: int = 768, guidance_embeds: bool = False, axes_dims_rope: list[int] = [16, 56, 56], num_mode: int = None, conditioning_embedding_channels: int = None)
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/controlnets/controlnet_flux.py#L45)

	#### forward[[diffusers.FluxControlNetModel.forward]]

	```python
	forward(hidden_states: Tensor, controlnet_cond: Tensor, controlnet_mode: Tensor = None, conditioning_scale: float = 1.0, encoder_hidden_states: Tensor = None, pooled_projections: Tensor = None, timestep: LongTensor = None, img_ids: Tensor = None, txt_ids: Tensor = None, guidance: Tensor = None, joint_attention_kwargs: dict[str, typing.Any] \| None = None, return_dict: bool = True)
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/controlnets/controlnet_flux.py#L157)

	パラメータ:

	hidden_states (`torch.FloatTensor`、shape `(batch size, channel, height, width)`) : 入力 `hidden_states`。

	controlnet_cond (`torch.Tensor`) : 形状が `(batch_size, sequence_length, hidden_size)` の条件付き入力テンソル。

	controlnet_mode (`torch.Tensor`) : 形状が `(batch_size, 1)` のモードテンソル。

	conditioning_scale (`float`、デフォルトは`1.0`) : ControlNet の出力に対するスケール係数。

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

	pooled_projections (`torch.FloatTensor`、shape `(batch_size, projection_dim)`) : 入力条件の埋め込みから投影された埋め込み。

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

	img_ids (`torch.Tensor`) : 画像トークンの位置ID。

	txt_ids (`torch.Tensor`) : テキストトークンの位置ID。

	guidance (`torch.Tensor`, 任意) : モデルのガイダンス蒸留版で使用するガイダンススケールテンソル。

	joint_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`を返すかどうか。

	戻り値:

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

	[FluxTransformer2DModel](/docs/diffusers/main/ja/api/models/flux_transformer#diffusers.FluxTransformer2DModel)のforwardメソッド。

	## FluxControlNetOutput[[diffusers.models.controlnets.FluxControlNetOutput]]

	#### diffusers.models.controlnets.FluxControlNetOutput[[diffusers.models.controlnets.FluxControlNetOutput]]

	```python
	diffusers.models.controlnets.FluxControlNetOutput(controlnet_block_samples: tuple[torch.Tensor], controlnet_single_block_samples: tuple[torch.Tensor])
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/controlnets/controlnet_flux.py#L40)