From c17a5f5b8402908da1b1dfdc74a6e40530a6ffe0 Mon Sep 17 00:00:00 2001 From: Guolin Ke Date: Thu, 1 Aug 2019 13:47:15 +0800 Subject: [PATCH] Refine the description of ``is_unbalance `` --- docs/Parameters.rst | 4 ++-- include/LightGBM/config.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Parameters.rst b/docs/Parameters.rst index 93c241bce21..afd45797b31 100644 --- a/docs/Parameters.rst +++ b/docs/Parameters.rst @@ -730,7 +730,7 @@ Objective Parameters - ``is_unbalance`` :raw-html:`🔗︎`, 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:`🔗︎`, 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 index 08b2a7352c0..671c68aa4b7 100644 --- 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