Skip to content
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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 13, 2023
Merged

adjusted bagging_freq parameter description #5698

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36f3a60
adjusted bagging_freq parameter description
moziada Feb 3, 2023
3ba127d
adjusted bagging_freq variable description
moziada Feb 7, 2023
7f8385d
description clarification
moziada Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:`<a id="bagging_seed" title="Permalink to this parameter" href="#bagging_seed">&#x1F517;&#xFE0E;</a>`, default = ``3``, type = int, aliases: ``bagging_fraction_seed``

Expand Down
2 changes: 1 addition & 1 deletion include/LightGBM/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Copy link
Collaborator

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.

Copy link
Contributor Author

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

Copy link
Collaborator

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

int bagging_freq = 0;

// alias = bagging_fraction_seed
Expand Down