Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on pre/post processing operations and dlq support #26772

Merged
merged 4 commits into from
May 31, 2023

Conversation

damccorm
Copy link
Contributor

@damccorm damccorm commented May 18, 2023

This adds docs for the DLQ and pre/postprocess features added in #26309 and #26261

This shouldn't be merged until 2.48 is released

RENDERED


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI.

@damccorm damccorm marked this pull request as ready for review May 18, 2023 20:49
@damccorm
Copy link
Contributor Author

R: @rszper

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control

@@ -192,7 +192,9 @@ with pipeline as p:

For more information on resource hints, see [Resource hints](/documentation/runtime/resource-hints/).

## Use a keyed ModelHandler
## RunInference Patterns
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should include text after this header describing the section. Something along the lines of:

This section provides examples of RunInference patterns.

(But hopefully more informative than that.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done - let me know if you think it sounds ok: "This section suggests patterns and best practices that can be used to make your inference pipelines simpler, more robust, and more efficient."

damccorm and others added 2 commits May 19, 2023 13:05
Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>
Copy link
Contributor Author

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review!

@@ -192,7 +192,9 @@ with pipeline as p:

For more information on resource hints, see [Resource hints](/documentation/runtime/resource-hints/).

## Use a keyed ModelHandler
## RunInference Patterns
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done - let me know if you think it sounds ok: "This section suggests patterns and best practices that can be used to make your inference pipelines simpler, more robust, and more efficient."

Copy link
Contributor Author

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review!

Copy link
Contributor

@rszper rszper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small comment. Apart from that, LGTM.

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>
@damccorm
Copy link
Contributor Author

I'll merge this once 2.48 is released

@damccorm damccorm merged commit d195be2 into master May 31, 2023
@damccorm damccorm deleted the users/damccorm/pre-post-dlq-docs branch May 31, 2023 19:53
Dippatel98 pushed a commit to Dippatel98/beam that referenced this pull request Jun 5, 2023
)

* Add docs on pre/post processing operations and dlq support

* Apply suggestions from code review

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

* Add description to RunInference Patterns

* Wording

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

---------

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>
scwhittle pushed a commit to scwhittle/beam that referenced this pull request Jun 8, 2023
)

* Add docs on pre/post processing operations and dlq support

* Apply suggestions from code review

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

* Add description to RunInference Patterns

* Wording

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

---------

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>
bullet03 pushed a commit to akvelon/beam that referenced this pull request Aug 11, 2023
)

* Add docs on pre/post processing operations and dlq support

* Apply suggestions from code review

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

* Add description to RunInference Patterns

* Wording

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

---------

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>
cushon pushed a commit to cushon/beam that referenced this pull request May 24, 2024
)

* Add docs on pre/post processing operations and dlq support

* Apply suggestions from code review

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

* Add description to RunInference Patterns

* Wording

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>

---------

Co-authored-by: Rebecca Szper <98840847+rszper@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants