Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /v0.43.0 /ja /modular_diffusers /sequential_pipeline_blocks.md

mishig

2 days ago

preview code

download

raw

6.08 kB

# SequentialPipelineBlocks

[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) は、他の [ModularPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks) をシーケンスとして組み合わせるマルチブロック型です。`inputs` と `intermediate_outputs` を用いて、データは1つのブロックから次のブロックへ直線的に流れます。[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) 内の各ブロックは通常、パイプラインの1ステップを表しており、これらを組み合わせることでパイプラインを段階的に構築していきます。

このガイドでは、2つのブロックを[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks)に接続する方法を示します。

2つの[ModularPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks)を作成します。最初のブロック`InputBlock`は`batch_size`の値を出力し、2番目のブロック`ImageEncoderBlock`は`batch_size`を`inputs`として使用します。

```py
from diffusers.modular_pipelines import ModularPipelineBlocks, InputParam, OutputParam
class InputBlock(ModularPipelineBlocks):
    @property
    def inputs(self):
        return [
            InputParam(name="prompt", type_hint=list, description="list of text prompts"),
            InputParam(name="num_images_per_prompt", type_hint=int, description="number of images per prompt"),
        ]
    @property
    def intermediate_outputs(self):
        return [
            OutputParam(name="batch_size", description="calculated batch size"),
        ]
    @property
    def description(self):
        return "A block that determines batch_size based on the number of prompts and num_images_per_prompt argument."
    def __call__(self, components, state):
        block_state = self.get_block_state(state)
        batch_size = len(block_state.prompt)
        block_state.batch_size = batch_size * block_state.num_images_per_prompt
        self.set_block_state(state, block_state)
        return components, state
```

```py
import torch
from diffusers.modular_pipelines import ModularPipelineBlocks, InputParam, OutputParam
class ImageEncoderBlock(ModularPipelineBlocks):
    @property
    def inputs(self):
        return [
            InputParam(name="image", type_hint="PIL.Image", description="raw input image to process"),
            InputParam(name="batch_size", type_hint=int),
        ]
    @property
    def intermediate_outputs(self):
        return [
            OutputParam(name="image_latents", description="latents representing the image"),
        ]
    @property
    def description(self):
        return "Encode raw image into its latent presentation"
    def __call__(self, components, state):
        block_state = self.get_block_state(state)
        # Simulate processing the image
        # This will change the state of the image from a PIL image to a tensor for all blocks
        block_state.image = torch.randn(1, 3, 512, 512)
        block_state.batch_size = block_state.batch_size * 2
        block_state.image_latents = torch.randn(1, 4, 64, 64)
        self.set_block_state(state, block_state)
        return components, state
```

[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) を定義して、2 つのブロックを接続します。ブロックのインスタンスを `block_classes` に、それに対応する名前を `block_names` に列挙します。ブロックは `block_classes` に記載された順序で実行され、データは [PipelineState](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.PipelineState) を介して 1 つのブロックから次のブロックへ流れます。

```py
class ImageProcessingStep(SequentialPipelineBlocks):
    """
    # auto_docstring
    """
    model_name = "my_model"
    block_classes = [InputBlock(), ImageEncoderBlock()]
    block_names = ["input", "image_encoder"]
    @property
    def description(self):
        return (
            "Process text prompts and images for the pipeline. It:\n"
            " - Determines the batch size from the prompts.\n"
            " - Encodes the image into latent space."
        )
```

[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) を作成すると、`inputs`、`intermediate_outputs`、`expected_components` などのプロパティはサブブロックから自動的に集約されるため、再定義する必要はありません。

設定すべきプロパティがいくつかあります:

- `description`: 組み立てられたブロックの説明として、その結合ステップが何を行うのかを説明する記述の追加を推奨します。
- `model_name`: サブブロックから自動的に導出されますが、常に正しいとは限らないため、上書きする必要がある場合があります。
- `outputs`: デフォルトでは`intermediate_outputs`と同じですが、ドキュメントに表示される値を制御するために手動で設定できます。中間値のすべてではなく、最終的な出力のみを表示する場合に便利です。

これらのプロパティと、集約された`inputs`、`intermediate_outputs`、`expected_components`は、`doc`プロパティを自動的に生成するために使用されます。

`ImageProcessingStep`ブロックを出力してサブブロックを確認し、ブロックの入力、出力、コンポーネントの完全なサマリーには`doc`を使用します。

```py
blocks = ImageProcessingStep()
print(blocks)
print(blocks.doc)
```

Xet Storage Details

