[Feedback] docs/components/pipelines/user-guides/core-functions/control-flow.md
- Dominant language
- HTML
- Stars
- 188
- Forks
- 933
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 10
Description
From docs:
> Kubeflow Pipelines supports loops which cause fan-out and fan-in of tasks.
but doesn't state if this is the ONLY type of loop.
The documentation page is missing example /explanation on how to use a basic loop (non parallel)
Apologies if this is something that should be obvious but I can't wrap my head around it
The following
```python
@dsl.pipeline(name="loop-basic", description="Common training loop"
def do_train(epochs: int):
# init model:
tmodel = make_model()
# training loop - WILL FAIL:
for epoch in range(epochs):
t1 = task_train(tmodel.output)
t2 = task_eval(t1.output)
tmodel = t2
```
This fails because input to @dsl.pipeline is not an int, but an input channel - would be great to explain how the basic loop should be used under the flow control section or warn that this structure is incompatible with the pipeline and must be embedded into component
Contributor guide
Research direction
The issue names docs/components/pipelines/user-guides/core-functions/control-flow.md; start with its flow-control section and the quoted loop example. Update the page to explain whether basic non-parallel loops are supported and how the shown input-channel case should be handled; done when readers can distinguish supported loop forms and follow a basic-loop example or limitation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, machine-learning
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100