Skip to content

Commit be14576

Browse files
committed
pass parameters and add doc-strings
1 parent 6f3437a commit be14576

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

adaptive/runner.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ class BaseRunner(metaclass=abc.ABCMeta):
113113
the point is present in ``runner.failed``.
114114
raise_if_retries_exceeded : bool, default: True
115115
Raise the error after a point ``x`` failed `retries`.
116+
allow_running_forever : bool, default: False
117+
Allow the runner to run forever when the goal is None.
116118
117119
Attributes
118120
----------
@@ -436,6 +438,8 @@ def __init__(
436438
goal=goal,
437439
loss_goal=loss_goal,
438440
npoints_goal=npoints_goal,
441+
datetime_goal=datetime_goal,
442+
timedelta_goal=timedelta_goal,
439443
executor=executor,
440444
ntasks=ntasks,
441445
log=log,
@@ -531,6 +535,8 @@ class AsyncRunner(BaseRunner):
531535
the point is present in ``runner.failed``.
532536
raise_if_retries_exceeded : bool, default: True
533537
Raise the error after a point ``x`` failed `retries`.
538+
allow_running_forever : bool, default: True
539+
If True, the runner will run forever if the goal is not provided.
534540
535541
Attributes
536542
----------
@@ -606,6 +612,8 @@ def __init__(
606612
goal=goal,
607613
loss_goal=loss_goal,
608614
npoints_goal=npoints_goal,
615+
datetime_goal=datetime_goal,
616+
timedelta_goal=timedelta_goal,
609617
executor=executor,
610618
ntasks=ntasks,
611619
log=log,

0 commit comments

Comments
 (0)