Skip to contents

Classification Light GBM Learner

mlr_learners_classif.lightgbm.Rd

Gradient boosting algorithm. Calls lightgbm::lightgbm() from lightgbm.

Dictionary

This Learner can be instantiated via the dictionary mlr_learners or with the associated sugar function lrn():

mlr_learners$get("classif.lightgbm")
lrn("classif.lightgbm")

Meta Information

  • Task type: “classif”

  • Predict Types: “response”, “prob”

  • Feature Types: “logical”, “integer”, “numeric”, “factor”

  • Required Packages: mlr3, mlr3extralearners, lightgbm

Parameters

IdTypeDefaultLevelsRange
nroundsinteger5\([1, \infty)\)
objectivecharacterbinarybinary, multiclass, multiclassova, cross_entropy, cross_entropy_lambda, lambdarank, rank_xendcg-
metriccharacter, None, ndcg, map, auc, average_precision, binary_logloss, binary_error, auc_mu, multi_logloss, ...-
custom_evaluntyped-
verboseinteger1\((-\infty, \infty)\)
recordlogicalTRUETRUE, FALSE-
eval_freqinteger1\([1, \infty)\)
init_modeluntyped-
early_stopping_roundsinteger-\([1, \infty)\)
early_stopping_splitnumeric0\([0, 1]\)
callbacksuntyped--
reset_datalogicalFALSETRUE, FALSE-
categorical_featureuntyped-
convert_categoricallogicalTRUETRUE, FALSE-
boostingcharactergbdtgbdt, rf, dart, goss-
linear_treelogicalFALSETRUE, FALSE-
num_iterationsinteger100\([0, \infty)\)
learning_ratenumeric0.1\([0, \infty)\)
num_leavesinteger31\([1, 131072]\)
tree_learnercharacterserialserial, feature, data, voting-
num_threadsinteger0\([0, \infty)\)
device_typecharactercpucpu, gpu-
seedinteger-\((-\infty, \infty)\)
deterministiclogicalFALSETRUE, FALSE-
force_col_wiselogicalFALSETRUE, FALSE-
force_row_wiselogicalFALSETRUE, FALSE-
histogram_pool_sizeinteger-1\((-\infty, \infty)\)
max_depthinteger-1\((-\infty, \infty)\)
min_data_in_leafinteger20\([0, \infty)\)
min_sum_hessian_in_leafnumeric0.001\([0, \infty)\)
bagging_fractionnumeric1\([0, 1]\)
pos_bagging_fractionnumeric1\([0, 1]\)
neg_bagging_fractionnumeric1\([0, 1]\)
bagging_freqinteger0\([0, \infty)\)
bagging_seedinteger3\((-\infty, \infty)\)
feature_fractionnumeric1\([0, 1]\)
feature_fraction_bynodenumeric1\([0, 1]\)
feature_fraction_seedinteger2\((-\infty, \infty)\)
extra_treeslogicalFALSETRUE, FALSE-
extra_seedinteger6\((-\infty, \infty)\)
first_metric_onlylogicalFALSETRUE, FALSE-
max_delta_stepnumeric0\((-\infty, \infty)\)
lambda_l1numeric0\([0, \infty)\)
lambda_l2numeric0\([0, \infty)\)
linear_lambdanumeric0\([0, \infty)\)
min_gain_to_splitnumeric0\([0, \infty)\)
drop_ratenumeric0.1\([0, 1]\)
max_dropinteger50\((-\infty, \infty)\)
skip_dropnumeric0.5\([0, 1]\)
xgboost_dart_modelogicalFALSETRUE, FALSE-
uniform_droplogicalFALSETRUE, FALSE-
drop_seedinteger4\((-\infty, \infty)\)
top_ratenumeric0.2\([0, 1]\)
other_ratenumeric0.1\([0, 1]\)
min_data_per_groupinteger100\([1, \infty)\)
max_cat_thresholdinteger32\([1, \infty)\)
cat_l2numeric10\([0, \infty)\)
cat_smoothnumeric10\([0, \infty)\)
max_cat_to_onehotinteger4\([1, \infty)\)
top_kinteger20\([1, \infty)\)
monotone_constraintsuntyped-
monotone_constraints_methodcharacterbasicbasic, intermediate, advanced-
monotone_penaltynumeric0\([0, \infty)\)
feature_contriuntyped-
forcedsplits_filenameuntyped-
refit_decay_ratenumeric0.9\([0, 1]\)
cegb_tradeoffnumeric1\([0, \infty)\)
cegb_penalty_splitnumeric0\([0, \infty)\)
cegb_penalty_feature_lazyuntyped--
cegb_penalty_feature_coupleduntyped--
path_smoothnumeric0\([0, \infty)\)
interaction_constraintsuntyped--
input_modeluntyped-
output_modeluntypedLightGBM_model.txt-
saved_feature_importance_typeinteger0\([0, 1]\)
snapshot_freqinteger-1\((-\infty, \infty)\)
max_bininteger255\([2, \infty)\)
max_bin_by_featureuntyped-
min_data_in_bininteger3\([1, \infty)\)
bin_construct_sample_cntinteger200000\([1, \infty)\)
data_random_seedinteger1\((-\infty, \infty)\)
is_enable_sparselogicalTRUETRUE, FALSE-
enable_bundlelogicalTRUETRUE, FALSE-
use_missinglogicalTRUETRUE, FALSE-
zero_as_missinglogicalFALSETRUE, FALSE-
feature_pre_filterlogicalTRUETRUE, FALSE-
pre_partitionlogicalFALSETRUE, FALSE-
two_roundlogicalFALSETRUE, FALSE-
headerlogicalFALSETRUE, FALSE-
group_columnuntyped-
forcedbins_filenameuntyped-
save_binarylogicalFALSETRUE, FALSE-
objective_seedinteger5\((-\infty, \infty)\)
is_unbalancelogicalFALSETRUE, FALSE-
scale_pos_weightnumeric1\([0, \infty)\)
sigmoidnumeric1\([0, \infty)\)
boost_from_averagelogicalTRUETRUE, FALSE-
lambdarank_truncation_levelinteger30\([1, \infty)\)
lambdarank_normlogicalTRUETRUE, FALSE-
label_gainuntyped--
metric_freqinteger1\([1, \infty)\)
is_provide_training_metriclogicalFALSETRUE, FALSE-
eval_atuntyped:, 1, 5-
multi_error_top_kinteger1\([1, \infty)\)
auc_mu_weightsuntyped-
num_machinesinteger1\([1, \infty)\)
local_listen_portinteger12400\([1, \infty)\)
time_outinteger120\([1, \infty)\)
machine_list_filenameuntyped-
machinesuntyped-
gpu_platform_idinteger-1\((-\infty, \infty)\)
gpu_device_idinteger-1\((-\infty, \infty)\)
gpu_use_dplogicalFALSETRUE, FALSE-
num_gpuinteger1\([1, \infty)\)
start_iterationinteger0\((-\infty, \infty)\)
num_iterationinteger-1\((-\infty, \infty)\)
pred_early_stoplogicalFALSETRUE, FALSE-
pred_early_stop_freqinteger10\((-\infty, \infty)\)
pred_early_stop_marginnumeric10\((-\infty, \infty)\)
output_resultuntypedLightGBM_predict_result.txt-

