Improved description of max_iterations in documentation
#1212
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 #1212 +/- ##
=======================================
Coverage 99.92% 99.92%
=======================================
Files 196 196
Lines 12029 12029
=======================================
Hits 12020 12020
Misses 9 9 Continue to review full report at Codecov.
|
dsherry
approved these changes
Sep 26, 2020
There was a problem hiding this comment.
Thanks @christopherbunn ! Left two suggested tweaks but LGTM
docs/source/start.ipynb
Outdated
| @@ -46,6 +46,8 @@ | |||
| "source": [ | |||
| "EvalML has many options to configure the pipeline search. At the minimum, we need to define an objective function. For simplicity, we will use the F1 score in this example. However, the real power of EvalML is in using domain-specific [objective functions](user_guide/objectives.ipynb) or [building your own](user_guide/objectives.ipynb).\n", | |||
| "\n", | |||
| "In addition, EvalML provides a number of parameters to control the search process. `max_iterations` is one of the parameters which controls the stopping criterion for the AutoML search. It indicates the maximum number of pipelines to train and evaluate. In this example, `max_iterations` is set to 5. \n", | |||
There was a problem hiding this comment.
Thanks!
Can you move this below the next line "Below EvalML utilizes "? I think it reads easier. Also I suggest you delete "In addition, "
docs/source/user_guide/automl.ipynb
Outdated
| @@ -61,7 +61,7 @@ | |||
| "source": [ | |||
| "The AutoML search will log its progress, reporting each pipeline and parameter set evaluated during the search.\n", | |||
| "\n", | |||
| "By default, AutoML will search a fixed number of pipeline and parameter pairs (5). The first pipeline to be evaluated will always be a baseline model representing a trivial solution." | |||
| "There are a number of mechanisms to control the AutoML search time. One way is to set the maximum number of iterations using `max_iterations`. By default, AutoML will search a fixed number of iterations and parameter pairs (`max_iterations=5`). The first pipeline to be evaluated will always be a baseline model representing a trivial solution. " | |||
There was a problem hiding this comment.
Suggest replace "One way is to set the maximum number of iterations" with "One way is to set the maximum number of candidate models to be evaluated during AutoML"
christopherbunn
force-pushed
the
1203_max_iterations_docs
branch
from
8aa663b
to
06a59d5
Compare
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.
Resolves #1203