Package index

Datasets

Datasets included with the R-package

agaricus.train

Training part from Mushroom Data Set

agaricus.test

Test 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

get_field()

Get one attribute of a lgb.Dataset

set_field()

Set one attribute of a lgb.Dataset object

lgb.Dataset()

Construct lgb.Dataset object

lgb.Dataset.construct()

Construct Dataset explicitly

lgb.Dataset.create.valid()

Construct validation data

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

lgb.convert_with_rules()

Data preparator for LightGBM datasets with rules (integer)

lgb.slice.Dataset()

Slice a dataset

Machine Learning

Train models with LightGBM and then use them to make predictions on new data

lightgbm()

Train a LightGBM model

lgb.train()

Main training logic for LightGBM

predict(<lgb.Booster>)

Predict method for LightGBM model

lgb.cv()

Main CV logic for LightGBM

lgb.configure_fast_predict()

Configure Fast Single-Row Predictions

Saving / Loading Models

Save and load LightGBM models

lgb.dump()

Dump LightGBM model to json

lgb.save()

Save LightGBM model

lgb.load()

Load LightGBM model

lgb.model.dt.tree()

Parse a LightGBM model json dump

lgb.drop_serialized()

Drop serialized raw bytes in a LightGBM model object

lgb.make_serializable()

Make a LightGBM object serializable by keeping raw bytes

lgb.restore_handle()

Restore the C++ component of a de-serialized LightGBM model

Model Interpretation

Analyze your models

lgb.get.eval.result()

Get record evaluation result from booster

lgb.importance()

Compute feature importance in a model

lgb.interpret()

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

print(<lgb.Booster>)

Print method for LightGBM model

summary(<lgb.Booster>)

Summary method for LightGBM model

Multithreading Control

Manage degree of parallelism used by LightGBM

getLGBMthreads()

Get default number of threads used by LightGBM

setLGBMthreads()

Set maximum number of threads used by LightGBM

Deprecated

Functionality that will be removed in the future

lgb.interprete()

DEPRECATED - use lgb.interpret() instead