[minor] Introduce for-loop

liamhuber commented 1 month ago

from pyiron_workflow import Workflow

@Workflow.wrap.as_function_node("together")
def Three(a: int, b: int, c: int, d: int, e: str = "foobar"):
    return (a, b, c, d, e),

for_instance = Workflow.create.for_node(
    Three,
    iter_on=("a", "b"),
    zip_on=("c", "d"),
    a=[1, 2], 
    b=[3, 4, 5], 
    c=[6, 7], 
    d=[7, 8, 9], 
    e="e"
)
out = for_instance()
out.df

You are locked-in to iterating on those variables and not the others, but can freely re-run with different lengths for the input. And the whole thing is (un)pickleable, as usual.

TODO:

[x] Tests
[x] Refactor the For._build_body routine into smaller, more readable pieces
[x] Remove the old for-loop and use this in its place in integration tests and demos
[x] Docstrings for stuff other than just the instance creator
[x] handle the case that iterated input channel names would conflict with output names in the final df
[x] Give easy access to setting executor across body nodes

The old Workflow.create.meta.for_loop is gone in favour of Workflow.create.for_node.

github-actions[bot] commented 1 month ago

:point_left: Launch a binder notebook on branch _pyiron/pyiron_workflow/forloop

codacy-production[bot] commented 1 month ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
:white_check_mark: +0.39% (target: -1.00%)	:white_check_mark: 100.00%

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (c0228221edc9c181c7f8fd3d49bff8d751756470) | 3797 | 3378 | 88.96% | | | Head commit (c42555396c5c917ebc12c760e83fdac3de38f19b) | 3925 (+128) | 3507 (+129) | 89.35% (**+0.39%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#309) | 149 | 149 | **100.00%** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`