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

Improved description of max_iterations in documentation #1212

Merged
merged 3 commits into from Sep 28, 2020

Conversation

christopherbunn
Copy link
Contributor

@christopherbunn christopherbunn commented Sep 23, 2020

Resolves #1203

@codecov
Copy link

codecov bot commented Sep 23, 2020

Codecov Report

Merging #1212 into main will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9e6706b...06a59d5. Read the comment docs.

@christopherbunn christopherbunn marked this pull request as ready for review Sep 23, 2020
Copy link
Collaborator

@dsherry dsherry left a comment

Thanks @christopherbunn ! Left two suggested tweaks but LGTM

@@ -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",
Copy link
Collaborator

@dsherry dsherry Sep 26, 2020

Choose a reason for hiding this comment

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

Thanks!

Can you move this below the next line "Below EvalML utilizes "? I think it reads easier. Also I suggest you delete "In addition, "

@@ -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. "
Copy link
Collaborator

@dsherry dsherry Sep 26, 2020

Choose a reason for hiding this comment

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

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 christopherbunn merged commit 6bf1998 into main Sep 28, 2020
@christopherbunn christopherbunn deleted the 1203_max_iterations_docs branch Sep 28, 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.

Add description for max_iterations in user and start guide
2 participants