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 AutoClassificationSearch docstring with correct command #599

Merged
merged 5 commits into from
Apr 8, 2020

Conversation

gsheni
Copy link
Contributor

@gsheni gsheni commented Apr 8, 2020

Pull Request Description

@gsheni gsheni self-assigned this Apr 8, 2020
@gsheni gsheni changed the title Update AutoClassificationSearch docstring with correct command [WIP] Update AutoClassificationSearch docstring with correct command Apr 8, 2020
@gsheni gsheni changed the title [WIP] Update AutoClassificationSearch docstring with correct command Update AutoClassificationSearch docstring with correct command Apr 8, 2020
Copy link
Collaborator

@jeremyliweishih jeremyliweishih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! What do you think about standardizing the docstring so that it's the same on AutoRegressionSearch? Right now it only mentions the regression option.

@codecov
Copy link

codecov bot commented Apr 8, 2020

Codecov Report

Merging #599 into master will increase coverage by 0.38%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #599      +/-   ##
==========================================
+ Coverage   98.49%   98.87%   +0.38%     
==========================================
  Files         118      118              
  Lines        4453     4453              
==========================================
+ Hits         4386     4403      +17     
+ Misses         67       50      -17     
Impacted Files Coverage Δ
evalml/automl/auto_classification_search.py 100.00% <ø> (ø)
...ts/automl_tests/test_auto_classification_search.py 100.00% <0.00%> (+0.74%) ⬆️
evalml/automl/auto_base.py 96.19% <0.00%> (+1.03%) ⬆️
evalml/tests/component_tests/test_components.py 100.00% <0.00%> (+1.25%) ⬆️
evalml/tests/pipeline_tests/test_pipelines.py 99.63% <0.00%> (+1.83%) ⬆️
.../tests/automl_tests/test_auto_regression_search.py 100.00% <0.00%> (+2.06%) ⬆️
evalml/tests/component_tests/test_utils.py 96.42% <0.00%> (+3.57%) ⬆️
evalml/tests/utils_tests/test_dependencies.py 100.00% <0.00%> (+12.50%) ⬆️

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 56aa951...4703f11. Read the comment docs.

@gsheni gsheni added documentation Improvements or additions to documentation bug Issues tracking problems with existing features. labels Apr 8, 2020
@gsheni
Copy link
Contributor Author

gsheni commented Apr 8, 2020

Looks good! What do you think about standardizing the docstring so that it's the same on AutoRegressionSearch? Right now it only mentions the regression option.

I think leave them different. The reason is because AutoClassificationSearch class shouldn't mention regression and vice versa. I fixed my PR to address this.

We can change the list_model_families to better explain the options if you want.

@gsheni gsheni merged commit 9b97358 into master Apr 8, 2020
@gsheni gsheni deleted the fix_automl_docstring branch April 8, 2020 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues tracking problems with existing features. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AutoClassificationSearch allowed_model_familieis docstring incorrect
2 participants