Update documentation / demos to use Woodwork #1466

angela97lin · 2020-11-24T18:05:00Z

Note: more work on updating graphing utils to support WW will be done in #1292; this PR only tracks updating what is necessary for our docs.

…/evalml into 1291_ww_pipeline_components_docs

codecov · 2020-11-30T18:10:08Z

Codecov Report

Merging #1466 (56e25da) into main (ed909a0) will decrease coverage by 0.1%.
The diff coverage is 100.0%.

@@            Coverage Diff            @@
##             main    #1466     +/-   ##
=========================================
- Coverage   100.0%   100.0%   -0.0%     
=========================================
  Files         227      227             
  Lines       15483    15592    +109     
=========================================
+ Hits        15476    15584    +108     
- Misses          7        8      +1

Impacted Files	Coverage Δ
...tanding/prediction_explanations/_user_interface.py	`100.0% <ø> (ø)`
evalml/objectives/objective_base.py	`100.0% <ø> (ø)`
...tive_tests/test_binary_classification_objective.py	`100.0% <ø> (ø)`
evalml/demos/breast_cancer.py	`100.0% <100.0%> (ø)`
evalml/demos/churn.py	`100.0% <100.0%> (ø)`
evalml/demos/diabetes.py	`100.0% <100.0%> (ø)`
evalml/demos/fraud.py	`100.0% <100.0%> (ø)`
evalml/demos/wine.py	`100.0% <100.0%> (ø)`
evalml/model_understanding/graphs.py	`99.7% <100.0%> (-0.3%)`	⬇️
...nderstanding/prediction_explanations/explainers.py	`100.0% <100.0%> (ø)`
... and 12 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 ed909a0...56e25da. Read the comment docs.

…/evalml into 1291_ww_pipeline_components_docs

.shape[0]

angela97lin · 2020-12-03T05:46:10Z

docs/source/demos/fraud.ipynb

@@ -26,7 +26,7 @@
   "source": [
    "## Configure \"Cost of Fraud\" \n",
    "\n",
-    "To optimize the pipelines toward the specific business needs of this model, you can set your own assumptions for the cost of fraud. These parameters are\n",
+    "To optimize the pipelines toward the specific business needs of this model, we can set our own assumptions for the cost of fraud. These parameters are\n",


For consistency, updated second person --> first person

angela97lin · 2020-12-03T05:48:29Z

evalml/demos/breast_cancer.py

 from sklearn.datasets import load_breast_cancer as load_breast_cancer_sk


-def load_breast_cancer():
+def load_breast_cancer(return_pandas=False):


I decided to go with adding a parameter because it'd still be nice to give users that flexibility (and then by default, use Woodwork), but lmk any thoughts!

@angela97lin sure that seems fine to me.

Could you please update the Returns: docstring? Same for the others. I googled and couldn't find a clear answer on what to say for Returns: but I did find this:

Returns: Union[ww.DataTable, pd.Dataframe], Union[ww.DataColumn, pd.Series]: X and y

Same comment for the other demo methods.

@dsherry Thanks! I looked at the link and am going to update this to

Union[(ww.DataTable, ww.DataColumn), (pd.Dataframe, pd.Series)]: X and y

I think this makes a bit more sense because it's more clear that it either returns two Woodwork or two pandas, but lmk if you think otherwise!

@angela97lin yep that looks good! Our sphinx API ref gen doesn't do any sort of parsing of return type currently, so I'm on board with whatever is communicative and more or less in-line with the spec :)

dsherry

@angela97lin this is huge! Left some suggestions but pretty much ready to 🚢

dsherry · 2020-12-04T18:34:19Z

evalml/demos/breast_cancer.py

 from sklearn.datasets import load_breast_cancer as load_breast_cancer_sk


-def load_breast_cancer():
+def load_breast_cancer(return_pandas=False):


@angela97lin sure that seems fine to me.

Could you please update the Returns: docstring? Same for the others. I googled and couldn't find a clear answer on what to say for Returns: but I did find this:

Returns: Union[ww.DataTable, pd.Dataframe], Union[ww.DataColumn, pd.Series]: X and y

Same comment for the other demo methods.

evalml/model_understanding/prediction_explanations/_user_interface.py

evalml/objectives/objective_base.py

evalml/preprocessing/utils.py

evalml/tests/demo_tests/test_datasets.py

docs/source/demos/fraud.ipynb

docs/source/demos/text_input.ipynb

dsherry · 2020-12-04T22:11:04Z

docs/source/demos/text_input.ipynb

