Skip to content

Commit 628152b

Browse files
committed
add extra note about performance
1 parent ad3a3cd commit 628152b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

adaptive/learner/sequence_learner.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def __setstate__(self, function):
3333

3434

3535
class SequenceLearner(BaseLearner):
36-
"""A learner that will learn a sequence.
36+
r"""A learner that will learn a sequence.
3737
3838
This is useful when your problem cannot be formulated in terms of
3939
another adaptive learner, but you still want to use Adaptive's
@@ -50,6 +50,12 @@ class SequenceLearner(BaseLearner):
5050
----------
5151
data : dict
5252
The data as a mapping from "index of element in sequence" => value.
53+
54+
Notes
55+
-----
56+
From primitive tests, the `~adaptive.SequenceLearner` appears to have a
57+
similar performance to `ipyparallel`\s `load_balanced_view().map`. With
58+
the added benefit of having results in the local kernel already.
5359
"""
5460

5561
def __init__(self, function, sequence):

0 commit comments

Comments
 (0)