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

Update documentation about objectives in AutoML #1222

Merged
merged 9 commits into from Sep 29, 2020
Merged

Conversation

angela97lin
Copy link
Contributor

@angela97lin angela97lin commented Sep 24, 2020

Closes #1211 by clarifying in AutoMLSearch docstring and AutoML docs what the objective parameter is used for.

Updated API reference and updated automl guide

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

codecov bot commented Sep 24, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1222      +/-   ##
==========================================
+ Coverage   91.60%   99.92%   +8.32%     
==========================================
  Files         200      200              
  Lines       12468    12468              
==========================================
+ Hits        11421    12459    +1038     
+ Misses       1047        9    -1038     
Impacted Files Coverage Δ
evalml/automl/automl_search.py 99.58% <ø> (+0.41%) ⬆️
...s/prediction_explanations_tests/test_algorithms.py 100.00% <0.00%> (+1.11%) ⬆️
evalml/tests/component_tests/test_components.py 100.00% <0.00%> (+1.25%) ⬆️
evalml/tests/component_tests/test_utils.py 100.00% <0.00%> (+3.57%) ⬆️
evalml/tests/pipeline_tests/test_pipelines.py 100.00% <0.00%> (+3.71%) ⬆️
...derstanding/prediction_explanations/_algorithms.py 97.14% <0.00%> (+4.28%) ⬆️
evalml/utils/gen_utils.py 99.09% <0.00%> (+5.40%) ⬆️
evalml/pipelines/pipeline_base.py 100.00% <0.00%> (+6.14%) ⬆️
evalml/tests/utils_tests/test_dependencies.py 100.00% <0.00%> (+6.25%) ⬆️
... and 17 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 69d7a62...eccb33e. Read the comment docs.

@angela97lin angela97lin marked this pull request as ready for review Sep 24, 2020
Copy link
Contributor

@bchen1116 bchen1116 left a comment

LGTM! Docs look clean.

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

@freddyaboulton freddyaboulton left a comment

@angela97lin Looks good to me!

evalml/automl/automl_search.py Outdated Show resolved Hide resolved
@angela97lin angela97lin merged commit 08cc8aa into main Sep 29, 2020
@angela97lin angela97lin deleted the 1211_objective_docs branch Sep 29, 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.

Clarify what objective in AutoML is used for
3 participants