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

English sentence feature descriptions #1201

Merged
merged 21 commits into from
Oct 30, 2020
Merged

English sentence feature descriptions #1201

merged 21 commits into from
Oct 30, 2020

Conversation

frances-h
Copy link
Contributor

@frances-h frances-h commented Oct 26, 2020

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

@frances-h frances-h self-assigned this Oct 26, 2020
@codecov
Copy link

codecov bot commented Oct 26, 2020

Codecov Report

Merging #1201 into main will increase coverage by 0.02%.
The diff coverage is 99.71%.

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
featuretools/__init__.py 82.85% <ø> (ø)
featuretools/feature_base/feature_descriptions.py 98.75% <98.75%> (ø)
featuretools/feature_base/api.py 100.00% <100.00%> (ø)
featuretools/primitives/base/primitive_base.py 100.00% <100.00%> (ø)
...ools/primitives/standard/aggregation_primitives.py 97.14% <100.00%> (+0.19%) ⬆️
...aturetools/primitives/standard/binary_transform.py 100.00% <100.00%> (ø)
...tools/primitives/standard/cum_transform_feature.py 100.00% <100.00%> (ø)
...retools/primitives/standard/transform_primitive.py 100.00% <100.00%> (ø)
...tests/primitive_tests/test_feature_descriptions.py 100.00% <100.00%> (ø)
...etools/tests/utils_tests/test_description_utils.py 100.00% <100.00%> (ø)
... and 5 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 eab027e...d364783. Read the comment docs.

Copy link
Contributor

@thehomebrewnerd thehomebrewnerd left a 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.

Copy link
Contributor

@thehomebrewnerd thehomebrewnerd left a 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!

Copy link
Contributor

@rwedge rwedge left a 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?

@frances-h frances-h requested a review from rwedge October 30, 2020 14:33
@frances-h frances-h requested a review from rwedge October 30, 2020 16:19
Copy link
Contributor

@rwedge rwedge left a comment

Choose a reason for hiding this comment

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

Looks good!

@frances-h frances-h merged commit 3d58577 into main Oct 30, 2020
@frances-h frances-h deleted the feature-descriptions branch October 30, 2020 16:52
@jeff-hernandez jeff-hernandez mentioned this pull request Oct 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate human-readable feature definition
3 participants