docs: Add matrix of functionality for offline stores #2977

felixwang9817 · 2022-07-28T03:15:35Z

What this PR does / why we need it:

Adds additional details to data source and offline store pages
Backfills Trino data source documentation
Adds functionality matrix for each offline store (+ an overall one to compare across offline stores)

Which issue(s) this PR fixes:

Fixes #

codecov-commenter · 2022-07-28T03:24:14Z

Codecov Report

Merging #2977 (d838433) into master (fc447eb) will decrease coverage by 18.00%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master    #2977       +/-   ##
===========================================
- Coverage   77.85%   59.85%   -18.01%     
===========================================
  Files         194      194               
  Lines       16560    16560               
===========================================
- Hits        12893     9912     -2981     
- Misses       3667     6648     +2981

Flag	Coverage Δ
integrationtests	`?`
unittests	`59.85% <ø> (ø)`

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

Impacted Files	Coverage Δ
...sts/integration/registration/test_universal_cli.py	`20.20% <0.00%> (-79.80%)`	⬇️
...ts/integration/offline_store/test_offline_write.py	`26.08% <0.00%> (-73.92%)`	⬇️
...fline_store/test_universal_historical_retrieval.py	`28.94% <0.00%> (-71.06%)`	⬇️
...ests/integration/e2e/test_python_feature_server.py	`29.50% <0.00%> (-70.50%)`	⬇️
...dk/python/tests/integration/e2e/test_validation.py	`27.77% <0.00%> (-69.05%)`	⬇️
...s/integration/registration/test_universal_types.py	`32.25% <0.00%> (-67.75%)`	⬇️
sdk/python/feast/infra/online_stores/redis.py	`28.39% <0.00%> (-66.67%)`	⬇️
sdk/python/tests/integration/e2e/test_usage_e2e.py	`33.87% <0.00%> (-66.13%)`	⬇️
sdk/python/tests/data/data_creator.py	`34.78% <0.00%> (-65.22%)`	⬇️
...n/tests/integration/registration/test_inference.py	`35.71% <0.00%> (-64.29%)`	⬇️
... and 68 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 fc447eb...d838433. Read the comment docs.

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

docs/reference/offline-stores/bigquery.md

docs/reference/data-sources/postgres.md

adchia · 2022-08-02T22:05:12Z

docs/reference/offline-stores/redshift.md

-Configuration options are available [here](https://github.com/feast-dev/feast/blob/bf557bcb72c7878a16dccb48443bbbe9dc3efa49/sdk/python/feast/infra/offline_stores/redshift.py#L22).
+The full set of configuration options is available in [RedshiftOfflineStoreConfig](https://rtd.feast.dev/en/master/#feast.infra.offline_stores.redshift.RedshiftOfflineStoreConfig).
+
+## Functionality Matrix


Should we somehow call out that array features don't work?

we should, but I think that description belongs to data sources as opposed to offline stores - I can make a ticket for updating the data source docs

docs/reference/offline-stores/README.md

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

docs/reference/offline-stores/README.md

docs/reference/offline-stores/bigquery.md

docs/reference/data-sources/trino.md

Signed-off-by: Danny Chiao <danny@tecton.ai>

adchia

/lgtm

feast-ci-bot · 2022-08-03T14:28:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adchia, felixwang9817

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [adchia,felixwang9817]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* Fix broken link Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Update offline store architecture docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Add offline store matrix functionality Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Add note on the interface Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Expand matrix Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Attempt to left align Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Update reference page Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Clean up file offline store docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix file source docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Clean up snowflake offline store docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix snowflake source docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Clean up bigquery offline store docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix bigquery source docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Clean up redshift offline store docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix redshift source docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Clean up spark offline store docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix spark data source docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Clean up postgres offline store docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix postgres source docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Add clarifications to page titles Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fixes Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fixes Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Add overview page to avoid cluttering README Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix stability comment Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Add trino source docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Add trino offline store docs Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Fix bigquery partition data matrix Signed-off-by: Felix Wang <wangfelix98@gmail.com> * Add method use cases to matrix Signed-off-by: Felix Wang <wangfelix98@gmail.com> * fix nits Signed-off-by: Danny Chiao <danny@tecton.ai> Co-authored-by: Danny Chiao <danny@tecton.ai>

feast-ci-bot added the approved label Jul 28, 2022

felixwang9817 added the do-not-merge/work-in-progress label Jul 28, 2022

feast-ci-bot added the size/M label Jul 28, 2022

felixwang9817 force-pushed the offline_store_docs branch from ff0f168 to c77a66b Compare August 1, 2022 06:38

felixwang9817 added 7 commits August 1, 2022 20:01

Fix broken link

784786e

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Update offline store architecture docs

9a7f736

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Add offline store matrix functionality

ff3eb82

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Add note on the interface

0428b0b

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Expand matrix

50f1620

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Attempt to left align

d1fa37f

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Update reference page

4a69d58

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

felixwang9817 force-pushed the offline_store_docs branch from c77a66b to 5a53114 Compare August 2, 2022 03:14

feast-ci-bot added size/L and removed size/M labels Aug 2, 2022

felixwang9817 force-pushed the offline_store_docs branch from 5a53114 to 056c242 Compare August 2, 2022 03:20

Clean up file offline store docs

2c40574

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

felixwang9817 force-pushed the offline_store_docs branch from 056c242 to c59f42a Compare August 2, 2022 03:23

Fix file source docs

e3e737f

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

felixwang9817 force-pushed the offline_store_docs branch from c59f42a to f92e523 Compare August 2, 2022 03:43

felixwang9817 added 2 commits August 1, 2022 20:46

Clean up snowflake offline store docs

37816fc

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Fix snowflake source docs

3ba955e

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

felixwang9817 force-pushed the offline_store_docs branch from f92e523 to 3ba955e Compare August 2, 2022 03:46

felixwang9817 added 7 commits August 1, 2022 20:53

Clean up bigquery offline store docs

d8487d1

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Fix bigquery source docs

50f0814

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Clean up redshift offline store docs

f9dfea8

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Fix redshift source docs

6246495

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Clean up spark offline store docs

eded1ae

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Fix spark data source docs

49a8a89

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Clean up postgres offline store docs

0a185d4

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

felixwang9817 added 2 commits August 2, 2022 00:20

Fix postgres source docs

bb56130

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Add clarifications to page titles

d7f6e58

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

felixwang9817 changed the title ~~docs: Add matrix of functionality for offline stores [WIP]~~ docs: Add matrix of functionality for offline stores Aug 2, 2022

feast-ci-bot removed the do-not-merge/work-in-progress label Aug 2, 2022

Fixes

d7df14a

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

feast-ci-bot added size/XL and removed size/L labels Aug 2, 2022

Fixes

3acf35c

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

adchia reviewed Aug 2, 2022

View reviewed changes

felixwang9817 added 6 commits August 2, 2022 16:11

Add overview page to avoid cluttering README

c171bb7

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Fix stability comment

797aa85

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Add trino source docs

b7c948f

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Add trino offline store docs

787efe6

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Fix bigquery partition data matrix

1c250a8

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

Add method use cases to matrix

638be4b

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

adchia self-assigned this Aug 3, 2022

adchia reviewed Aug 3, 2022

View reviewed changes

docs/reference/offline-stores/README.md Show resolved Hide resolved

docs/reference/offline-stores/bigquery.md Outdated Show resolved Hide resolved

docs/reference/data-sources/trino.md Show resolved Hide resolved

fix nits

d838433

Signed-off-by: Danny Chiao <danny@tecton.ai>

adchia approved these changes Aug 3, 2022

View reviewed changes

feast-ci-bot added the lgtm label Aug 3, 2022

feast-ci-bot merged commit 5736709 into feast-dev:master Aug 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add matrix of functionality for offline stores #2977

docs: Add matrix of functionality for offline stores #2977

felixwang9817 commented Jul 28, 2022 •

edited by adchia

Loading

codecov-commenter commented Jul 28, 2022 •

edited

Loading

adchia Aug 2, 2022

felixwang9817 Aug 2, 2022

adchia left a comment

feast-ci-bot commented Aug 3, 2022

docs: Add matrix of functionality for offline stores #2977

docs: Add matrix of functionality for offline stores #2977

Conversation

felixwang9817 commented Jul 28, 2022 • edited by adchia Loading

codecov-commenter commented Jul 28, 2022 • edited Loading

Codecov Report

adchia Aug 2, 2022

Choose a reason for hiding this comment

felixwang9817 Aug 2, 2022

Choose a reason for hiding this comment

adchia left a comment

Choose a reason for hiding this comment

feast-ci-bot commented Aug 3, 2022

felixwang9817 commented Jul 28, 2022 •

edited by adchia

Loading

codecov-commenter commented Jul 28, 2022 •

edited

Loading