Size:: 6.08 kB
Xet hash:: afe93252f16ce9879f9e5d28e9aad5994490d497773743b564df3660b9e68ea9

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

	# SequentialPipelineBlocks

	[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) は、他の [ModularPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks) をシーケンスとして組み合わせるマルチブロック型です。`inputs` と `intermediate_outputs` を用いて、データは1つのブロックから次のブロックへ直線的に流れます。[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) 内の各ブロックは通常、パイプラインの1ステップを表しており、これらを組み合わせることでパイプラインを段階的に構築していきます。

	このガイドでは、2つのブロックを[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks)に接続する方法を示します。

	2つの[ModularPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks)を作成します。最初のブロック`InputBlock`は`batch_size`の値を出力し、2番目のブロック`ImageEncoderBlock`は`batch_size`を`inputs`として使用します。

	```py
	from diffusers.modular_pipelines import ModularPipelineBlocks, InputParam, OutputParam

	class InputBlock(ModularPipelineBlocks):

	@property
	def inputs(self):
	return [
	InputParam(name="prompt", type_hint=list, description="list of text prompts"),
	InputParam(name="num_images_per_prompt", type_hint=int, description="number of images per prompt"),
	]

	@property
	def intermediate_outputs(self):
	return [
	OutputParam(name="batch_size", description="calculated batch size"),
	]

	@property
	def description(self):
	return "A block that determines batch_size based on the number of prompts and num_images_per_prompt argument."

	def __call__(self, components, state):
	block_state = self.get_block_state(state)
	batch_size = len(block_state.prompt)
	block_state.batch_size = batch_size * block_state.num_images_per_prompt
	self.set_block_state(state, block_state)
	return components, state
	```

	```py
	import torch
	from diffusers.modular_pipelines import ModularPipelineBlocks, InputParam, OutputParam

	class ImageEncoderBlock(ModularPipelineBlocks):

	@property
	def inputs(self):
	return [
	InputParam(name="image", type_hint="PIL.Image", description="raw input image to process"),
	InputParam(name="batch_size", type_hint=int),
	]

	@property
	def intermediate_outputs(self):
	return [
	OutputParam(name="image_latents", description="latents representing the image"),
	]

	@property
	def description(self):
	return "Encode raw image into its latent presentation"

	def __call__(self, components, state):
	block_state = self.get_block_state(state)
	# Simulate processing the image
	# This will change the state of the image from a PIL image to a tensor for all blocks
	block_state.image = torch.randn(1, 3, 512, 512)
	block_state.batch_size = block_state.batch_size * 2
	block_state.image_latents = torch.randn(1, 4, 64, 64)
	self.set_block_state(state, block_state)
	return components, state
	```

	[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) を定義して、2 つのブロックを接続します。ブロックのインスタンスを `block_classes` に、それに対応する名前を `block_names` に列挙します。ブロックは `block_classes` に記載された順序で実行され、データは [PipelineState](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.PipelineState) を介して 1 つのブロックから次のブロックへ流れます。

	```py
	class ImageProcessingStep(SequentialPipelineBlocks):
	"""
	# auto_docstring
	"""
	model_name = "my_model"
	block_classes = [InputBlock(), ImageEncoderBlock()]
	block_names = ["input", "image_encoder"]

	@property
	def description(self):
	return (
	"Process text prompts and images for the pipeline. It:\n"
	" - Determines the batch size from the prompts.\n"
	" - Encodes the image into latent space."
	)
	```

	[SequentialPipelineBlocks](/docs/diffusers/v0.43.0/ja/api/modular_diffusers/pipeline_blocks#diffusers.SequentialPipelineBlocks) を作成すると、`inputs`、`intermediate_outputs`、`expected_components` などのプロパティはサブブロックから自動的に集約されるため、再定義する必要はありません。

	設定すべきプロパティがいくつかあります:

	- `description`: 組み立てられたブロックの説明として、その結合ステップが何を行うのかを説明する記述の追加を推奨します。
	- `model_name`: サブブロックから自動的に導出されますが、常に正しいとは限らないため、上書きする必要がある場合があります。
	- `outputs`: デフォルトでは`intermediate_outputs`と同じですが、ドキュメントに表示される値を制御するために手動で設定できます。中間値のすべてではなく、最終的な出力のみを表示する場合に便利です。

	これらのプロパティと、集約された`inputs`、`intermediate_outputs`、`expected_components`は、`doc`プロパティを自動的に生成するために使用されます。

	`ImageProcessingStep`ブロックを出力してサブブロックを確認し、ブロックの入力、出力、コンポーネントの完全なサマリーには`doc`を使用します。

	```py
	blocks = ImageProcessingStep()
	print(blocks)
	print(blocks.doc)
	```