Add DateToHoliday transform primitive #1848

dvreed77 · 2022-01-18T21:52:34Z

Fixes Add DateToHoliday primitive #1846

CLAassistant · 2022-01-18T21:52:38Z

All committers have signed the CLA.

thehomebrewnerd · 2022-01-18T22:17:10Z

dev-requirements.txt

 nlp_primitives>=2.0.0
 autonormalize >= 1.0.2
 -r koalas-requirements.txt
+holidays>=0.12


You are going to want this to be in requirements.txt as most users wouldn't install the requirements in dev-requirements.txt - those are primarily for developers contributing to the codebase.

yes, of course. It should be in both place tho, correct?

@dvreed77 This requirement only needs to be in one place. The typical path for installing requirements for development would be to run make installdeps. After upgrading pip, that make command then installs featuretools in editable mode, and that process will grab everything from requirements.txt. Finally, the requirements from dev-requirements.txt are installed by the make command, which also includes references to the test-requirements.txt and koalas-requirements.txt files, so essentially make installdeps installs everything found in all of our requirements files.

@thehomebrewnerd should I update contributing.md to run make installdeps? Guide currently has this:

virtualenv venv source venv/bin/activate python -m pip install -e . python -m pip install -r dev-requirements.txt

Yeah, I think we should replace the python* commands with make installdeps. The only real difference is that make installdeps will also make sure pip is upgraded first, which should be a good thing to have first.

@thehomebrewnerd I added holiday package back to dev-requirements because it looks like github actions uses this for install before running unit tests

I still think this should be removed from dev requirements and should be covered by the other requirements installs.

thehomebrewnerd · 2022-01-18T22:19:17Z

docs/source/release_notes.rst

    * Fixes
    * Changes
        * Add autonormalize as an add-on library (:pr:`1840`)
+        * Add Date to Holiday Transform Primitive (:pr: `1846`)


Minor detail here, but I would stylize this as DateToHoliday - use the class name without spaces. See line 24 below for an example. Also be sure to add your username to the list of contributors to the release on line 19.

codecov · 2022-01-19T14:39:04Z

Codecov Report

Merging #1848 (a3ab9cf) into main (d2bb3b4) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1848   +/-   ##
=======================================
  Coverage   98.79%   98.79%           
=======================================
  Files         142      143    +1     
  Lines       15850    15916   +66     
=======================================
+ Hits        15659    15725   +66     
  Misses        191      191

Impacted Files	Coverage Δ
...retools/primitives/standard/transform_primitive.py	`100.00% <100.00%> (ø)`
...s/primitive_tests/test_datetoholiday_primitives.py	`100.00% <100.00%> (ø)`

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 d2bb3b4...a3ab9cf. Read the comment docs.

docs/source/release_notes.rst

thehomebrewnerd · 2022-01-19T15:43:07Z

featuretools/tests/requirement_files/minimum_test_requirements.txt

 composeml==0.3.0
 urllib3==1.26.5
 pyarrow==3.0.0
+holidays>=0.12


Hmm...I don't think you should need this here. These should just be packages that are needed for running the tests, but not already included in the other requirements files .

This test was failing

last line does a pip instal from minimum_test_requirements.txt

I think the holidays install for these tests should get handled a little lower in this file. It will try to install requirements from minimum_core_requirements.txt or minimum_koalas_requirements.txt depending on the version of the test being run, so as long as you have holidays included in those two files I think you should be good.

One other point of clarification here, in the minimum_test*.txt files, we will want to pin the version to a specific number to make sure we always get that lowest version installed, instead of using >=version syntax which would allow newer versions to be installed.

thehomebrewnerd

Just a couple small things yet to clean up, but overall looking good.

thehomebrewnerd · 2022-01-19T18:47:26Z

docs/source/release_notes.rst

    * Fixes
    * Changes
        * Add autonormalize as an add-on library (:pr:`1840`)
+        * Add DateToHoliday Transform Primitive (:pr:`1848`)


You should add your username to the list of contributors on line 19.

thehomebrewnerd · 2022-01-19T18:48:51Z

dev-requirements.txt

 nlp_primitives>=2.0.0
 autonormalize >= 1.0.2
 -r koalas-requirements.txt
+holidays>=0.12


I still think this should be removed from dev requirements and should be covered by the other requirements installs.

gsheni · 2022-01-19T18:52:10Z

featuretools/tests/primitive_tests/test_datetoholiday_primitives.py

+    assert holiday_series[0] == "New Year's Day"
+    assert np.isnan(holiday_series[1])
+    assert holiday_series[2] == "Memorial Day"
+    assert holiday_series[3] == "Independence Day"


Do we want to add some additional tests?

