Add try_put_and_wait documentation #1514
Open
+323
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aepanchi
reviewed
Sep 17, 2024
vossmjp
reviewed
Sep 19, 2024
| *********** | ||
|
|
||
| This feature adds a new ``try_put_and_wait`` interface to the receiving nodes in the Flow Graph. | ||
| This function allows to wait until completion of single message, submitted to ``try_put_and_wait`` as an input by the Flow Graph in |
There was a problem hiding this comment.
I'd suggest, "This function puts a message as an input into a Flow Graph and then waits until all work related to that input is complete."
There was a problem hiding this comment.
I'd add a second sentence, "try_put_and_wait may reduce latency compared to calling graph::wait_for_all since graph::wait_for_all waits for all work, including work unrelated to the input message, to complete."
vossmjp
reviewed
Sep 20, 2024
| *********** | ||
|
|
||
| This feature adds a new ``try_put_and_wait`` interface to the receiving nodes in the Flow Graph. | ||
| This function allows to wait until completion of single message, submitted to ``try_put_and_wait`` as an input by the Flow Graph in |
There was a problem hiding this comment.
I'd add a second sentence, "try_put_and_wait may reduce latency compared to calling graph::wait_for_all since graph::wait_for_all waits for all work, including work unrelated to the input message, to complete."
| ``node.try_put_and_wait(msg)`` performs ``node.try_put(msg)`` on the node and waits until the work on ``msg`` is completed. | ||
| Therefore, the following conditions are true: | ||
|
|
||
| * Any task initiated by any node in the Flow Graph that involves on working with ``msg`` or any other intermediate result |
There was a problem hiding this comment.
Suggested change
| * Any task initiated by any node in the Flow Graph that involves on working with ``msg`` or any other intermediate result | |
| * Any task initiated by any node in the Flow Graph that involves working with ``msg`` or any other intermediate result |
|
|
||
| * Any task initiated by any node in the Flow Graph that involves on working with ``msg`` or any other intermediate result | ||
| computed from ``msg`` is completed. | ||
| * Any intermediate result computed from ``msg`` is retrieved from any buffer in the graph. |
There was a problem hiding this comment.
Suggested change
| * Any intermediate result computed from ``msg`` is retrieved from any buffer in the graph. | |
| * No intermediate results computed from ``msg`` remain in any buffers in the graph. |
| .. caution:: | ||
|
|
||
| To prevent ``try_put_and_wait`` calls from infinite blocking, avoid using buffering nodes at the end of the Flow Graph since the final result | ||
| would not be retrieved by the Flow Graph. |
There was a problem hiding this comment.
Suggested change
| would not be retrieved by the Flow Graph. | |
| will not be automatically consumed by the Flow Graph. |
|
|
||
| .. caution:: | ||
|
|
||
| To prevent ``try_put_and_wait`` calls from infinite blocking, avoid using buffering nodes at the end of the Flow Graph since the final result |
There was a problem hiding this comment.
Suggested change
| To prevent ``try_put_and_wait`` calls from infinite blocking, avoid using buffering nodes at the end of the Flow Graph since the final result | |
| To prevent ``try_put_and_wait`` calls from infinite waiting, avoid using buffering nodes at the end of the Flow Graph since the final result |
| }); | ||
| } | ||
|
|
||
| Each iteration of ``parallel_for`` submits a part of work into the Flow Graph. After returning from ``try_put_and_wait(input)``, it is |
There was a problem hiding this comment.
Suggested change
| Each iteration of ``parallel_for`` submits a part of work into the Flow Graph. After returning from ``try_put_and_wait(input)``, it is | |
| Each iteration of ``parallel_for`` submits an input into the Flow Graph. After returning from ``try_put_and_wait(input)``, it is |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add reference page about Flow Graph try_put_and_wait feature
Fixes # - issue number(s) if exists
Type of change
Choose one or multiple, leave empty if none of the other choices apply
Add a respective label(s) to PR if you have permissions
Tests
Documentation
Breaks backward compatibility
Notify the following users
List users with
@to send notificationsOther information