Parameter Changes

  • num_threads:

    • Actual default: 0L

    • Adjusted default: 1L

    • Reason for change: Prevents accidental conflicts with future.

  • verbose:

    • Actual default: 1L

    • Adjusted default: -1L

    • Reason for change: Prevents accidental conflicts with mlr messaging system.

  • convert_categorical: Additional parameter. If this parameter is set to TRUE (default), all factor and logical columns are converted to integers and the parameter categorical_feature of lightgbm is set to those columns.

  • early_stopping_split: Additional parameter. Instead of providing the data that is used for early stopping explicitly, the parameter early_stopping_split determines the proportion of the training data that is used for early stopping. Here, stratification on the target variable is used if there is no grouping variable, as one cannot simultaneously stratify and group.

References

Ke, Guolin, Meng, Qi, Finley, Thomas, Wang, Taifeng, Chen, Wei, Ma, Weidong, Ye, Qiwei, Liu, Tie-Yan (2017). “Lightgbm: A highly efficient gradient boosting decision tree.” Advances in neural information processing systems, 30.

See also

Author

kapsner

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifLightGBM

Methods

Public methods

Inherited methods

Method new()

Creates a new instance of this R6 class.

Usage

LearnerClassifLightGBM$new()

Method importance()

The importance scores are extracted from lbg.importance.

Usage

LearnerClassifLightGBM$importance()

Returns

Named numeric().

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifLightGBM$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