@@ -240,7 +239,7 @@
   "source": [
    "## Why encode text this way?\n",
    "\n",
-    "To demonstrate the importance of text-specific modeling, let's train a model with the same dataset, without letting `AutoMLSearch` detect the text column. We can change this by explicitly setting the data type of the `'Message'` column in Woodwork."
+    "To demonstrate the importance of text-specific modeling, let's train a model with the same dataset, without letting `AutoMLSearch` detect the text column. We can change this by explicitly setting the data type of the `'Message'` column in Woodwork to `Categorical`."


Nit pick but should "categorical" be lowercase? Maybe case doesn't matter for woodwork type matching, idk

Ah I've always just used "Categorical" since that's what the actual name is but you're right, woodwork type matching doesn't matter 🤷

…/evalml into 1291_ww_pipeline_components_docs

angela97lin · 2020-12-07T23:50:48Z

(Verified docs locally since RtD is still broken)

init, change demos

bbb576c

angela97lin self-assigned this Nov 24, 2020

angela97lin added 5 commits November 24, 2020 23:10

update demos and docs

08ba9f4

Merge branch 'main' into 1291_ww_pipeline_components_docs

7984946

in progress

85880f8

Merge branch '1291_ww_pipeline_components_docs' of github.com:alteryx…

aac2f62

…/evalml into 1291_ww_pipeline_components_docs

progress for now

7976b78

angela97lin marked this pull request as draft November 26, 2020 02:57

angela97lin added this to the December 2020 milestone Nov 26, 2020

angela97lin added 6 commits November 25, 2020 21:58

Merge branch 'main' into 1291_ww_pipeline_components_docs

405c914

Merge branch 'main' into 1291_ww_pipeline_components_docs

d168050

add return pandas param

1a87893

fix some tests

c48b9ec

fix more tests

8373ea9

fix more tests

9bdf6d7

angela97lin added 14 commits November 30, 2020 13:17

fix some notebook outputs

c52e8bb

clean up more notebooks

35ceda1

Merge branch 'main' into 1291_ww_pipeline_components_docs

e39cadc

add tests for return_pandas

fb7963a

Merge branch '1291_ww_pipeline_components_docs' of github.com:alteryx…

69ef5d3

…/evalml into 1291_ww_pipeline_components_docs

update to not use gs

11558b2

.shape[0]

fix doc

640f8e9

linting

3a569b3

fix model understanding docs

4603d23

fix some tests

590c803

some more cleanup

e4cfd5d

remove list test

5ba1d00

Merge branch 'main' into 1291_ww_pipeline_components_docs

c83c645

cleanup and codecov

7f78eba

cleanup

acdaca6

angela97lin changed the title ~~Update pipeline and component documentation / demos to use Woodwork~~ Update documentation / demos to use Woodwork Dec 3, 2020

add more tests

b092368

angela97lin commented Dec 3, 2020

View reviewed changes

angela97lin added 2 commits December 3, 2020 01:32

some more cleanup

12305ad

Merge branch 'main' into 1291_ww_pipeline_components_docs

fd893c3

angela97lin marked this pull request as ready for review December 3, 2020 15:36

angela97lin requested review from dsherry, freddyaboulton, bchen1116, christopherbunn, jeremyliweishih, ParthivNaresh and eccabay December 3, 2020 15:36

Merge branch 'main' into 1291_ww_pipeline_components_docs

61b5ad4

angela97lin mentioned this pull request Dec 3, 2020

Integrate Woodwork DataTables into EvalML #1229

Closed

Merge branch 'main' into 1291_ww_pipeline_components_docs

2205003

dsherry approved these changes Dec 4, 2020

View reviewed changes

angela97lin added 7 commits December 5, 2020 01:43

Merge branch 'main' into 1291_ww_pipeline_components_docs

99726dd

clean up docstr

5aa8fe3

Merge branch '1291_ww_pipeline_components_docs' of github.com:alteryx…

4f351d5

…/evalml into 1291_ww_pipeline_components_docs

add fixture

1d859ee

Merge branch 'main' into 1291_ww_pipeline_components_docs

24c8feb

Merge branch 'main' into 1291_ww_pipeline_components_docs

55dcea8

update docstrings

56e25da

angela97lin merged commit b09ea39 into main Dec 7, 2020

angela97lin deleted the 1291_ww_pipeline_components_docs branch December 7, 2020 23:50

freddyaboulton mentioned this pull request Dec 11, 2020

Lead scoring demo search errors out #1492

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation / demos to use Woodwork #1466

Update documentation / demos to use Woodwork #1466

angela97lin commented Nov 24, 2020 •

edited

Loading

codecov bot commented Nov 30, 2020 •

edited

Loading

angela97lin Dec 3, 2020

angela97lin Dec 3, 2020 •

edited

Loading

dsherry Dec 4, 2020

angela97lin Dec 7, 2020

dsherry Dec 7, 2020

dsherry left a comment

dsherry Dec 4, 2020

dsherry Dec 4, 2020

angela97lin Dec 5, 2020

angela97lin commented Dec 7, 2020

Update documentation / demos to use Woodwork #1466

Update documentation / demos to use Woodwork #1466

Conversation

angela97lin commented Nov 24, 2020 • edited Loading

codecov bot commented Nov 30, 2020 • edited Loading

Codecov Report

angela97lin Dec 3, 2020

Choose a reason for hiding this comment

angela97lin Dec 3, 2020 • edited Loading

Choose a reason for hiding this comment

dsherry Dec 4, 2020

Choose a reason for hiding this comment

angela97lin Dec 7, 2020

Choose a reason for hiding this comment

dsherry Dec 7, 2020

Choose a reason for hiding this comment

dsherry left a comment

Choose a reason for hiding this comment

dsherry Dec 4, 2020

Choose a reason for hiding this comment

dsherry Dec 4, 2020

Choose a reason for hiding this comment

angela97lin Dec 5, 2020

Choose a reason for hiding this comment

angela97lin commented Dec 7, 2020

angela97lin commented Nov 24, 2020 •

edited

Loading

codecov bot commented Nov 30, 2020 •

edited

Loading

angela97lin Dec 3, 2020 •

edited

Loading