-
Notifications
You must be signed in to change notification settings - Fork 890
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
English sentence feature descriptions #1201
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1201 +/- ##
==========================================
+ Coverage 98.60% 98.63% +0.02%
==========================================
Files 130 134 +4
Lines 13932 14284 +352
==========================================
+ Hits 13738 14089 +351
- Misses 194 195 +1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good to me - I will take another look tomorrow and dive a little deeper into the logic, and leave any additional comments then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few more suggestions for consideration. I don't think any of these are blocking issues though, and overall this looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it'd be good to add some examples of how to use this functionality to the docs.
Perhaps a brief example, similar to what we did with feature graphs, along with a guide entry about how the user can customize the descriptions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Add
describe_feature
function which takes a feature and optionally custom, manually defined metadata and returns an English sentence description of what the feature is:<Feature: value>
: The "value".<Feature: ABSOLUTE(value)>
: The absolute value of the "value".<Feature: sessions.device_name>
: The "device_name" for the instance of "sessions" associated with this instance of "log".<Feature: MODE(log.zipcode)>
: The most frequently occurring value of the "zipcode" of all instances of "log" for each "id" in "customers".Resolves #940