@@ -92,7 +92,7 @@ class BaseRunner(metaclass=abc.ABCMeta):
92
92
Convenience argument, use instead of ``goal``. The end condition for the
93
93
calculation. Stop when the current time is larger or equal than
94
94
``start_time + duration_goal``. ``duration_goal`` can be a number
95
- indicating the number of seconds
95
+ indicating the number of seconds.
96
96
executor : `concurrent.futures.Executor`, `distributed.Client`,\
97
97
`mpi4py.futures.MPIPoolExecutor`, `ipyparallel.Client` or\
98
98
`loky.get_reusable_executor`, optional
@@ -355,14 +355,14 @@ class BlockingRunner(BaseRunner):
355
355
Parameters
356
356
----------
357
357
learner : `~adaptive.BaseLearner` instance
358
- goal : callable
358
+ goal : callable, optional
359
359
The end condition for the calculation. This function must take
360
360
the learner as its sole argument, and return True when we should
361
361
stop requesting more points.
362
- loss_goal : float
362
+ loss_goal : float, optional
363
363
Convenience argument, use instead of ``goal``. The end condition for the
364
364
calculation. Stop when the loss is smaller than this value.
365
- npoints_goal : int
365
+ npoints_goal : int, optional
366
366
Convenience argument, use instead of ``goal``. The end condition for the
367
367
calculation. Stop when the number of points is larger or
368
368
equal than this value.
@@ -374,7 +374,7 @@ class BlockingRunner(BaseRunner):
374
374
Convenience argument, use instead of ``goal``. The end condition for the
375
375
calculation. Stop when the current time is larger or equal than
376
376
``start_time + duration_goal``. ``duration_goal`` can be a number
377
- indicating the number of seconds
377
+ indicating the number of seconds.
378
378
executor : `concurrent.futures.Executor`, `distributed.Client`,\
379
379
`mpi4py.futures.MPIPoolExecutor`, `ipyparallel.Client` or\
380
380
`loky.get_reusable_executor`, optional
@@ -505,7 +505,7 @@ class AsyncRunner(BaseRunner):
505
505
the learner as its sole argument, and return True when we should
506
506
stop requesting more points.
507
507
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.
509
509
loss_goal : float, optional
510
510
Convenience argument, use instead of ``goal``. The end condition for the
511
511
calculation. Stop when the loss is smaller than this value.
@@ -827,7 +827,7 @@ def simple(
827
827
Parameters
828
828
----------
829
829
learner : ~`adaptive.BaseLearner` instance
830
- goal : callable
830
+ goal : callable, optional
831
831
The end condition for the calculation. This function must take
832
832
the learner as its sole argument, and return True when we should
833
833
stop requesting more points.
0 commit comments