From 724a2c095cc9aeb868b45ecf40a9c8832c94caaf Mon Sep 17 00:00:00 2001 From: Gerard Casas Saez Date: Thu, 14 Sep 2023 17:20:10 -0600 Subject: [PATCH] Update Feast component description (#266) --- tfx_addons/feast_examplegen/README.md | 45 ++++++++++++--------------- 1 file changed, 20 insertions(+), 25 deletions(-) diff --git a/tfx_addons/feast_examplegen/README.md b/tfx_addons/feast_examplegen/README.md index a34111ee..e80358b7 100644 --- a/tfx_addons/feast_examplegen/README.md +++ b/tfx_addons/feast_examplegen/README.md @@ -1,36 +1,31 @@ -# tfx-addons-feast-examplegen -Examplegen for Feast Feature Store +# FeastExampleGen -## (WIP) Setup +ExampleGen for Feast feature store. -### MacOS (old) +This component generates a Dataset out of a Feast entity_query and either a list of features or a feature service key. -``` -python -m venv venv -. venv/bin/activate -pip install -e ".[feast_examplegen] tfx==1.3" -``` - -### MacOS M1 -Ensure you have Python 3.8 installed: 3.7 won't work on M1 and TFX won't work with 3.9. +## Installation +```sh +pip install tfx-addons[feast_examplegen] ``` -brew install python@3.8 -brew link --force python@3.8 -which pip -``` - -### Install TFX on MacOS M1 -Adpated from: https://towardsdatascience.com/installing-tensorflow-on-the-m1-mac-410bb36b776 +## Example usage +```python +example_gen = FeastExampleGen( + repo_config=RepoConfig(register="gs://..."), + entity_query="SELECT user, timestamp from some_user_dataset", + features=["f1", "f2"], +) ``` -pip install six absl-py numpy google google-api-python-client wrapt opt-einsum gast astunparse termcolor flatbuffers - -pip install --upgrade --force --no-dependencies https://github.com/apple/tensorflow_macos/releases/download/v0.1alpha3/tensorflow_addons_macos-0.1a3-cp38-cp38-macosx_11_0_arm64.whl https://github.com/apple/tensorflow_macos/releases/download/v0.1alpha3/tensorflow_macos-0.1a3-cp38-cp38-macosx_11_0_arm64.whl +Component can be configured the same way as any [QueryBasedExampleGen](https://www.tensorflow.org/tfx/guide/examplegen#query-based_examplegen_customization_experimental). --- +Component `outputs` contains: + - `examples`: Channel of type `standard_artifacts.Examples` for output train + and eval examples. -python -m pip install tensorflow-macos +## Extra information -``` +- [Proposal](https://github.com/tensorflow/tfx-addons/blob/main/proposals/20210525-feast_example_gen.md) +- [Example usage](https://github.com/tensorflow/tfx-addons/tree/main/examples/fraud_feast)