def test_nat(self): primitive_instance = self.primitive() primitive_func = primitive_instance.get_function() case = pd.Series([ '2019-10-14', 'NaT', '2016-02-15', 'NaT', ]).astype('datetime64') answer = ['Columbus Day', np.nan, "Washington's Birthday", np.nan] given_answer = primitive_func(case).astype('str') np.testing.assert_array_equal(given_answer, answer) def test_valid_country(self): primitive_instance = self.primitive(country='Canada') primitive_func = primitive_instance.get_function() case = pd.Series([ '2016-07-01', '2016-11-11', '2017-12-26', '2018-09-03', ]).astype('datetime64') answer = ['Canada Day', np.nan, 'Boxing Day', 'Labour Day'] given_answer = primitive_func(case).astype('str') np.testing.assert_array_equal(given_answer, answer) def test_multiple_countries(self): primitive_mexico = self.primitive(country='Mexico') primitive_func = primitive_mexico.get_function() case = pd.Series([datetime(2000, 9, 16), datetime(2005, 1, 1)]) assert len(primitive_func(case)) > 1 primitive_india = self.primitive(country='IND') primitive_func = primitive_mexico.get_function() case = pd.Series([datetime(2048, 1, 1), datetime(2048, 10, 2)]) primitive_func = primitive_india.get_function() assert len(primitive_func(case)) > 1 primitive_uk = self.primitive(country='UK') primitive_func = primitive_uk.get_function() case = pd.Series([datetime(2048, 3, 17), datetime(2048, 4, 6)]) assert len(primitive_func(case)) > 1 countries = ['Argentina', 'AU', 'Austria', 'BY', 'Belgium', 'Brazil', 'Canada', 'Colombia', 'Croatia', 'England', 'Finland', 'FRA', 'Germany', 'Germany', 'Italy', 'NewZealand', 'PortugalExt', 'PTE', 'Spain', 'ES', 'Switzerland', 'UnitedStates', 'US', 'UK', 'UA', 'CH', 'SE', 'ZA'] for x in countries: self.primitive(country=x)

yes, thank you

thehomebrewnerd

LGTM!

Dave Reed added 4 commits January 18, 2022 14:55

copied datetoholiday primitive over from premium-primitives

7be8b6a

added more tests

c262f43

fixed nan check

bce05f2

updated release notes

de4cc19

dvreed77 requested review from gsheni and rwedge January 18, 2022 21:52

dvreed77 self-assigned this Jan 18, 2022

gsheni requested a review from a team January 18, 2022 21:53

gsheni changed the title ~~1846 date to holiday~~ Add DateToHoliday transform primitive Jan 18, 2022

removed print statement

7fb2e17

thehomebrewnerd reviewed Jan 18, 2022

View reviewed changes

Dave Reed added 2 commits January 19, 2022 09:03

added holidays to requirements.txt. Fixed linting issues

0147659

removed holidays from dev-requirements

bf5a3a4

Dave Reed added 2 commits January 19, 2022 09:51

added holidays to minimum_core_requirements.txt

3de6b4c

updated contrbuting guide

18149e3

tamargrey reviewed Jan 19, 2022

View reviewed changes

docs/source/release_notes.rst Outdated Show resolved Hide resolved

Dave Reed added 3 commits January 19, 2022 10:22

added holidays back to dev-requirements

4493416

removed space

e05e249

added holidays to minimum_test_requirements

91c00c1

thehomebrewnerd reviewed Jan 19, 2022

View reviewed changes

Dave Reed added 2 commits January 19, 2022 11:03

moved holidays to koalas requirements

cc9a8fe

additional test to cover error case

59e665e

dvreed77 requested review from tamargrey and thehomebrewnerd January 19, 2022 17:56

thehomebrewnerd reviewed Jan 19, 2022

View reviewed changes

gsheni reviewed Jan 19, 2022

View reviewed changes

added additional tests

a3ab9cf

dvreed77 requested review from gsheni and thehomebrewnerd January 19, 2022 20:29

gsheni approved these changes Jan 19, 2022

View reviewed changes

thehomebrewnerd approved these changes Jan 19, 2022

View reviewed changes

dvreed77 merged commit 22bc381 into main Jan 19, 2022

dvreed77 deleted the 1846-date-to-holiday branch January 19, 2022 21:10

dvreed77 mentioned this pull request Feb 11, 2022

v1.5.0 #1901

Merged

Add DateToHoliday transform primitive #1848

Add DateToHoliday transform primitive #1848

Uh oh!

Conversation

dvreed77 commented Jan 18, 2022 • edited by gsheni Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Jan 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jan 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thehomebrewnerd Jan 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thehomebrewnerd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gsheni Jan 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thehomebrewnerd left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dvreed77 commented Jan 18, 2022 •

edited by gsheni

Loading

CLAassistant commented Jan 18, 2022 •

edited

Loading

codecov bot commented Jan 19, 2022 •

edited

Loading

thehomebrewnerd Jan 19, 2022 •

edited

Loading

gsheni Jan 19, 2022 •

edited

Loading