Skip to content

Commit

Permalink
add stopping critera documentation to the 'runner.extras' page
Browse files Browse the repository at this point in the history
  • Loading branch information
jbweston committed Nov 21, 2019
1 parent 2176208 commit cf0ab59
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/source/reference/adaptive.runner.extras.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
Runner extras
=============

Stopping Criteria
-----------------

Runners allow you to specify the stopping criterion by providing
a ``goal`` as a function that takes the learner and returns a boolean: ``False``
for "continue running" and ``True`` for "stop". This gives you a lot of flexibility
for defining your own stopping conditions, however we also provide some common
stopping conditions as a convenience.

.. autofunction:: adaptive.runner.stop_after

Simple executor
---------------

Expand Down

0 comments on commit cf0ab59

Please sign in to comment.