@@ -92,7 +92,7 @@ class BaseRunner(metaclass=abc.ABCMeta):
9292 Convenience argument, use instead of ``goal``. The end condition for the
9393 calculation. Stop when the current time is larger or equal than
9494 ``start_time + duration_goal``. ``duration_goal`` can be a number
95- indicating the number of seconds
95+ indicating the number of seconds.
9696 executor : `concurrent.futures.Executor`, `distributed.Client`,\
9797 `mpi4py.futures.MPIPoolExecutor`, `ipyparallel.Client` or\
9898 `loky.get_reusable_executor`, optional
@@ -355,14 +355,14 @@ class BlockingRunner(BaseRunner):
355355 Parameters
356356 ----------
357357 learner : `~adaptive.BaseLearner` instance
358- goal : callable
358+ goal : callable, optional
359359 The end condition for the calculation. This function must take
360360 the learner as its sole argument, and return True when we should
361361 stop requesting more points.
362- loss_goal : float
362+ loss_goal : float, optional
363363 Convenience argument, use instead of ``goal``. The end condition for the
364364 calculation. Stop when the loss is smaller than this value.
365- npoints_goal : int
365+ npoints_goal : int, optional
366366 Convenience argument, use instead of ``goal``. The end condition for the
367367 calculation. Stop when the number of points is larger or
368368 equal than this value.
@@ -374,7 +374,7 @@ class BlockingRunner(BaseRunner):
374374 Convenience argument, use instead of ``goal``. The end condition for the
375375 calculation. Stop when the current time is larger or equal than
376376 ``start_time + duration_goal``. ``duration_goal`` can be a number
377- indicating the number of seconds
377+ indicating the number of seconds.
378378 executor : `concurrent.futures.Executor`, `distributed.Client`,\
379379 `mpi4py.futures.MPIPoolExecutor`, `ipyparallel.Client` or\
380380 `loky.get_reusable_executor`, optional
@@ -505,7 +505,7 @@ class AsyncRunner(BaseRunner):
505505 the learner as its sole argument, and return True when we should
506506 stop requesting more points.
507507 If not provided, the runner will run forever (or stop when no more
508- points can be added), or until ``self .task.cancel()`` is called.
508+ points can be added), or until ``runner .task.cancel()`` is called.
509509 loss_goal : float, optional
510510 Convenience argument, use instead of ``goal``. The end condition for the
511511 calculation. Stop when the loss is smaller than this value.
@@ -827,7 +827,7 @@ def simple(
827827 Parameters
828828 ----------
829829 learner : ~`adaptive.BaseLearner` instance
830- goal : callable
830+ goal : callable, optional
831831 The end condition for the calculation. This function must take
832832 the learner as its sole argument, and return True when we should
833833 stop requesting more points.
0 commit comments