Save xgboost model to binary file

Source: R/xgb.save.R

Save xgboost model to a file in binary format.

xgb.save(model, fname)

Arguments

model

model object of xgb.Booster class.
fname

name of the file to write.

Details

This methods allows to save a model in an xgboost-internal binary format which is universal among the various xgboost interfaces. In R, the saved model file could be read-in later using either the xgb.load function or the xgb_model parameter of xgb.train.

Note: a model can also be saved as an R-object (e.g., by using readRDS or save). However, it would then only be compatible with R, and corresponding R-methods would need to be used to load it.

See also

xgb.load, xgb.Booster.complete.

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, nrounds = 2,objective = "binary:logistic")
#> [1]	train-error:0.046522 
#> [2]	train-error:0.022263 
xgb.save(bst, 'xgb.model')
#> [1] TRUE
bst <- xgb.load('xgb.model')
if (file.exists('xgb.model')) file.remove('xgb.model')
#> [1] TRUE
pred <- predict(bst, test$data)