Skip to content

Commit 881a2d3

Browse files
basnijholtjbweston
andauthored
Update "Stopping Criteria" Runner docs
Co-authored-by: Joseph Weston <[email protected]>
1 parent 68b3143 commit 881a2d3

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/source/reference/adaptive.runner.extras.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ Runners allow you to specify the stopping criterion by providing
66
a `goal` as a function that takes the learner and returns a boolean: `False`
77
for "continue running" and `True` for "stop". This gives you a lot of flexibility
88
for defining your own stopping conditions, however we also provide some common
9-
stopping conditions as a convenience. The `adaptive.runner.auto_goal` will
10-
automatically create a goal based on simple input types, e.g., an int means
11-
at least that many points are required and a float means that the loss has
12-
to become lower or equal to that float.
9+
stopping conditions as a convenience. For example, to continue until the loss is below a threshold `x`,
10+
you may specify `loss_goal=x`. Similarly, to continue until `n` points have been sampled, you may
11+
specify `npoints_goal=n`. See the Runner docstring for details.
1312

1413
```{eval-rst}
1514
.. autofunction:: adaptive.runner.auto_goal

0 commit comments

Comments
 (0)