Skip to content

Commit d7f6b9c

Browse files
committed
Add auto_goal to the docs
1 parent fbc686c commit d7f6b9c

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@ 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.
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.
13+
14+
```{eval-rst}
15+
.. autofunction:: adaptive.runner.auto_goal
16+
```
1017

1118
```{eval-rst}
1219
.. autofunction:: adaptive.runner.stop_after

0 commit comments

Comments
 (0)