[pipes] edit to dagster pipes details/customization guide #17192
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
|
Current dependencies on/for this PR: This comment was auto-generated by Graphite. |
schrockn
reviewed
Oct 13, 2023
|
|
||
| 1. The creation of communications channels between the orchestration and external process; | ||
| 2. The launching and terminating of the external process; | ||
| 3. The processing of all messages reported by the external process and the closing of communications channels. | ||
|
|
||
| Pipes sessions are created in the orchestration process with the <PyObject object="open_pipes_session" /> context manager. This function is exported by `dagster` and should be called inside of an asset or op compute function - somewhere where an <PyObject object="OpExecutionContext" /> or <PyObject object="AssetExecutionContext" /> is available: | ||
| There are separate APIs for interacting with a Pipes session in the orchestration and external processes. For the orchestration process, these APIs are defined in `dagster`. For the external process, these APIs are defined by a Pipes integration library that is loaded by user code in the external process. This library knows how to interpret the bootstrap payload and spin up a context loader and message writer. |
There was a problem hiding this comment.
I'm a bit confused by this.
"For the external process, these APIs are defined by a Pipes integration library that is loaded by user code in the external process."
Do you mean just dagster-pipes?
There was a problem hiding this comment.
Wanted to emphasize that the external process library can be more than just dagster-pipes-- dagster-pipes explained in the next paragraph. Feel free to propose improvement here.
There was a problem hiding this comment.
It was a bit confusing, since we don't have any additional libraries right now.
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-mhhvp4f7j-elementl.vercel.app Direct link to changed pages: |
schrockn
approved these changes
Oct 13, 2023
Comment on lines
243
to
248
| - **Opening routine**: Writes the context payload and spins up the message reader (which usually involves starting a thread to continually read messages). These steps may involve the creation of temporary resources, such as a temporary file (locally or on some remote system) for the context payload or a temporary directory to which messages will be written. | ||
| - **Body**: User code should handle launching, polling, and termination of the external process here. While the external process is executing, any intermediate results that have been received can be reported to Dagster with `yield from pipes_session.get_results()`. | ||
| - **Closing routine**: Ensures that all messages written by the external process have been read into the orchestration process and cleans up any resources used by the context injector and message reader. |
smackesey
force-pushed
the
sean/pipes-guide-edits
branch
2 times, most recently
from
8ae659f to
d81e68d
Compare
smackesey
force-pushed
the
sean/pipes-guide-edits
branch
from
d81e68d to
be74c81
Compare
yuhan
pushed a commit
that referenced
this pull request
Oct 13, 2023
Updates including: - Fix typos etc - Convert more object refs to formal `PyObject` links - Some light restructuring of the pipes lifecycle sections - Moving all code snippets into `docs_snippets` (and fixing import errors etc) - Added "Logs" to the terms and diagram - A note about customizing log handling Browsed.
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.
Summary & Motivation
Updates including:
PyObjectlinksdocs_snippets(and fixing import errors etc)How I Tested These Changes
Browsed.