learner = mlr3::lrn("classif.lightgbm")
print(learner)
#> <LearnerClassifLightGBM:classif.lightgbm>: Gradient Boosting
#> * Model: -
#> * Parameters: num_threads=1, verbose=-1, convert_categorical=TRUE
#> * Packages: mlr3, mlr3extralearners, lightgbm
#> * Predict Type: prob
#> * Feature types: numeric, integer, factor, logical
#> * Properties: importance, missings, multiclass, twoclass, weights

# available parameters:
learner$param_set$ids()
#>   [1] "nrounds"                       "objective"                    
#>   [3] "metric"                        "custom_eval"                  
#>   [5] "verbose"                       "record"                       
#>   [7] "eval_freq"                     "init_model"                   
#>   [9] "early_stopping_rounds"         "early_stopping_split"         
#>  [11] "callbacks"                     "reset_data"                   
#>  [13] "categorical_feature"           "convert_categorical"          
#>  [15] "boosting"                      "linear_tree"                  
#>  [17] "num_iterations"                "learning_rate"                
#>  [19] "num_leaves"                    "tree_learner"                 
#>  [21] "num_threads"                   "device_type"                  
#>  [23] "seed"                          "deterministic"                
#>  [25] "force_col_wise"                "force_row_wise"               
#>  [27] "histogram_pool_size"           "max_depth"                    
#>  [29] "min_data_in_leaf"              "min_sum_hessian_in_leaf"      
#>  [31] "bagging_fraction"              "pos_bagging_fraction"         
#>  [33] "neg_bagging_fraction"          "bagging_freq"                 
#>  [35] "bagging_seed"                  "feature_fraction"             
#>  [37] "feature_fraction_bynode"       "feature_fraction_seed"        
#>  [39] "extra_trees"                   "extra_seed"                   
#>  [41] "first_metric_only"             "max_delta_step"               
#>  [43] "lambda_l1"                     "lambda_l2"                    
#>  [45] "linear_lambda"                 "min_gain_to_split"            
#>  [47] "drop_rate"                     "max_drop"                     
#>  [49] "skip_drop"                     "xgboost_dart_mode"            
#>  [51] "uniform_drop"                  "drop_seed"                    
#>  [53] "top_rate"                      "other_rate"                   
#>  [55] "min_data_per_group"            "max_cat_threshold"            
#>  [57] "cat_l2"                        "cat_smooth"                   
#>  [59] "max_cat_to_onehot"             "top_k"                        
#>  [61] "monotone_constraints"          "monotone_constraints_method"  
#>  [63] "monotone_penalty"              "feature_contri"               
#>  [65] "forcedsplits_filename"         "refit_decay_rate"             
#>  [67] "cegb_tradeoff"                 "cegb_penalty_split"           
#>  [69] "cegb_penalty_feature_lazy"     "cegb_penalty_feature_coupled" 
#>  [71] "path_smooth"                   "interaction_constraints"      
#>  [73] "input_model"                   "output_model"                 
#>  [75] "saved_feature_importance_type" "snapshot_freq"                
#>  [77] "max_bin"                       "max_bin_by_feature"           
#>  [79] "min_data_in_bin"               "bin_construct_sample_cnt"     
#>  [81] "data_random_seed"              "is_enable_sparse"             
#>  [83] "enable_bundle"                 "use_missing"                  
#>  [85] "zero_as_missing"               "feature_pre_filter"           
#>  [87] "pre_partition"                 "two_round"                    
#>  [89] "header"                        "group_column"                 
#>  [91] "forcedbins_filename"           "save_binary"                  
#>  [93] "objective_seed"                "is_unbalance"                 
#>  [95] "scale_pos_weight"              "sigmoid"                      
#>  [97] "boost_from_average"            "lambdarank_truncation_level"  
#>  [99] "lambdarank_norm"               "label_gain"                   
#> [101] "metric_freq"                   "is_provide_training_metric"   
#> [103] "eval_at"                       "multi_error_top_k"            
#> [105] "auc_mu_weights"                "num_machines"                 
#> [107] "local_listen_port"             "time_out"                     
#> [109] "machine_list_filename"         "machines"                     
#> [111] "gpu_platform_id"               "gpu_device_id"                
#> [113] "gpu_use_dp"                    "num_gpu"                      
#> [115] "start_iteration"               "num_iteration"                
#> [117] "pred_early_stop"               "pred_early_stop_freq"         
#> [119] "pred_early_stop_margin"        "output_result"