Add README for image classification example #21758

yeandy · 2022-06-08T21:13:44Z

Instructions on how to run a Pytorch RunInference example.

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

Choose reviewer(s) and mention them in a comment (R: @username).
Add a link to the appropriate issue in your description, if applicable. This will automatically link the pull request to the issue.
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)

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

asf-ci · 2022-06-08T21:13:46Z

Can one of the admins verify this patch?

asf-ci · 2022-06-08T21:13:46Z

Can one of the admins verify this patch?

yeandy · 2022-06-08T21:13:58Z

R: @ryanthompson591 @AnandInguva

ryanthompson591

Looks good, just a couple small comments.

sdks/python/apache_beam/examples/inference/README.md

ryanthompson591 · 2022-06-08T21:46:35Z

sdks/python/apache_beam/examples/inference/README.md

+
+### Data
+Data related to RunInference has been staged in
+`gs://apache-beam-ml/` for use with these example pipelines:


I don't know gs://apache-beam-ml will really work as a link or is right.

maybe "staged in apache-beam-testing" will work

Feel free to keep it this way if I'm just wrong or misunderstanding.

Maybe this will link right if the users cloud account is set to apache-beam-testing.

It's not intended to be a link, but rather to show the location of datasets, models, etc. related to RunInference. The apache-beam-ml bucket is public; outside users should be able to view (with command gsutil ls gs://apache-beam-ml) and read these models / datasets with no issue?

sdks/python/apache_beam/examples/inference/README.md

ryanthompson591 · 2022-06-08T21:50:45Z

sdks/python/apache_beam/examples/inference/README.md

+gs://apache-beam-ml/datasets/imagenet/raw-data/validation/ILSVRC2012_val_00005012.JPEG,573
+```
+where the second item in each line is the integer representing the predicted class of the
+image.


it would be cool if one of the ptransforms in the example joined to integer prediction to the actual name of the image.

for example:
gs://apache-beam-ml/datasets/.....5102.jpeg, horse
gs://apache-beam-ml/datasets/.....5102.jpeg, cheese

etc.

But that is outside of the scope of this PR.

I have that for a different example #21766

yeandy · 2022-06-10T15:28:13Z

I have another PR #21766, and once that gets merged I can add instructions for it in the README.md as well.

yeandy · 2022-06-10T15:30:06Z

R: @tvalentyn @TheNeuralBit

codecov · 2022-06-10T15:49:02Z

Codecov Report

Merging #21758 (80a17cf) into master (cd966ec) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #21758      +/-   ##
==========================================
+ Coverage   74.02%   74.06%   +0.03%     
==========================================
  Files         698      698              
  Lines       92192    92333     +141     
==========================================
+ Hits        68248    68383     +135     
- Misses      22693    22699       +6     
  Partials     1251     1251

Flag	Coverage Δ
python	`83.63% <ø> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...eam/transforms/py_dataflow_distribution_counter.py	`91.42% <0.00%> (-4.87%)`	⬇️
sdks/python/apache_beam/dataframe/io.py	`88.78% <0.00%> (-3.26%)`	⬇️
sdks/python/apache_beam/utils/counters.py	`85.39% <0.00%> (-1.36%)`	⬇️
...hon/apache_beam/runners/worker/bundle_processor.py	`93.42% <0.00%> (-0.13%)`	⬇️
sdks/python/apache_beam/transforms/window.py	`87.20% <0.00%> (+0.15%)`	⬆️
sdks/python/apache_beam/utils/windowed_value.py	`92.52% <0.00%> (+0.17%)`	⬆️
sdks/python/apache_beam/transforms/core.py	`92.38% <0.00%> (+0.23%)`	⬆️
...ks/python/apache_beam/runners/worker/operations.py	`74.32% <0.00%> (+0.29%)`	⬆️
...eam/runners/interactive/interactive_environment.py	`92.02% <0.00%> (+0.30%)`	⬆️
...ks/python/apache_beam/runners/worker/opcounters.py	`85.13% <0.00%> (+0.30%)`	⬆️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cd966ec...80a17cf. Read the comment docs.

TheNeuralBit

LGTM, a couple minor suggestions

TheNeuralBit · 2022-06-10T15:45:03Z

sdks/python/apache_beam/examples/inference/README.md

+
+### Datasets and Models for RunInference
+Data related to RunInference has been staged in
+`gs://apache-beam-ml/` for use with these example pipelines. You can see this by using the [gsutil tool](https://cloud.google.com/storage/docs/gsutil#gettingstarted).


(optional) maybe link to the cloud console here: https://pantheon.corp.google.com/storage/browser/apache-beam-ml

Is that link accessible to only Google employees though? would https://console.cloud.google.com/ be better?

whoops, yes it would. I copied the wrong thing :)

https://console.cloud.google.com/storage/browser/apache-beam-ml

TheNeuralBit · 2022-06-10T15:49:07Z

sdks/python/apache_beam/examples/inference/README.md

+    - ...
+    - gs://apache-beam-ml/datasets/imagenet/raw-data/validation/ILSVRC2012_val_00050000.JPEG
+-->
+- `gs://apache-beam-ml/testing/inputs/it_imagenet_validation_inputs.txt/`:


Suggested change

- `gs://apache-beam-ml/testing/inputs/it_imagenet_validation_inputs.txt/`:

- `gs://apache-beam-ml/testing/inputs/it_imagenet_validation_inputs.txt`:

