Browse code

update the BaseLearner's doc-string

Bas Nijholt authored on 16/10/2019 22:28:08
Showing 1 changed files
... ...
@@ -67,17 +67,14 @@ class BaseLearner(metaclass=_RequireAttrsABCMeta):
67 67
     Attributes
68 68
     ----------
69 69
     function : callable: X → Y
70
-        The function to learn.
70
+        The function to learn, the ``learner`` might modify
71
+        the original function.
71 72
     data : dict: X → Y
72 73
         `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
79 75
         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.
81 78
 
82 79
     Notes
83 80
     -----