Skip to content

Update docs for custom primitives - #1332

Merged
jeff-hernandez merged 35 commits into
mainfrom
doc_custom_naming
Feb 8, 2021
Merged

jeff-hernandez merged 35 commits into
mainfrom
doc_custom_naming

Conversation

@jeff-hernandez

Copy link
Copy Markdown
Contributor

The documentation for defining custom primitives was updated to use the class-based approach instead of the function-based approach. The updated pages are listed below:

@codecov

codecov Bot commented Feb 3, 2021 •

Copy link
Copy Markdown

Codecov Report

Merging #1332 (7272333) into main (6f7cead) will increase coverage by 0.19%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1332      +/-   ##
==========================================
+ Coverage   98.38%   98.58%   +0.19%     
==========================================
  Files         135      135              
  Lines       14496    14516      +20     
==========================================
+ Hits        14262    14310      +48     
+ Misses        234      206      -28     
Impacted Files Coverage Δ
featuretools/computational_backends/utils.py 95.54% <ø> (ø)
...mputational_backend/test_feature_set_calculator.py 100.00% <ø> (+0.36%) ⬆️
...uretools/tests/entityset_tests/test_es_metadata.py 100.00% <ø> (+0.59%) ⬆️
...eaturetools/tests/entityset_tests/test_plotting.py 100.00% <ø> (+1.63%) ⬆️
...ols/tests/synthesis/test_deep_feature_synthesis.py 99.29% <ø> (+0.13%) ⬆️
featuretools/utils/plot_utils.py 92.00% <ø> (ø)
...s/computational_backends/feature_set_calculator.py 98.70% <100.00%> (+0.01%) ⬆️
featuretools/entityset/entityset.py 98.77% <100.00%> (+0.81%) ⬆️
...utational_backend/test_calculate_feature_matrix.py 99.44% <100.00%> (+<0.01%) ⬆️
featuretools/tests/conftest.py 100.00% <100.00%> (+3.40%) ⬆️
... and 7 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 511d026...1d1bc93. Read the comment docs.

@jeff-hernandez
jeff-hernandez requested a review from rwedge February 3, 2021 21:20

@rwedge rwedge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In the advanced custom guide, let's add an example of writing custom column names for a primitive with multiple output columns

Comment thread docs/source/getting_started/primitives.ipynb Outdated
Comment thread docs/source/getting_started/primitives.ipynb Outdated
Comment thread docs/source/guides/advanced_custom_primitives.ipynb Outdated
Comment thread docs/source/guides/advanced_custom_primitives.ipynb Outdated
Comment thread docs/source/guides/advanced_custom_primitives.ipynb Outdated
Comment thread docs/source/guides/advanced_custom_primitives.ipynb Outdated
@jeff-hernandez
jeff-hernandez requested a review from rwedge February 8, 2021 18:17
Comment thread docs/source/guides/advanced_custom_primitives.ipynb Outdated
Comment thread docs/source/guides/advanced_custom_primitives.ipynb Outdated
@jeff-hernandez
jeff-hernandez requested a review from rwedge February 8, 2021 21:39

@rwedge rwedge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good!

@jeff-hernandez
jeff-hernandez merged commit a47c1a0 into main Feb 8, 2021
@jeff-hernandez
jeff-hernandez deleted the doc_custom_naming branch February 8, 2021 22:15
@gsheni gsheni mentioned this pull request Feb 26, 2021
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