xgb.dump

From xgboost v0.4-2 by Tong He

Save xgboost model to text file

Save a xgboost model to text file. Could be parsed later.

Usage

xgb.dump(model = NULL, fname = NULL, fmap = "", with.stats = FALSE)

Arguments

model: the model object.
fname: the name of the text file where to save the model text dump. If not provided or set to NULL the function will return the model as a character vector.
fmap: feature map file representing the type of feature. Detailed description could be found at https://github.com/dmlc/xgboost/wiki/Binary-Classification#dump-model. See demo/ for walkthrough example in R, and https://github.com/dmlc/xgboost/bl
with.stats: whether dump statistics of splits When this option is on, the model dump comes with two additional statistics: gain is the approximate loss function gain we get in each split; cover is the sum of second order gradient in each node.

Value

if fname is not provided or set to NULL the function will return the model as a character vector. Otherwise it will return TRUE.

Examples

data(agaricus.train, package='xgboost')
data(agaricus.test, package='xgboost')
train <- agaricus.train
test <- agaricus.test
bst <- xgboost(data = train$data, label = train$label, max.depth = 2,
               eta = 1, nthread = 2, nround = 2,objective = "binary:logistic")
# save the model in file 'xgb.model.dump'
xgb.dump(bst, 'xgb.model.dump', with.stats = TRUE)

# print the model without saving it to a file
print(xgb.dump(bst))

Documentation reproduced from package xgboost, version 0.4-2, License: Apache License (== 2.0) | file LICENSE

Community examples

Looks like there are no examples yet.