Update evalml docs to mention woodwork #1361
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #1361 +/- ##
=======================================
Coverage 99.95% 99.95%
=======================================
Files 213 213
Lines 13857 13857
=======================================
Hits 13850 13850
Misses 7 7 Continue to review full report at Codecov.
|
dsherry
force-pushed
the
ds_1287_woodwork_docs
branch
from
81f1509
to
d808f17
Compare
|
Docs visible here for the start page |
dsherry
force-pushed
the
ds_1287_woodwork_docs
branch
from
d808f17
to
6ccea4d
Compare
dsherry
requested review from
angela97lin,
eccabay,
gsheni,
freddyaboulton and
bchen1116
dsherry
commented
Oct 29, 2020
docs/source/start.ipynb
Outdated
| "execution_count": null, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [] |
There was a problem hiding this comment.
Oops, will delete this
gsheni
reviewed
Oct 29, 2020
docs/source/start.ipynb
Outdated
| "source": [ | ||
| "To provide data to EvalML, it is recommended that you create a `DataTable` object using [the woodwork project](https://woodwork.alteryx.com/en/stable/).\n", | ||
| "\n", | ||
| "EvalML also accepts and works well with pandas `DataFrames`. But using the `DataTable` makes it easy to control how EvalML will treat each feature, as a numeric feature, a categorical feature, a text feature or other type of feature. Woodwork `DataTable`s include features like inferring when a categorical feature should be treated as a text feature. For this reason, if you don't provide woodwork objects, EvalML will raise a warning." |
There was a problem hiding this comment.
Suggested change
| "EvalML also accepts and works well with pandas `DataFrames`. But using the `DataTable` makes it easy to control how EvalML will treat each feature, as a numeric feature, a categorical feature, a text feature or other type of feature. Woodwork `DataTable`s include features like inferring when a categorical feature should be treated as a text feature. For this reason, if you don't provide woodwork objects, EvalML will raise a warning." | |
| "EvalML also accepts and works well with pandas `DataFrames`. But using the `DataTable` makes it easy to control how EvalML will treat each feature, as a numeric feature, a categorical feature, a text feature or other type of feature. Woodwork's DataTable includes features like inferring when a categorical feature should be treated as a natural language feature. For this reason, if you don't provide woodwork objects, EvalML will raise a warning." |
There was a problem hiding this comment.
@gsheni ah right. I think we're gonna stick with "text" in evalml for the time being. Some of our classes use "text". We can have a separate conversation about that if you'd like.
I'll add in your other suggestion.
Thanks!
dsherry
force-pushed
the
ds_1287_woodwork_docs
branch
from
faecf06
to
6d87a54
Compare
gsheni
previously approved these changes
Oct 29, 2020
|
@dsherry Formating |
gsheni
reviewed
Oct 29, 2020
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #1287
Adds a mention and example to the start page and to the automl user guide page about woodwork.
This is just to start us off. Eventually I'd like us to add a page or section to the automl guide about "formatting data for automl", which shows how to set the column types using woodwork, override some of the default inference and run automl with those settings.