ModularPipelineBlocks

ModularPipelineBlocks là khối cơ bản để xây dựng một ModularPipeline. Nó định nghĩa các thành phần, đầu vào/đầu ra và phép tính mà một khối cần thực hiện cho một bước cụ thể trong pipeline. Một ModularPipelineBlocks kết nối với các khối khác, sử dụng state, để cho phép xây dựng các luồng công việc theo dạng module.

Một ModularPipelineBlocks đơn lẻ không thể được thực thi. Nó là bản thiết kế cho biết một bước trong pipeline nên thực hiện gì. Để thực sự chạy và thực thi một pipeline, ModularPipelineBlocks cần được chuyển đổi thành một ModularPipeline.

Hướng dẫn này sẽ cho bạn thấy cách tạo một ModularPipelineBlocks.

Đầu vào và đầu ra

Tham khảo hướng dẫn States nếu bạn chưa quen thuộc với cách hoạt động của state trong Modular Diffusers.

Một ModularPipelineBlocks yêu cầu inputs và intermediate_outputs.

inputs là các giá trị mà một khối đọc từ PipelineState để thực hiện tính toán. Các giá trị này có thể do người dùng cung cấp (như prompt hoặc hình ảnh) hoặc do một khối trước đó tạo ra (như image_latents đã được mã hóa).

Sử dụng InputParam để định nghĩa inputs.

class ImageEncodeStep(ModularPipelineBlocks):
    ...

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

intermediate_outputs là các giá trị mới được tạo bởi một khối và được thêm vào PipelineState. Các intermediate_outputs có sẵn dưới dạng inputs cho các khối tiếp theo hoặc có sẵn dưới dạng đầu ra cuối cùng từ việc chạy pipeline.

Sử dụng OutputParam để định nghĩa intermediate_outputs.

class ImageEncodeStep(ModularPipelineBlocks):
    ...

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

    ...

Các đầu vào và đầu ra trung gian chia sẻ dữ liệu để kết nối các khối. Chúng có thể được truy cập tại bất kỳ thời điểm nào, cho phép bạn theo dõi tiến độ của quy trình làm việc.

Các thành phần và cấu hình

Các thành phần và cấu hình cấp pipeline mà một khối cần được quy định trong ComponentSpec và ConfigSpec.

ComponentSpec chứa các thành phần dự kiến được sử dụng bởi một block. Bạn cần name của thành phần và lý tưởng nhất là một type_hint chỉ định chính xác thành phần đó là gì.
ConfigSpec chứa các cài đặt ở cấp độ pipeline, kiểm soát hành vi trên tất cả các khối.

class ImageEncodeStep(ModularPipelineBlocks):
    ...

    @property
    def expected_components(self):
        return [
            ComponentSpec(name="vae", type_hint=AutoencoderKL),
        ]

    @property
    def expected_configs(self):
        return [
            ConfigSpec("force_zeros_for_empty_prompt", True),
        ]

    ...

Khi các khối được chuyển đổi thành một pipeline, các thành phần sẽ trở nên khả dụng cho khối đó dưới dạng đối số đầu tiên trong __call__.

Logic tính toán

Việc tính toán mà một khối thực hiện được định nghĩa trong phương thức __call__ và nó tuân theo một cấu trúc cụ thể.

Lấy BlockState để có cái nhìn cục bộ về inputs.
Thực hiện logic tính toán trên inputs.
Cập nhật PipelineState để đẩy các thay đổi từ BlockState cục bộ trở lại PipelineState toàn cục.
Trả về các thành phần và trạng thái sẽ trở nên khả dụng cho khối tiếp theo.

class ImageEncodeStep(ModularPipelineBlocks):

    def __call__(self, components, state):
        # Get a local view of the state variables this block needs
        block_state = self.get_block_state(state)

        # Your computation logic here
        # block_state contains all your inputs
        # Access them like: block_state.image, block_state.processed_image

        # Update the pipeline state with your updated block_states
        self.set_block_state(state, block_state)
        return components, state

Kết hợp tất cả

Dưới đây là khối hoàn chỉnh với tất cả các phần được kết nối.

from diffusers import ComponentSpec, AutoencoderKL
from diffusers.modular_pipelines import InputParam, ModularPipelineBlocks, OutputParam


class ImageEncodeStep(ModularPipelineBlocks):

    @property
    def description(self):
        return "Encode an image into latent space."

    @property
    def expected_components(self):
        return [
            ComponentSpec(name="vae", type_hint=AutoencoderKL),
        ]

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

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

    def __call__(self, components, state):
        block_state = self.get_block_state(state)
        block_state.image_latents = components.vae.encode(block_state.image)
        self.set_block_state(state, block_state)
        return components, state

Mỗi block có một thuộc tính doc được tạo tự động từ các thuộc tính bạn đã định nghĩa ở trên. Nó cung cấp một bản tóm tắt về mô tả, các thành phần, đầu vào và đầu ra của block.

block = ImageEncoderStep()
print(block.doc)
class ImageEncodeStep

  Encode an image into latent space.

  Components:
      vae (`AutoencoderKL`)

  Inputs:
      image (`PIL.Image`):
          raw input image to process

  Outputs:
      image_latents (`torch.Tensor`):
          latents representing the image

Update on GitHub