clarify DEBUG-level log about tree depth #4126
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
*TreeLearner::Train()
methods have a DEBUG-level log like this:This message is saying "ok, this tree is complete. It has
n
leaves and depthd
". I think it's confusing to refer to the depth of that tree asmax_depth
, since that is also the name of a LightGBM parameter (https://lightgbm.readthedocs.io/en/latest/Parameters.html#max_depth). When I first saw logs like this, I thought "wait, why is LightGBM changing themax_depth
parameter at each training iteration?".This PR proposes changing that language to "depth" to avoid such confusion.
Linking to #4026 (comment).