Hi all,

I've been digging through the Beam docs and noticed that we don't have a
standard way to diagram/represent Beam pipelines. (Are PTransforms nodes in
a DAG? Or edges?) I wrote up a Google Doc[1] that overviews this issue and
proposes a new pipeline diagram format for our docs. I'd love to get your
feedback and comments on this!

Here's the first paragraph for context:
*This is a proposal to standardize the mental model we use to communicate
Beam pipeline concepts. We currently use different mental models throughout
the documentation, which can be confusing to readers. The purpose of this
proposal is to create a canonical mental model. The canonical mental model
should: provide intuition to new users about basic pipelines; scale to
accurately diagram longer, complicated pipelines; help readers debug issues
at execution time; represent Beam pipelines generally (not a specific
execution engine)*

Best,
Cyrus

[1]
https://docs.google.com/document/d/1khf9Bx4XJWsKUD6J1eDcYo_8dL9LBoHDtJpyDjDzOMM/edit?usp=sharing

Reply via email to