[docs] unify language and make small improvements in some param descriptions #6618
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StrikerRUS
commented
Aug 18, 2024
| // descl2 = must be passed through parameters explicitly in the C API | ||
| // descl2 = **Note**: cannot be used in CLI version |
| @@ -569,7 +571,7 @@ struct Config { | |||
| // check = >= 0.0 | |||
| // desc = controls smoothing applied to tree nodes | |||
| // desc = helps prevent overfitting on leaves with few samples | |||
| // desc = if set to zero, no smoothing is applied | |||
| // desc = if ``0.0`` (the default), no smoothing is applied | |||
There was a problem hiding this comment.
Similarly to monotone_penalty, feature_pre_filter and predict_disable_shape_check
| @@ -619,24 +621,27 @@ struct Config { | |||
| // desc = enabling this will discretize (quantize) the gradients and hessians into bins of ``num_grad_quant_bins`` | |||
| // desc = with quantized training, most arithmetics in the training process will be integer operations | |||
| // desc = gradient quantization can accelerate training, with little accuracy drop in most cases | |||
| // desc = **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda`` | |||
| // desc = **Note**: works only with ``cpu`` and ``cuda`` device type | |||
There was a problem hiding this comment.
"can be used only ..." for something that is not supposed to work in other environments at all, "Note: works only ..." for something that is supposed to work in other environments but currently doesn't work (not implemented yet).
StrikerRUS
requested review from
guolinke,
jameslamb,
shiyu1994,
jmoralez and
borchero
as code owners
jameslamb
approved these changes
Aug 18, 2024
include/LightGBM/config.h
Outdated
| // desc = set this to ``true`` to use double precision math on GPU (by default single precision is used) | ||
| // desc = **Note**: can be used only in OpenCL implementation, in CUDA implementation only double precision is currently supported | ||
| bool gpu_use_dp = false; | ||
|
|
||
| // check = >0 | ||
| // desc = used only with ``cuda`` device type | ||
| // desc = number of GPUs | ||
| // desc = **Note**: can be used only in CUDA implementation |
There was a problem hiding this comment.
similar to the comment on gpu_use_dp, what do you think about combining two lines here? So we'd have:
// desc = **Note**: can be used only in CUDA implementation (``device_type="cuda"``)
|
Thanks very much for your attention to detail 😁 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.