Skip to content

Commit a46481e

Browse files
committed
Specify when learner is used in auto_goal
1 parent 19bd9b3 commit a46481e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

adaptive/runner.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1023,7 +1023,8 @@ def auto_goal(
10231023
``start_time + duration``. ``duration`` can be a number
10241024
indicating the number of seconds.
10251025
learner
1026-
Learner for which to determine the goal.
1026+
Learner for which to determine the goal. Only used if the learner type
1027+
is `BalancingLearner`, `DataSaver`, `SequenceLearner`, or `IntegratorLearner`.
10271028
allow_running_forever
10281029
If True, and the goal is None and the learner is not a SequenceLearner,
10291030
then a goal that never stops is returned, otherwise an exception is raised.

0 commit comments

Comments
 (0)