DOC: Be explicite about what criteria are used in GridSearchCV

GaelVaroquaux · GaelVaroquaux · commit c2680d884891 · 2011-02-24T22:28:47.000+01:00
diff --git a/scikits/learn/grid_search.py b/scikits/learn/grid_search.py
@@ -168,6 +168,15 @@ class GridSearchCV(BaseEstimator):
     GridSearchCV(n_jobs=1, fit_params={}, loss_func=None, iid=True,
            estimator=SVR(kernel='rbf', C=1.0, probability=False, ...
            ...
+
+    Notes
+    ------
+
+    The parameters selected are those that maximize the score of the
+    left out data, unless an explicit score_func is passed in which
+    case it is used instead. If a loss function loss_func is passed,
+    it overrides the score functions and is minimized.
+
     """
 
     def __init__(self, estimator, param_grid, loss_func=None, score_func=None,
