Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pipeline user guide: include description of how to access the component instances and features #1163

Merged
merged 16 commits into from Sep 22, 2020

Conversation

angela97lin
Copy link
Contributor

@angela97lin angela97lin commented Sep 11, 2020

Closes #967. Updated docs here: https://evalml.alteryx.com/en/967_pipeline_user_guide/user_guide/pipelines.html

  • describes component_graph
  • describes .estimator accessor
  • mentions assumption that pipelines always end with an estimator
  • mentions pipeline.get_component(name) and pipeline.component_graph[idx]
  • mentions input_feature_names attribute on pipelines

Also updates pipeline guide to use Imputer instead of Simple Imputer since that's the new default for AutoML.

Note: We can't add references to the API references for component attributes until #652 is resolved.

@angela97lin angela97lin added this to the September 2020 milestone Sep 11, 2020
@angela97lin angela97lin self-assigned this Sep 11, 2020
@codecov
Copy link

codecov bot commented Sep 13, 2020

Codecov Report

Merging #1163 into main will increase coverage by 8.70%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1163      +/-   ##
==========================================
+ Coverage   91.22%   99.92%   +8.70%     
==========================================
  Files         196      196              
  Lines       11995    11995              
==========================================
+ Hits        10942    11986    +1044     
+ Misses       1053        9    -1044     
Impacted Files Coverage Δ
evalml/automl/automl_search.py 99.58% <0.00%> (+0.41%) ⬆️
evalml/tests/component_tests/test_components.py 100.00% <0.00%> (+0.51%) ⬆️
...s/prediction_explanations_tests/test_algorithms.py 100.00% <0.00%> (+1.11%) ⬆️
evalml/tests/component_tests/test_utils.py 100.00% <0.00%> (+3.57%) ⬆️
evalml/tests/pipeline_tests/test_pipelines.py 100.00% <0.00%> (+4.17%) ⬆️
...derstanding/prediction_explanations/_algorithms.py 97.14% <0.00%> (+4.28%) ⬆️
evalml/utils/gen_utils.py 99.02% <0.00%> (+5.82%) ⬆️
evalml/tests/utils_tests/test_dependencies.py 100.00% <0.00%> (+6.25%) ⬆️
evalml/pipelines/pipeline_base.py 100.00% <0.00%> (+6.32%) ⬆️
.../automl_tests/test_automl_search_classification.py 100.00% <0.00%> (+10.44%) ⬆️
... and 16 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 d42fd6e...29ebb5a. Read the comment docs.

@angela97lin angela97lin marked this pull request as ready for review Sep 15, 2020
@angela97lin angela97lin requested review from dsherry, jeremyliweishih, freddyaboulton and bchen1116 and removed request for dsherry Sep 15, 2020
Copy link
Contributor

@freddyaboulton freddyaboulton left a comment

@angela97lin Looks good to me! Left some minor comments. Nothing blocking.

docs/source/user_guide/pipelines.ipynb Outdated Show resolved Hide resolved
docs/source/user_guide/pipelines.ipynb Outdated Show resolved Hide resolved
Copy link
Contributor

@bchen1116 bchen1116 left a comment

LGTM!

docs/source/user_guide/pipelines.ipynb Show resolved Hide resolved
docs/source/user_guide/pipelines.ipynb Outdated Show resolved Hide resolved
@angela97lin angela97lin merged commit 93cd5e6 into main Sep 22, 2020
@angela97lin angela97lin deleted the 967_pipeline_user_guide branch Sep 22, 2020
@angela97lin angela97lin mentioned this pull request Sep 29, 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.

Pipeline user guide: include description of how to access the component instances and features
3 participants