-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
adjusted bagging_freq parameter description #5698
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your interest in LightGBM and for taking the time to modify the documentation.
I'm ok with this change to the docs. However, we have a slightly different process for modifying the Parameters
documentation page.
Please modify this:
LightGBM/include/LightGBM/config.h
Line 336 in 4f47547
// desc = **Note**: to enable bagging, ``bagging_fraction`` should be set to value smaller than ``1.0`` as well |
Then run this from the root of the repo
python helpers/parameter_generator.py
and commit the resulting changes.
In the future, I strongly recommend making pull requests from a new branch on your fork, instead of the target repo's default branch (master
, in LightGBM's case). This project uses squash-merging, so master
on your fork and master
here in the main repository are going to have different histories now that you've created a pull request from master
in your fork.
Once this pull request is merged, I recommend deleting your fork of LightGBM and then re-forking if you want to make further contributions here.
Hi James, |
agree |
include/LightGBM/config.h
Outdated
@@ -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`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we maybe change the wording a bit? The original intent is to clarify that bagging_fraction=1.0
disables bagging. Between usually means inclusive on both sides, but this param should be greater than 0 and less than 1 to enable it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we maybe change the wording a bit? The original intent is to clarify that
bagging_fraction=1.0
disables bagging. Between usually means inclusive on both sides, but this param should be greater than 0 and less than 1 to enable it.
Clarification is made
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Can you please also sign the CLA? You need to post a single comment like the examples that were shown in #5698 (comment), for example
@microsoft-github-policy-service agree
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure
@microsoft-github-policy-service agree |
Thanks for doing that! That's because you'd already manually changed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
works for me, thanks!
Looks like all of @jmoralez 's suggestions have been addressed, so I'm going to merge this. Thanks for taking the time to contribute 👋🏻 |
This pull request has been automatically locked since there has not been any recent activity since it was closed. |
No description provided.