[docs] document that pred_early_stop can be used only in normal and…

… raw scores prediction (#4823)
microsoft · Nov 29, 2021 · 67b4205 · 67b4205
1 parent b81f7dd
commit 67b4205
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/Parameters.rst b/docs/Parameters.rst
@@ -923,6 +923,8 @@ Predict Parameters
 
    -  used only in ``classification`` and ``ranking`` applications
 
+   -  used only for predicting normal or raw scores
+
    -  if ``true``, will use early-stopping to speed up the prediction. May affect the accuracy
 
    -  **Note**: cannot be used with ``rf`` boosting type or custom objective function

diff --git a/include/LightGBM/config.h b/include/LightGBM/config.h
@@ -776,6 +776,7 @@ struct Config {
   // [no-save]
   // desc = used only in ``prediction`` task
   // desc = used only in ``classification`` and ``ranking`` applications
+  // desc = used only for predicting normal or raw scores
   // desc = if ``true``, will use early-stopping to speed up the prediction. May affect the accuracy
   // desc = **Note**: cannot be used with ``rf`` boosting type or custom objective function
   bool pred_early_stop = false;