Skip to content

Custom variable descriptions#1207

Merged
frances-h merged 9 commits intomainfrom
variable-descriptions
Nov 2, 2020
Merged

Custom variable descriptions#1207
frances-h merged 9 commits intomainfrom
variable-descriptions

Conversation

@frances-h
Copy link
Copy Markdown
Contributor

Allow custom descriptions to be set directly on a variable and used in feature descriptions.

  • Descriptions default to 'the "[variable name]"' and can be set with variable.description
  • Descriptions must be set prior to feature generation in order for them to propagate

@frances-h frances-h requested a review from rwedge October 30, 2020 17:20
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 30, 2020

Codecov Report

Merging #1207 into main will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1207   +/-   ##
=======================================
  Coverage   98.63%   98.63%           
=======================================
  Files         134      134           
  Lines       14284    14309   +25     
=======================================
+ Hits        14089    14114   +25     
  Misses        195      195           
Impacted Files Coverage Δ
featuretools/entityset/deserialize.py 100.00% <100.00%> (ø)
featuretools/entityset/serialize.py 100.00% <100.00%> (ø)
featuretools/feature_base/feature_descriptions.py 98.75% <100.00%> (ø)
...etools/tests/entityset_tests/test_serialization.py 99.62% <100.00%> (+<0.01%) ⬆️
...tests/primitive_tests/test_feature_descriptions.py 100.00% <100.00%> (ø)
...ests/primitive_tests/test_feature_serialization.py 99.34% <100.00%> (ø)
featuretools/variable_types/variable.py 98.80% <100.00%> (+0.05%) ⬆️

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 a8c201a...b3b4755. Read the comment docs.

Copy link
Copy Markdown
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.

do we directly test serializing a variable with a custom description?

Copy link
Copy Markdown
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.

let's document the description argument in the Variable docstring

Copy link
Copy Markdown
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 aa44c65 into main Nov 2, 2020
@frances-h frances-h deleted the variable-descriptions branch November 2, 2020 21:21
@rwedge rwedge mentioned this pull request Nov 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.

2 participants