Reference

Dataset

Datasets included with the R package

agaricus.test

Test part from Mushroom Data Set

agaricus.train

Training part from Mushroom Data Set

bank

Bank Marketing Data Set

Data Input / Output

Data I/O required for LightGBM

dim(<lgb.Dataset>)

Dimensions of an lgb.Dataset

dimnames(<lgb.Dataset>) `dimnames<-`(<lgb.Dataset>)

Handling of column names of lgb.Dataset

getinfo()

Get information of an lgb.Dataset object

setinfo()

Set information of an lgb.Dataset object

slice()

Slice a dataset

lgb.Dataset.construct()

Construct Dataset explicitly

lgb.Dataset.create.valid()

Construct validation data

lgb.Dataset()

Construct lgb.Dataset object

lgb.Dataset.save()

Save lgb.Dataset to a binary file

lgb.Dataset.set.categorical()

Set categorical feature of lgb.Dataset

lgb.Dataset.set.reference()

Set reference of lgb.Dataset

Machine Learning

Train models with LightGBM

lgb.prepare()

Data preparator for LightGBM datasets (numeric)

lgb.prepare2()

Data preparator for LightGBM datasets (integer)

lgb.prepare_rules()

Data preparator for LightGBM datasets with rules (numeric)

lgb.prepare_rules2()

Data preparator for LightGBM datasets with rules (integer)

lgb.cv()

Main CV logic for LightGBM

lgb.train()

Main training logic for LightGBM

Saving / Loading Models

Save and Load LightGBM models

lgb.dump()

Dump LightGBM model to json

lgb.load()

Load LightGBM model

lgb.model.dt.tree()

Parse a LightGBM model json dump

lgb.save()

Save LightGBM model

predict(<lgb.Booster>)

Predict method for LightGBM model

readRDS.lgb.Booster()

readRDS for lgb.Booster models

saveRDS.lgb.Booster()

saveRDS for lgb.Booster models

Predictive Analysis

Analyze your predictions

lgb.get.eval.result()

Get record evaluation result from booster

lgb.importance()

Compute feature importance in a model

lgb.interprete()

Compute feature contribution of prediction

lgb.plot.importance()

Plot feature importance as a bar graph

lgb.plot.interpretation()

Plot feature contribution as a bar graph

Miscellaneous

Ungroupable functions to troubleshoot LightGBM

lgb.unloader()

LightGBM unloading error fix