DOC document "precomputed" kernel for KernelRidge (#11134)

wesbarnett · jnothman · commit 20cb37e8f6e1 · 2018-05-26T19:14:02.000+10:00
* document "precomputed" kernel for KernelRidge See #8445. * fix doc for KernelRidge use n_samples_fitted in score
diff --git a/sklearn/base.py b/sklearn/base.py
@@ -354,7 +354,10 @@ def score(self, X, y, sample_weight=None):
         Parameters
         ----------
         X : array-like, shape = (n_samples, n_features)
-            Test samples.
+            Test samples. For some estimators this may be a
+            precomputed kernel matrix instead, shape = (n_samples,
+            n_samples_fitted], where n_samples_fitted is the number of
+            samples used in the fitting for the estimator.
 
         y : array-like, shape = (n_samples) or (n_samples, n_outputs)
             True values for X.
diff --git a/sklearn/kernel_ridge.py b/sklearn/kernel_ridge.py
@@ -48,7 +48,9 @@ class KernelRidge(BaseEstimator, RegressorMixin):
     kernel : string or callable, default="linear"
         Kernel mapping used internally. A callable should accept two arguments
         and the keyword arguments passed to this object as kernel_params, and
-        should return a floating point number.
+        should return a floating point number. Set to "precomputed" in
+        order to pass a precomputed kernel matrix to the estimator
+        methods instead of samples.
 
     gamma : float, default=None
         Gamma parameter for the RBF, laplacian, polynomial, exponential chi2
@@ -73,7 +75,9 @@ class KernelRidge(BaseEstimator, RegressorMixin):
         Representation of weight vector(s) in kernel space
 
     X_fit_ : {array-like, sparse matrix}, shape = [n_samples, n_features]
-        Training data, which is also required for prediction
+        Training data, which is also required for prediction. If
+        kernel == "precomputed" this is instead the precomputed
+        training matrix, shape = [n_samples, n_samples].
 
     References
     ----------
@@ -130,7 +134,9 @@ def fit(self, X, y=None, sample_weight=None):
         Parameters
         ----------
         X : {array-like, sparse matrix}, shape = [n_samples, n_features]
-            Training data
+            Training data. If kernel == "precomputed" this is instead
+            a precomputed kernel matrix, shape = [n_samples,
+            n_samples].
 
         y : array-like, shape = [n_samples] or [n_samples, n_targets]
             Target values
@@ -173,7 +179,10 @@ def predict(self, X):
         Parameters
         ----------
         X : {array-like, sparse matrix}, shape = [n_samples, n_features]
-            Samples.
+            Samples. If kernel == "precomputed" this is instead a
+            precomputed kernel matrix, shape = [n_samples,
+            n_samples_fitted], where n_samples_fitted is the number of
+            samples used in the fitting for this estimator.
 
         Returns
         -------
