Skip to content

Commit 411b5ea

Browse files
authored
Update documentation about ignored user input (#120)
* Update documentation * Explicit `input_config` parameter
1 parent 0497e40 commit 411b5ea

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

docs/source/user_guide_pipeline.rst

+17-3
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ Here's how to create a simple pipeline and propagate results from one component
6060
pipe.add_component(ComponentAdd(), "a")
6161
pipe.add_component(ComponentAdd(), "b")
6262
63-
pipe.connect("a", "b", {"number2": "a.result"})
64-
asyncio.run(pipe.run({"a": {"number1": 10, "number2": 1}, "b": {"number1": 4}))
63+
pipe.connect("a", "b", input_config={"number2": "a.result"})
64+
asyncio.run(pipe.run({"a": {"number1": 10, "number2": 1}, "b": {"number1": 4}}))
6565
# result: 10+1+4 = 15
6666
6767
1. First, a pipeline is created, and two components named "a" and "b" are added to it.
@@ -79,6 +79,20 @@ The data flow is illustrated in the diagram below:
7979
Component "b" -> 15
8080
4 -------------------------/
8181
82-
.. warning::
82+
.. warning:: Cyclic graph
8383

8484
Cycles are not allowed in a Pipeline.
85+
86+
87+
.. warning:: Ignored user inputs
88+
89+
If inputs are provided both by user in the `pipeline.run` method and as
90+
`input_config` in a connect method, the user input will be ignored. Take for
91+
instance the following pipeline, adapted from the previous one:
92+
93+
.. code:: python
94+
95+
pipe.connect("a", "b", input_config={"number2": "a.result"})
96+
asyncio.run(pipe.run({"a": {"number1": 10, "number2": 1}, "b": {"number1": 4, "number2": 42}}))
97+
98+
The result will still be **15** because the user input `"number2": 42` is ignored.

0 commit comments

Comments
 (0)