Skip to content

Commit 8f6328c

Browse files
DN6yiyixuxu
andauthored
[Modular] Clean up docs (#12604)
update Co-authored-by: YiYi Xu <yixu310@gmail.com>
1 parent 8d45f21 commit 8f6328c

File tree

4 files changed

+11
-22
lines changed

4 files changed

+11
-22
lines changed

docs/source/en/modular_diffusers/loop_sequential_pipeline_blocks.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ specific language governing permissions and limitations under the License.
1212

1313
# LoopSequentialPipelineBlocks
1414

15-
[`~modular_pipelines.LoopSequentialPipelineBlocks`] are a multi-block type that composes other [`~modular_pipelines.ModularPipelineBlocks`] together in a loop. Data flows circularly, using `intermediate_inputs` and `intermediate_outputs`, and each block is run iteratively. This is typically used to create a denoising loop which is iterative by default.
15+
[`~modular_pipelines.LoopSequentialPipelineBlocks`] are a multi-block type that composes other [`~modular_pipelines.ModularPipelineBlocks`] together in a loop. Data flows circularly, using `inputs` and `intermediate_outputs`, and each block is run iteratively. This is typically used to create a denoising loop which is iterative by default.
1616

1717
This guide shows you how to create [`~modular_pipelines.LoopSequentialPipelineBlocks`].
1818

@@ -21,7 +21,6 @@ This guide shows you how to create [`~modular_pipelines.LoopSequentialPipelineBl
2121
[`~modular_pipelines.LoopSequentialPipelineBlocks`], is also known as the *loop wrapper* because it defines the loop structure, iteration variables, and configuration. Within the loop wrapper, you need the following variables.
2222

2323
- `loop_inputs` are user provided values and equivalent to [`~modular_pipelines.ModularPipelineBlocks.inputs`].
24-
- `loop_intermediate_inputs` are intermediate variables from the [`~modular_pipelines.PipelineState`] and equivalent to [`~modular_pipelines.ModularPipelineBlocks.intermediate_inputs`].
2524
- `loop_intermediate_outputs` are new intermediate variables created by the block and added to the [`~modular_pipelines.PipelineState`]. It is equivalent to [`~modular_pipelines.ModularPipelineBlocks.intermediate_outputs`].
2625
- `__call__` method defines the loop structure and iteration logic.
2726

@@ -90,4 +89,4 @@ Add more loop blocks to run within each iteration with [`~modular_pipelines.Loop
9089

9190
```py
9291
loop = LoopWrapper.from_blocks_dict({"block1": LoopBlock(), "block2": LoopBlock})
93-
```
92+
```

docs/source/en/modular_diffusers/pipeline_block.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,7 @@ A [`~modular_pipelines.ModularPipelineBlocks`] requires `inputs`, and `intermedi
3737
]
3838
```
3939

40-
- `intermediate_inputs` are values typically created from a previous block but it can also be directly provided if no preceding block generates them. Unlike `inputs`, `intermediate_inputs` can be modified.
41-
42-
Use `InputParam` to define `intermediate_inputs`.
43-
44-
```py
45-
user_intermediate_inputs = [
46-
InputParam(name="processed_image", type_hint="torch.Tensor", description="image that has been preprocessed and normalized"),
47-
]
48-
```
49-
50-
- `intermediate_outputs` are new values created by a block and added to the [`~modular_pipelines.PipelineState`]. The `intermediate_outputs` are available as `intermediate_inputs` for subsequent blocks or available as the final output from running the pipeline.
40+
- `intermediate_outputs` are new values created by a block and added to the [`~modular_pipelines.PipelineState`]. The `intermediate_outputs` are available as `inputs` for subsequent blocks or available as the final output from running the pipeline.
5141

5242
Use `OutputParam` to define `intermediate_outputs`.
5343

@@ -65,8 +55,8 @@ The intermediate inputs and outputs share data to connect blocks. They are acces
6555

6656
The computation a block performs is defined in the `__call__` method and it follows a specific structure.
6757

68-
1. Retrieve the [`~modular_pipelines.BlockState`] to get a local view of the `inputs` and `intermediate_inputs`.
69-
2. Implement the computation logic on the `inputs` and `intermediate_inputs`.
58+
1. Retrieve the [`~modular_pipelines.BlockState`] to get a local view of the `inputs`
59+
2. Implement the computation logic on the `inputs`.
7060
3. Update [`~modular_pipelines.PipelineState`] to push changes from the local [`~modular_pipelines.BlockState`] back to the global [`~modular_pipelines.PipelineState`].
7161
4. Return the components and state which becomes available to the next block.
7262

@@ -76,7 +66,7 @@ def __call__(self, components, state):
7666
block_state = self.get_block_state(state)
7767

7868
# Your computation logic here
79-
# block_state contains all your inputs and intermediate_inputs
69+
# block_state contains all your inputs
8070
# Access them like: block_state.image, block_state.processed_image
8171

8272
# Update the pipeline state with your updated block_states
@@ -112,4 +102,4 @@ def __call__(self, components, state):
112102
unet = components.unet
113103
vae = components.vae
114104
scheduler = components.scheduler
115-
```
105+
```

docs/source/en/modular_diffusers/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ from diffusers.modular_pipelines import ComponentsManager
183183
components = ComponentManager()
184184

185185
dd_pipeline = dd_blocks.init_pipeline("YiYiXu/modular-demo-auto", components_manager=components, collection="diffdiff")
186-
dd_pipeline.load_default_componenets(torch_dtype=torch.float16)
186+
dd_pipeline.load_componenets(torch_dtype=torch.float16)
187187
dd_pipeline.to("cuda")
188188
```
189189

docs/source/en/modular_diffusers/sequential_pipeline_blocks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ specific language governing permissions and limitations under the License.
1212

1313
# SequentialPipelineBlocks
1414

15-
[`~modular_pipelines.SequentialPipelineBlocks`] are a multi-block type that composes other [`~modular_pipelines.ModularPipelineBlocks`] together in a sequence. Data flows linearly from one block to the next using `intermediate_inputs` and `intermediate_outputs`. Each block in [`~modular_pipelines.SequentialPipelineBlocks`] usually represents a step in the pipeline, and by combining them, you gradually build a pipeline.
15+
[`~modular_pipelines.SequentialPipelineBlocks`] are a multi-block type that composes other [`~modular_pipelines.ModularPipelineBlocks`] together in a sequence. Data flows linearly from one block to the next using `inputs` and `intermediate_outputs`. Each block in [`~modular_pipelines.SequentialPipelineBlocks`] usually represents a step in the pipeline, and by combining them, you gradually build a pipeline.
1616

1717
This guide shows you how to connect two blocks into a [`~modular_pipelines.SequentialPipelineBlocks`].
1818

19-
Create two [`~modular_pipelines.ModularPipelineBlocks`]. The first block, `InputBlock`, outputs a `batch_size` value and the second block, `ImageEncoderBlock` uses `batch_size` as `intermediate_inputs`.
19+
Create two [`~modular_pipelines.ModularPipelineBlocks`]. The first block, `InputBlock`, outputs a `batch_size` value and the second block, `ImageEncoderBlock` uses `batch_size` as `inputs`.
2020

2121
<hfoptions id="sequential">
2222
<hfoption id="InputBlock">
@@ -110,4 +110,4 @@ Inspect the sub-blocks in [`~modular_pipelines.SequentialPipelineBlocks`] by cal
110110
```py
111111
print(blocks)
112112
print(blocks.doc)
113-
```
113+
```

0 commit comments

Comments
 (0)