You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2022/09/13 18:37:19 UTC

[GitHub] [beam] damccorm opened a new pull request, #23215: Add section to docs on resource hints/RunInference

damccorm opened a new pull request, #23215:
URL: https://github.com/apache/beam/pull/23215

   On a recent customer call, this came up as a useful case to have documented.
   
   Fixes #23207
   
   ------------------------
   
   Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
   
    - [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
    - [x] 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.
    - [x] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/get-started-contributing/#make-the-reviewers-job-easier).
   
   To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](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](https://github.com/apache/beam/workflows/Build%20python%20source%20distribution%20and%20wheels/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
   [![Python tests](https://github.com/apache/beam/workflows/Python%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Java tests](https://github.com/apache/beam/workflows/Java%20Tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Go tests](https://github.com/apache/beam/workflows/Go%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
   
   See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] damccorm commented on pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
damccorm commented on PR #23215:
URL: https://github.com/apache/beam/pull/23215#issuecomment-1246766422

   > Can we include this in the documentation as well? Something like Pass Resource hints through ModelHandler
   
   To be clear, to do that you'd need to override the ModelHandler with your own, right?
   
   I think I'd rather omit that. In general, we probably want overriding a ModelHandler to be a last resort, so I'd prefer to not lead people down that route for a problem that can be solved fairly easily a different way.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] damccorm commented on pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
damccorm commented on PR #23215:
URL: https://github.com/apache/beam/pull/23215#issuecomment-1246948213

   Run RAT PreCommit


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] github-actions[bot] commented on pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #23215:
URL: https://github.com/apache/beam/pull/23215#issuecomment-1245945129

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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] damccorm commented on pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
damccorm commented on PR #23215:
URL: https://github.com/apache/beam/pull/23215#issuecomment-1245944265

   R: @AnandInguva 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] AnandInguva commented on pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
AnandInguva commented on PR #23215:
URL: https://github.com/apache/beam/pull/23215#issuecomment-1246078206

   Actually, we can define the resource hints in the model handler for the RunInference transform. 
   
   It can be defined by overriding https://github.com/apache/beam/blob/f7073818a9ed47c4b4dedbb7269105b1676c2db3/sdks/python/apache_beam/ml/inference/base.py#L123
   
   This gets called at https://github.com/apache/beam/blob/f7073818a9ed47c4b4dedbb7269105b1676c2db3/sdks/python/apache_beam/ml/inference/base.py#L327
   
   Can we include this in the documentation as well? Something like `Pass Resource hints through ModelHandler`


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] AnandInguva commented on pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
AnandInguva commented on PR #23215:
URL: https://github.com/apache/beam/pull/23215#issuecomment-1246769264

   SG! LGTM


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] damccorm commented on a diff in pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
damccorm commented on code in PR #23215:
URL: https://github.com/apache/beam/pull/23215#discussion_r970803854


##########
website/www/site/content/en/documentation/sdks/python-machine-learning.md:
##########
@@ -109,6 +109,28 @@ with pipeline as p:
 
 Where `model_handler_A` and `model_handler_B` are the model handler setup code.
 
+#### Use Resource Hints for Different Model Requirements
+
+When using multiple models in a single pipeline, different models may have different memory or worker SKU requirements.
+Resource hints allow you to provide information to a runner about the compute resource requirements for each step in your
+pipeline.
+
+For example, the following snippet extends the previous ensemble pattern with hints for each RunInference call
+to specify RAM and hardware accelerator requirements:
+
+```
+with pipeline as p:
+   data = p | 'Read' >> beam.ReadFromSource('a_source')
+   model_a_predictions = data | RunInference(<model_handler_A>).with_resource_hints(min_ram="20GB")
+   model_b_predictions = model_a_predictions
+      | beam.Map(some_post_processing)
+      | RunInference(<model_handler_B>).with_resource_hints(
+         min_ram="4GB",
+         accelerator="type:nvidia-tesla-k80;count:1;install-nvidia-driver")
+```
+
+For more information on resource hints, see [Resource hints](../runtime/resource-hints.md).

Review Comment:
   Oh good catch - I had thought the website build process would convert these relative paths to links, but I guess I got my wires crossed with different tooling



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] damccorm merged pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
damccorm merged PR #23215:
URL: https://github.com/apache/beam/pull/23215


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] AnandInguva commented on a diff in pull request #23215: Add section to docs on resource hints/RunInference

Posted by GitBox <gi...@apache.org>.
AnandInguva commented on code in PR #23215:
URL: https://github.com/apache/beam/pull/23215#discussion_r970150043


##########
website/www/site/content/en/documentation/sdks/python-machine-learning.md:
##########
@@ -109,6 +109,28 @@ with pipeline as p:
 
 Where `model_handler_A` and `model_handler_B` are the model handler setup code.
 
+#### Use Resource Hints for Different Model Requirements
+
+When using multiple models in a single pipeline, different models may have different memory or worker SKU requirements.
+Resource hints allow you to provide information to a runner about the compute resource requirements for each step in your
+pipeline.
+
+For example, the following snippet extends the previous ensemble pattern with hints for each RunInference call
+to specify RAM and hardware accelerator requirements:
+
+```
+with pipeline as p:
+   data = p | 'Read' >> beam.ReadFromSource('a_source')
+   model_a_predictions = data | RunInference(<model_handler_A>).with_resource_hints(min_ram="20GB")
+   model_b_predictions = model_a_predictions
+      | beam.Map(some_post_processing)
+      | RunInference(<model_handler_B>).with_resource_hints(
+         min_ram="4GB",
+         accelerator="type:nvidia-tesla-k80;count:1;install-nvidia-driver")
+```
+
+For more information on resource hints, see [Resource hints](../runtime/resource-hints.md).

Review Comment:
   Can we point the path to the website instead of `.md` ? 
   
   resource hints: https://beam.apache.org/documentation/runtime/resource-hints/



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org