TheNeuralBit · 2022-06-10T15:51:47Z

sdks/python/apache_beam/examples/inference/README.md

+  validation data
+    - gs://apache-beam-ml/datasets/imagenet/raw-data/validation/ILSVRC2012_val_00000001.JPEG
+    - ...
+    - gs://apache-beam-ml/datasets/imagenet/raw-data/validation/ILSVRC2012_val_00000015.JPEG


(optional) It might be nice to clarify that these sub-bullets are the file contents with something like:

$ gsutil cat gs://apache-beam-ml/testing/inputs/it_imagenet_validation_inputs.txt gs://apache-beam-ml/datasets/imagenet/raw-data/validation/ILSVRC2012_val_00000001.JPEG ... gs://apache-beam-ml/datasets/imagenet/raw-data/validation/ILSVRC2012_val_00000015.JPEG

TheNeuralBit

Sorry, one more thing I forgot to include in the last review.

TheNeuralBit · 2022-06-10T16:21:52Z

sdks/python/apache_beam/examples/inference/README.md

+For installation of the `torch` dependency for Dataflow pipelines, refer to these
+[instructions](https://beam.apache.org/documentation/sdks/python-pipeline-dependencies/#pypi-dependencies).


Suggested change

For installation of the `torch` dependency for Dataflow pipelines, refer to these

[instructions](https://beam.apache.org/documentation/sdks/python-pipeline-dependencies/#pypi-dependencies).

For installation of the `torch` dependency on a distributed runner, like Dataflow, refer to these

[instructions](https://beam.apache.org/documentation/sdks/python-pipeline-dependencies/#pypi-dependencies).

(Doesn't need to be exactly that text, just in general Beam docs should mention Dataflow as a distributed runner and be clear that there are others)

Thanks, fixed.

tvalentyn · 2022-06-10T18:12:55Z

sdks/python/apache_beam/examples/inference/README.md

+TODO: Add link to full documentation on Beam website when it's published.
+
+i.e. "See the
+[documentation](https://beam.apache.org/documentation/dsls/dataframes/overview/#pre-requisites)


is this a leftover?

TheNeuralBit · 2022-06-10T18:56:15Z

Merging despite the failed test since this is just a docs change.

* Add README for image classification example * Fix typos and input name changes * Fix typos and clarify inputs text * Add link to GCP console; Add clarifying comment

Add README for image classification example

212c60c

github-actions bot added examples python labels Jun 8, 2022

ryanthompson591 approved these changes Jun 8, 2022

View reviewed changes

Fix typos and input name changes

ea6bb24

TheNeuralBit approved these changes Jun 10, 2022

View reviewed changes

Fix typos and clarify inputs text

9774d0a

TheNeuralBit requested changes Jun 10, 2022

View reviewed changes

Add link to GCP console; Add clarifying comment

80a17cf

TheNeuralBit approved these changes Jun 10, 2022

View reviewed changes

tvalentyn reviewed Jun 10, 2022

View reviewed changes

tvalentyn approved these changes Jun 10, 2022

View reviewed changes

TheNeuralBit merged commit a079e97 into apache:master Jun 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add README for image classification example #21758

Add README for image classification example #21758

yeandy commented Jun 8, 2022

asf-ci commented Jun 8, 2022

asf-ci commented Jun 8, 2022

yeandy commented Jun 8, 2022

ryanthompson591 left a comment

ryanthompson591 Jun 8, 2022

yeandy Jun 10, 2022

ryanthompson591 Jun 8, 2022

yeandy Jun 10, 2022

yeandy commented Jun 10, 2022

yeandy commented Jun 10, 2022

codecov bot commented Jun 10, 2022 •

edited

Loading

TheNeuralBit left a comment

TheNeuralBit Jun 10, 2022

yeandy Jun 10, 2022

TheNeuralBit Jun 10, 2022

TheNeuralBit Jun 10, 2022

yeandy Jun 10, 2022

TheNeuralBit Jun 10, 2022

yeandy Jun 10, 2022

TheNeuralBit Jun 10, 2022

yeandy Jun 10, 2022

TheNeuralBit left a comment

TheNeuralBit Jun 10, 2022

TheNeuralBit Jun 10, 2022

yeandy Jun 10, 2022

tvalentyn Jun 10, 2022

TheNeuralBit commented Jun 10, 2022

	- `gs://apache-beam-ml/testing/inputs/it_imagenet_validation_inputs.txt/`:
	- `gs://apache-beam-ml/testing/inputs/it_imagenet_validation_inputs.txt`:

		For installation of the `torch` dependency for Dataflow pipelines, refer to these
		[instructions](https://beam.apache.org/documentation/sdks/python-pipeline-dependencies/#pypi-dependencies).

Add README for image classification example #21758

Add README for image classification example #21758

Conversation

yeandy commented Jun 8, 2022

GitHub Actions Tests Status (on master branch)

asf-ci commented Jun 8, 2022

asf-ci commented Jun 8, 2022

yeandy commented Jun 8, 2022

ryanthompson591 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yeandy commented Jun 10, 2022

yeandy commented Jun 10, 2022

codecov bot commented Jun 10, 2022 • edited Loading

Codecov Report

TheNeuralBit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheNeuralBit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheNeuralBit commented Jun 10, 2022

codecov bot commented Jun 10, 2022 •

edited

Loading