From 36f3a601a857cc2a712d746b4f192c54456c9507 Mon Sep 17 00:00:00 2001
From: Mohamed Ziada <60968402+moziada@users.noreply.github.com>
Date: Fri, 3 Feb 2023 22:36:12 +0200
Subject: [PATCH 1/3] adjusted bagging_freq parameter description
---
docs/Parameters.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Parameters.rst b/docs/Parameters.rst
index 45f0837d7c89..5c148da80744 100644
--- a/docs/Parameters.rst
+++ b/docs/Parameters.rst
@@ -354,7 +354,7 @@ Learning Control Parameters
- ``0`` means disable bagging; ``k`` means perform bagging at every ``k`` iteration. Every ``k``-th iteration, LightGBM will randomly select ``bagging_fraction * 100 %`` of the data to use for the next ``k`` iterations
- - **Note**: to enable bagging, ``bagging_fraction`` should be set to value smaller than ``1.0`` as well
+ - **Note**: to enable bagging, ``bagging_fraction`` should be set to a value between ``0.0`` and ``1.0``
- ``bagging_seed`` :raw-html:`🔗︎`, default = ``3``, type = int, aliases: ``bagging_fraction_seed``
From 3ba127d1593c2994c0f4b15ed19d8cac9774d52f Mon Sep 17 00:00:00 2001
From: Mohamed Ziada <60968402+moziada@users.noreply.github.com>
Date: Tue, 7 Feb 2023 16:11:05 +0200
Subject: [PATCH 2/3] adjusted bagging_freq variable description
---
include/LightGBM/config.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/LightGBM/config.h b/include/LightGBM/config.h
index b2a7112d612e..fe4b888c566c 100644
--- a/include/LightGBM/config.h
+++ b/include/LightGBM/config.h
@@ -333,7 +333,7 @@ struct Config {
// alias = subsample_freq
// desc = frequency for bagging
// desc = ``0`` means disable bagging; ``k`` means perform bagging at every ``k`` iteration. Every ``k``-th iteration, LightGBM will randomly select ``bagging_fraction * 100 %`` of the data to use for the next ``k`` iterations
- // desc = **Note**: to enable bagging, ``bagging_fraction`` should be set to value smaller than ``1.0`` as well
+ // desc = **Note**: to enable bagging, ``bagging_fraction`` should be set to a value between ``0.0`` and ``1.0``
int bagging_freq = 0;
// alias = bagging_fraction_seed
From 7f8385d0bc89197e2a7c87e1f025e697a61ef68c Mon Sep 17 00:00:00 2001
From: Mohamed
Date: Tue, 7 Feb 2023 18:18:56 +0200
Subject: [PATCH 3/3] description clarification
---
docs/Parameters.rst | 2 +-
include/LightGBM/config.h | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/Parameters.rst b/docs/Parameters.rst
index 5c148da80744..abbd8cb14e14 100644
--- a/docs/Parameters.rst
+++ b/docs/Parameters.rst
@@ -354,7 +354,7 @@ Learning Control Parameters
- ``0`` means disable bagging; ``k`` means perform bagging at every ``k`` iteration. Every ``k``-th iteration, LightGBM will randomly select ``bagging_fraction * 100 %`` of the data to use for the next ``k`` iterations
- - **Note**: to enable bagging, ``bagging_fraction`` should be set to a value between ``0.0`` and ``1.0``
+ - **Note**: bagging is only effective when ``0.0 < bagging_fraction < 1.0``
- ``bagging_seed`` :raw-html:`🔗︎`, default = ``3``, type = int, aliases: ``bagging_fraction_seed``
diff --git a/include/LightGBM/config.h b/include/LightGBM/config.h
index fe4b888c566c..cbb2735baeb2 100644
--- a/include/LightGBM/config.h
+++ b/include/LightGBM/config.h
@@ -333,7 +333,7 @@ struct Config {
// alias = subsample_freq
// desc = frequency for bagging
// desc = ``0`` means disable bagging; ``k`` means perform bagging at every ``k`` iteration. Every ``k``-th iteration, LightGBM will randomly select ``bagging_fraction * 100 %`` of the data to use for the next ``k`` iterations
- // desc = **Note**: to enable bagging, ``bagging_fraction`` should be set to a value between ``0.0`` and ``1.0``
+ // desc = **Note**: bagging is only effective when ``0.0 < bagging_fraction < 1.0``
int bagging_freq = 0;
// alias = bagging_fraction_seed