Remove max_pipelines parameter from AutoMLSearch
#1264
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1264 +/- ##
==========================================
- Coverage 99.94% 99.94% -0.01%
==========================================
Files 213 213
Lines 13436 13425 -11
==========================================
- Hits 13429 13418 -11
Misses 7 7
Continue to review full report at Codecov.
|
| .. warning:: | ||
|
|
||
| **Breaking Changes** | ||
| * ``max_pipelines`` parameter has been removed from ``AutoMLSearch``. Please use ``max_iterations`` instead. :pr:`1264` |
| caplog.clear() | ||
| search = AutoMLSearch(problem_type='binary', max_iterations=10, max_pipelines=5) | ||
| assert "`max_pipelines` will be deprecated in the next release. Use `max_iterations` instead." in caplog.text | ||
| assert search.max_iterations == 10 |
There was a problem hiding this comment.
I liked this pattern, we should keep this in mind for future breaking changes!
| if max_pipelines: | ||
| if not max_iterations: | ||
| max_iterations = max_pipelines | ||
| logger.warning("`max_pipelines` will be deprecated in the next release. Use `max_iterations` instead.") |
There was a problem hiding this comment.
Food for future thought: I do wonder if we should have used python warnings here instead of / in addition to our logger
There was a problem hiding this comment.
Yeah, I agree, could have been useful to do it in addition to logging so that it's much more visible to the user.
There was a problem hiding this comment.
What's the benefit of doing both? With the way the logger is defined now, logger.warning shows up in stdout.
There was a problem hiding this comment.
I personally think the logger is too easy to miss compared to the python warning:
|
@dsherry I cleaned up the merge conflict but will need you to merge since codecov is failing 😢 |
|
@angela97lin thanks for updating branch, merging shortly |
docs/source/release_notes.rst
Outdated
| @@ -38,6 +39,12 @@ Release Notes | |||
| * Renamed ``LabelLeakageDataCheck`` to ``TargetLeakageDataCheck`` :pr:`1319` | |||
|
|
|||
|
|
|||
| .. warning:: | |||
There was a problem hiding this comment.
@angela97lin can you merge this breaking change entry in with the breaking changes section above? I think this got missed during branch update
There was a problem hiding this comment.
Yup! Updating docs and cleaning up some other doc stuff right now. Will update when this is good to go!
There was a problem hiding this comment.
|
Ok, merging! |
Closes #1201
Codecov fails because there are some lines in
automl_search.pythat are not tested and I'm decreasing the total number of lines in the file.