- ``data`` :raw-html:`<a id="data" title="Permalink to this parameter" href="#data">🔗︎</a>`, default = ``""``, type = string, aliases: ``train``, ``train_data``, ``train_data_file``, ``data_filename``
- ``data`` :raw-html:`<a id="data" title="Permalink to this parameter" href="#data">🔗︎</a>`, default = ``""``, type = string, aliases: ``train``, ``train_data``, ``train_data_file``, ``data_filename``
...
@@ -414,7 +414,7 @@ Learning Control Parameters
...
@@ -414,7 +414,7 @@ Learning Control Parameters
- when early stopping is used (i.e. ``early_stopping_round > 0``), require the early stopping metric to improve by at least this delta to be considered an improvement
- when early stopping is used (i.e. ``early_stopping_round > 0``), require the early stopping metric to improve by at least this delta to be considered an improvement
- *New in 4.4.0*
- *New in version 4.4.0*
- ``first_metric_only`` :raw-html:`<a id="first_metric_only" title="Permalink to this parameter" href="#first_metric_only">🔗︎</a>`, default = ``false``, type = bool
- ``first_metric_only`` :raw-html:`<a id="first_metric_only" title="Permalink to this parameter" href="#first_metric_only">🔗︎</a>`, default = ``false``, type = bool
...
@@ -692,7 +692,7 @@ Learning Control Parameters
...
@@ -692,7 +692,7 @@ Learning Control Parameters
- **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
- **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
- *New in 4.0.0*
- *New in version 4.0.0*
- ``quant_train_renew_leaf`` :raw-html:`<a id="quant_train_renew_leaf" title="Permalink to this parameter" href="#quant_train_renew_leaf">🔗︎</a>`, default = ``false``, type = bool
- ``quant_train_renew_leaf`` :raw-html:`<a id="quant_train_renew_leaf" title="Permalink to this parameter" href="#quant_train_renew_leaf">🔗︎</a>`, default = ``false``, type = bool
...
@@ -702,7 +702,7 @@ Learning Control Parameters
...
@@ -702,7 +702,7 @@ Learning Control Parameters
- **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
- **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
- *New in 4.0.0*
- *New in version 4.0.0*
- ``stochastic_rounding`` :raw-html:`<a id="stochastic_rounding" title="Permalink to this parameter" href="#stochastic_rounding">🔗︎</a>`, default = ``true``, type = bool
- ``stochastic_rounding`` :raw-html:`<a id="stochastic_rounding" title="Permalink to this parameter" href="#stochastic_rounding">🔗︎</a>`, default = ``true``, type = bool
...
@@ -710,7 +710,7 @@ Learning Control Parameters
...
@@ -710,7 +710,7 @@ Learning Control Parameters
- **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
- **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
- *New in 4.0.0*
- *New in version 4.0.0*
IO Parameters
IO Parameters
-------------
-------------
...
@@ -930,7 +930,7 @@ Dataset Parameters
...
@@ -930,7 +930,7 @@ Dataset Parameters
- **Note**: ``lightgbm-transform`` is not maintained by LightGBM's maintainers. Bug reports or feature requests should go to `issues page <https://github.com/microsoft/lightgbm-transform/issues>`__
- **Note**: ``lightgbm-transform`` is not maintained by LightGBM's maintainers. Bug reports or feature requests should go to `issues page <https://github.com/microsoft/lightgbm-transform/issues>`__
// alias = train, train_data, train_data_file, data_filename
// alias = train, train_data, train_data_file, data_filename
...
@@ -396,7 +396,7 @@ struct Config {
...
@@ -396,7 +396,7 @@ struct Config {
// check = >=0.0
// check = >=0.0
// desc = when early stopping is used (i.e. ``early_stopping_round > 0``), require the early stopping metric to improve by at least this delta to be considered an improvement
// desc = when early stopping is used (i.e. ``early_stopping_round > 0``), require the early stopping metric to improve by at least this delta to be considered an improvement
// desc = *New in 4.4.0*
// desc = *New in version 4.4.0*
doubleearly_stopping_min_delta=0.0;
doubleearly_stopping_min_delta=0.0;
// desc = LightGBM allows you to provide multiple evaluation metrics. Set this to ``true``, if you want to use only the first metric for early stopping
// desc = LightGBM allows you to provide multiple evaluation metrics. Set this to ``true``, if you want to use only the first metric for early stopping
...
@@ -626,18 +626,18 @@ struct Config {
...
@@ -626,18 +626,18 @@ struct Config {
// desc = number of bins to quantization gradients and hessians
// desc = number of bins to quantization gradients and hessians
// desc = with more bins, the quantized training will be closer to full precision training
// desc = with more bins, the quantized training will be closer to full precision training
// desc = **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
// desc = **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
// desc = *New in 4.0.0*
// desc = *New in version 4.0.0*
intnum_grad_quant_bins=4;
intnum_grad_quant_bins=4;
// desc = whether to renew the leaf values with original gradients when quantized training
// desc = whether to renew the leaf values with original gradients when quantized training
// desc = renewing is very helpful for good quantized training accuracy for ranking objectives
// desc = renewing is very helpful for good quantized training accuracy for ranking objectives
// desc = **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
// desc = **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
// desc = *New in 4.0.0*
// desc = *New in version 4.0.0*
boolquant_train_renew_leaf=false;
boolquant_train_renew_leaf=false;
// desc = whether to use stochastic rounding in gradient quantization
// desc = whether to use stochastic rounding in gradient quantization
// desc = **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
// desc = **Note**: can be used only with ``device_type = cpu`` and ``device_type=cuda``
// desc = *New in 4.0.0*
// desc = *New in version 4.0.0*
boolstochastic_rounding=true;
boolstochastic_rounding=true;
#ifndef __NVCC__
#ifndef __NVCC__
...
@@ -801,7 +801,7 @@ struct Config {
...
@@ -801,7 +801,7 @@ struct Config {
// desc = path to a ``.json`` file that specifies customized parser initialized configuration
// desc = path to a ``.json`` file that specifies customized parser initialized configuration
// desc = see `lightgbm-transform <https://github.com/microsoft/lightgbm-transform>`__ for usage examples
// desc = see `lightgbm-transform <https://github.com/microsoft/lightgbm-transform>`__ for usage examples
// desc = **Note**: ``lightgbm-transform`` is not maintained by LightGBM's maintainers. Bug reports or feature requests should go to `issues page <https://github.com/microsoft/lightgbm-transform/issues>`__
// desc = **Note**: ``lightgbm-transform`` is not maintained by LightGBM's maintainers. Bug reports or feature requests should go to `issues page <https://github.com/microsoft/lightgbm-transform/issues>`__