Skip to content

Commit 3c30169

Browse files
committed
update the BaseLearner's doc-string
1 parent c3e92b0 commit 3c30169

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

adaptive/learner/base_learner.py

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,14 @@ class BaseLearner(metaclass=_RequireAttrsABCMeta):
6767
Attributes
6868
----------
6969
function : callable: X → Y
70-
The function to learn.
70+
The function to learn, the ``learner`` might modify
71+
the original function.
7172
data : dict: X → Y
7273
`function` evaluated at certain points.
73-
The values can be 'None', which indicates that the point
74-
will be evaluated, but that we do not have the result yet.
75-
npoints : int, optional
76-
The number of evaluated points that have been added to the learner.
77-
Subclasses do not *have* to implement this attribute.
78-
pending_points : set, optional
74+
pending_points : set
7975
Points that have been requested but have not been evaluated yet.
80-
Subclasses do not *have* to implement this attribute.
76+
npoints : int
77+
The number of evaluated points that have been added to the learner.
8178
8279
Notes
8380
-----

0 commit comments

Comments
 (0)