Add public docs for entity aliasing #1951
Conversation
Signed-off-by: Cody Lin <codyl@twitter.com>
codyjlin
requested review from
achals,
adchia,
felixwang9817,
tsotnet,
woop and
a team
as code owners
|
Hi @codyjlin. Thanks for your PR. I'm waiting for a feast-dev member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Codecov Report
@@ Coverage Diff @@
## master #1951 +/- ##
===========================================
- Coverage 81.97% 59.51% -22.46%
===========================================
Files 99 99
Lines 7922 7922
===========================================
- Hits 6494 4715 -1779
- Misses 1428 3207 +1779
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
| @@ -53,6 +53,50 @@ global_stats_fv = FeatureView( | |||
| {% endtab %} | |||
| {% endtabs %} | |||
|
|
|||
| ## Entity aliasing | |||
|
|
|||
| "Entity aliases" can be specified to join `entity_df` columns that do not match the column names in the feature data table. Another use case involves entities that are a subclass of a more general entity. For example, "spammer" and "reporter" could be aliases of a "user" entity, and "origin" and "destination" could be aliases of a "location" entity as shown below. It is suggested that you dynamically specify the new FeatureView name using `.with_name` and `join_key_map` override using `.with_join_key_map` instead of register each new copy. | |||
There was a problem hiding this comment.
This intro is a bit cryptic
- What is "the feature data table"?
- What is "entity_df"? What about "entity dataframe"?
- We seem to be mixing what entity aliasing is, what it is used for, and how to use it, all in a single paragraph.
There was a problem hiding this comment.
Got it, let me know if the updated version is better.
Signed-off-by: Cody Lin <codyl@twitter.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: adchia, codyjlin 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:
Approvers can indicate their approval by writing |
Signed-off-by: Cody Lin codyl@twitter.com
What this PR does / why we need it:
This adds public documentation for entity aliasing functionality to the concepts/feature-view page. (Also, this is my first time contributing the public docs - not sure what the process is / if it's ok to do it through a PR like this.)
Which issue(s) this PR fixes:
Fixes #1762
Does this PR introduce a user-facing change?: