Unverified Commit 28dc333d authored by Nikita Titov's avatar Nikita Titov Committed by GitHub
Browse files

[docs] fixed params description (#2306)

parent 0197dba0
...@@ -730,7 +730,7 @@ Objective Parameters ...@@ -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`` - ``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`` and ``multiclassova`` - used only in ``binary`` and ``multiclassova`` applications
- set this to ``true`` if training data are unbalanced - set this to ``true`` if training data are unbalanced
...@@ -740,7 +740,7 @@ Objective Parameters ...@@ -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`` - ``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`` and ``multiclassova`` - used only in ``binary`` and ``multiclassova`` applications
- weight of labels with positive class - weight of labels with positive class
...@@ -756,7 +756,7 @@ Objective Parameters ...@@ -756,7 +756,7 @@ Objective Parameters
- ``boost_from_average`` :raw-html:`<a id="boost_from_average" title="Permalink to this parameter" href="#boost_from_average">&#x1F517;&#xFE0E;</a>`, default = ``true``, type = bool - ``boost_from_average`` :raw-html:`<a id="boost_from_average" title="Permalink to this parameter" href="#boost_from_average">&#x1F517;&#xFE0E;</a>`, default = ``true``, type = bool
- used only in ``regression``, ``binary`` and ``cross-entropy`` applications - used only in ``regression``, ``binary``, ``multiclassova`` and ``cross-entropy`` applications
- adjusts initial score to the mean of labels for faster convergence - adjusts initial score to the mean of labels for faster convergence
......
...@@ -663,14 +663,14 @@ struct Config { ...@@ -663,14 +663,14 @@ struct Config {
int num_class = 1; int num_class = 1;
// alias = unbalance, unbalanced_sets // alias = unbalance, unbalanced_sets
// desc = used only in ``binary`` and ``multiclassova`` // desc = used only in ``binary`` and ``multiclassova`` applications
// desc = set this to ``true`` if training data are unbalanced // 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**: 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 // desc = **Note**: this parameter cannot be used at the same time with ``scale_pos_weight``, choose only **one** of them
bool is_unbalance = false; bool is_unbalance = false;
// check = >0.0 // check = >0.0
// desc = used only in ``binary`` and ``multiclassova`` // desc = used only in ``binary`` and ``multiclassova`` applications
// desc = weight of labels with positive class // 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**: 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 // desc = **Note**: this parameter cannot be used at the same time with ``is_unbalance``, choose only **one** of them
...@@ -681,7 +681,7 @@ struct Config { ...@@ -681,7 +681,7 @@ struct Config {
// desc = parameter for the sigmoid function // desc = parameter for the sigmoid function
double sigmoid = 1.0; double sigmoid = 1.0;
// desc = used only in ``regression``, ``binary`` and ``cross-entropy`` applications // desc = used only in ``regression``, ``binary``, ``multiclassova`` and ``cross-entropy`` applications
// desc = adjusts initial score to the mean of labels for faster convergence // desc = adjusts initial score to the mean of labels for faster convergence
bool boost_from_average = true; bool boost_from_average = true;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment