Browse code

update docstring

Jorn Hoofwijk authored on 12/07/2018 20:51:04
Showing 1 changed files
... ...
@@ -115,13 +115,12 @@ class LearnerND(BaseLearner):
115 115
 
116 116
     Methods
117 117
     -------
118
-    plot()
118
+    plot(n)
119 119
         If dim == 2, this method will plot the function being learned.
120
-    plot_slice((x, y, ...), n)
121
-        plot a slice of the function using the current data. If a coordinate is
122
-        passed as None, it will be used to plot. e.g. you have a 3d learner,
123
-        passing (1, None, None) will plot a 2d intersection with
124
-        x = 1, y = linspace(y_min, y_max, n), z = linspace(z_min, z_max, n).
120
+    plot_slice(cut_mapping, n)
121
+        plot a slice of the function using interpolation of the current data.
122
+        the cut_mapping contains the fixed parameters, the other parameters are
123
+        used as axes for plotting.
125 124
 
126 125
     Notes
127 126
     -----
... ...
@@ -459,7 +458,8 @@ class LearnerND(BaseLearner):
459 458
         Parameters
460 459
         ----------
461 460
         cut_mapping : dict (int -> float)
462
-            for each dimension the value
461
+            for each fixed dimension the value, the other dimensions
462
+            are interpolated
463 463
         n : int
464 464
             the number of boxes in the interpolation grid along each axis
465 465
         """