Refine the description of is_unbalance

microsoft · Aug 1, 2019 · c17a5f5 · c17a5f5
1 parent 6c21020
commit c17a5f5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/Parameters.rst b/docs/Parameters.rst
@@ -730,7 +730,7 @@ Objective Parameters
 
 -  ``is_unbalance`` :raw-html:`<a id="is_unbalance" title="Permalink to this parameter" href="#is_unbalance">&#x1F517;&#xFE0E;</a>`, default = ``false``, type = bool, aliases: ``unbalance``, ``unbalanced_sets``
 
-   -  used only in ``binary`` application
+   -  used only in ``binary`` and ``multiclassova``
 
    -  set this to ``true`` if training data are unbalanced
 
@@ -740,7 +740,7 @@ Objective Parameters
 
 -  ``scale_pos_weight`` :raw-html:`<a id="scale_pos_weight" title="Permalink to this parameter" href="#scale_pos_weight">&#x1F517;&#xFE0E;</a>`, default = ``1.0``, type = double, constraints: ``scale_pos_weight > 0.0``
 
-   -  used only in ``binary`` application
+   -  used only in ``binary`` and ``multiclassova``
 
    -  weight of labels with positive class
 

diff --git a/include/LightGBM/config.h b/include/LightGBM/config.h
@@ -663,14 +663,14 @@ struct Config {
   int num_class = 1;
 
   // alias = unbalance, unbalanced_sets
-  // desc = used only in ``binary`` application
+  // desc = used only in ``binary`` and ``multiclassova``
   // desc = set this to ``true`` if training data are unbalanced
   // desc = **Note**: while enabling this should increase the overall performance metric of your model, it will also result in poor estimates of the individual class probabilities
   // desc = **Note**: this parameter cannot be used at the same time with ``scale_pos_weight``, choose only **one** of them
   bool is_unbalance = false;
 
   // check = >0.0
-  // desc = used only in ``binary`` application
+  // desc = used only in ``binary`` and ``multiclassova``
   // desc = weight of labels with positive class
   // desc = **Note**: while enabling this should increase the overall performance metric of your model, it will also result in poor estimates of the individual class probabilities
   // desc = **Note**: this parameter cannot be used at the same time with ``is_unbalance``, choose only **one** of them