Skip to content

Commit cf0ab59

Browse files
committed
add stopping critera documentation to the 'runner.extras' page
1 parent 2176208 commit cf0ab59

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
Runner extras
22
=============
33

4+
Stopping Criteria
5+
-----------------
6+
7+
Runners allow you to specify the stopping criterion by providing
8+
a ``goal`` as a function that takes the learner and returns a boolean: ``False``
9+
for "continue running" and ``True`` for "stop". This gives you a lot of flexibility
10+
for defining your own stopping conditions, however we also provide some common
11+
stopping conditions as a convenience.
12+
13+
.. autofunction:: adaptive.runner.stop_after
14+
415
Simple executor
516
---------------
617

0 commit comments

Comments
 (0)