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

Fix/enrichment docs #33012 #33561

Merged
merged 11 commits into from
Jan 16, 2025
Merged

Conversation

Vishesh-Tripathi
Copy link
Contributor

Description
fixes #<33012>

This pull request updates the enrichment documentation and related notebooks with the following improvements:

Documentation:

Added mention of BigQuery in the enrichment section.
Described the batching process and caching mechanism (with_redis_cache).
Notebooks:

Elaborated on the concept of cross-joins in both the bigtable_enrichment_transform.ipynb and vertex_ai_feature_store_enrichment.ipynb notebooks, with a more detailed explanation and added visual examples.
I could not fix the broken link because I think that resource may have been deleted.

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 or the workflows README to see a list of phrases to trigger workflows.

Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@Vishesh-Tripathi
Copy link
Contributor Author

assign set of reviewers

Copy link
Contributor

Assigning reviewers. If you would like to opt out of this review, comment assign to next reviewer:

R: @damccorm for label website.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

Copy link
Contributor

@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 looking into this one


## Caching with `with_redis_cache`

For frequently used enrichment data, caching can significantly improve performance by reducing repeated calls to the remote service. Apache Beam's `with_redis_cache` method allows you to integrate a Redis cache into the enrichment pipeline.
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment on lines 91 to 95
from apache_beam.transforms.enrichment import with_redis_cache

# Enrichment pipeline with Redis cache
enriched_data = (input_data
| 'Enrich with Cache' >> with_redis_cache(redis_config=redis_config, enrichment_transform=my_enrichment_transform))
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this generated code is right, with_redis_cache should be appended to the enrichment transform like this -

| Enrichment(handler).with_redis_cache(self.host, self.port))

" | 2 | Y | 10 | P |\n",
" | 2 | Y | 20 | Q |\n",
"\n",
"Cross-joins can be computationally expensive for large datasets, so use them judiciously.\n"
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you combine this cell and the next one into a single cell? I think they're discussing the same thing.

@Vishesh-Tripathi
Copy link
Contributor Author

Vishesh-Tripathi commented Jan 16, 2025

@damccorm Sir , I made changes, as you specified, please review it and let me know if there is any mistake , Thanks for help

Copy link
Contributor

@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! I'll make a couple tweaks then merge

@damccorm damccorm merged commit 7f9ab48 into apache:master Jan 16, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants