Buckets:

mishig's picture
|
download
raw
7.56 kB
# ModularPipelineBlocks
[ModularPipelineBlocks](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks) é o bloco básico para a construção de um [ModularPipeline](/docs/diffusers/main/pt/api/modular_diffusers/pipeline#diffusers.ModularPipeline). Ele define quais componentes, entradas/saídas e computação um bloco deve executar para uma etapa específica em um pipeline. Um [ModularPipelineBlocks](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks) se conecta a outros blocos, usando [state](./modular_diffusers_states), para permitir a construção modular de fluxos de trabalho.
Um [ModularPipelineBlocks](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks) isolado não pode ser executado. Ele é um modelo do que uma etapa deve fazer em um pipeline. Para realmente executar e rodar um pipeline, o [ModularPipelineBlocks](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks) precisa ser convertido em um [ModularPipeline](/docs/diffusers/main/pt/api/modular_diffusers/pipeline#diffusers.ModularPipeline).
Este guia mostrará como criar um [ModularPipelineBlocks](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks).
## Entradas e saídas
> [!TIP]
> Consulte o guia [States](./modular_diffusers_states) se você não estiver familiarizado com o funcionamento do estado no Modular Diffusers.
A [ModularPipelineBlocks](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks) requer `inputs` e `intermediate_outputs`.
- `inputs` são os valores que um bloco lê do [PipelineState](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.PipelineState) para executar seu cálculo. Esses valores podem ser fornecidos por um usuário (como um prompt ou imagem) ou produzidos por um bloco anterior (como `image_latents` codificados).
Use `InputParam` para definir `inputs`.
```py
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` são novos valores criados por um bloco e adicionados ao [PipelineState](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.PipelineState). Os `intermediate_outputs` estão disponíveis como `inputs` para blocos subsequentes ou como a saída final da execução do pipeline.
Use `OutputParam` para definir `intermediate_outputs`.
```py
class ImageEncodeStep(ModularPipelineBlocks):
...
@property
def intermediate_outputs(self):
return [
OutputParam(name="image_latents", description="latents representing the image"),
]
...
```
As entradas e saídas intermediárias compartilham dados para conectar os blocos. Elas são acessíveis a qualquer momento, permitindo que você acompanhe o progresso do fluxo de trabalho.
## Componentes e configurações
Os componentes e as configurações de nível de pipeline de que um bloco precisa são especificados em [ComponentSpec](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_components#diffusers.ComponentSpec) e [ConfigSpec](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_components#diffusers.ConfigSpec).
- [ComponentSpec](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_components#diffusers.ComponentSpec) contém os componentes esperados usados por um bloco. Você precisa do `name` do componente e, idealmente, de um `type_hint` que especifique exatamente o que é o componente.
- [ConfigSpec](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_components#diffusers.ConfigSpec) contém configurações de nível de pipeline que controlam o comportamento em todos os blocos.
```py
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),
]
...
```
Quando os blocos são convertidos em um pipeline, os componentes ficam disponíveis para o bloco como o primeiro argumento em `__call__`.
## Lógica de computação
O cálculo que um bloco executa é definido no método `__call__` e segue uma estrutura específica.
1. Obtenha o [BlockState](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.BlockState) para obter uma visão local dos `inputs`.
2. Implemente a lógica de computação nos `inputs`.
3. Atualize o [PipelineState](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.PipelineState) para enviar as alterações do [BlockState](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.BlockState) local de volta para o [PipelineState](/docs/diffusers/main/pt/api/modular_diffusers/pipeline_states#diffusers.modular_pipelines.PipelineState) global.
4. Retorna os componentes e o estado que ficam disponíveis para o próximo bloco.
```py
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
```
## Juntando tudo
Aqui está o bloco completo com todas as partes conectadas.
```py
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
```
Todo bloco possui uma propriedade `doc` que é gerada automaticamente a partir das propriedades definidas acima. Ela fornece um resumo da descrição, dos componentes, das entradas e das saídas do bloco.
```py
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
```

Xet Storage Details

Size:
7.56 kB
·
Xet hash:
5a38032686049c3135cdc1b298572500ac3520c5c2c8c7de9c98c9aa9bc51a06

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