2b5b96d760
* [R] xgb.save must work when handle in nil but raw exists * [R] print.xgb.Booster should still print other info when handle is nil * [R] rename internal function xgb.Booster to xgb.Booster.handle to make its intent clear * [R] rename xgb.Booster.check to xgb.Booster.complete and make it visible; more docs * [R] storing evaluation_log should depend only on watchlist, not on verbose * [R] reduce the excessive chattiness of unit tests * [R] only disable some tests in windows when it's not 64-bit * [R] clean-up xgb.DMatrix * [R] test xgb.DMatrix loading from libsvm text file * [R] store feature_names in xgb.Booster, use them from utility functions * [R] remove non-functional co-occurence computation from xgb.importance * [R] verbose=0 is enough without a callback * [R] added forgotten xgb.Booster.complete.Rd; cran check fixes * [R] update installation instructions
57 lines
1.9 KiB
R
57 lines
1.9 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/xgb.dump.R
|
|
\name{xgb.dump}
|
|
\alias{xgb.dump}
|
|
\title{Dump an xgboost model in text format.}
|
|
\usage{
|
|
xgb.dump(model = NULL, fname = NULL, fmap = "", with_stats = FALSE,
|
|
dump_format = c("text", "json"), ...)
|
|
}
|
|
\arguments{
|
|
\item{model}{the model object.}
|
|
|
|
\item{fname}{the name of the text file where to save the model text dump.
|
|
If not provided or set to \code{NULL}, the model is returned as a \code{character} vector.}
|
|
|
|
\item{fmap}{feature map file representing feature types.
|
|
Detailed description could be found at
|
|
\url{https://github.com/dmlc/xgboost/wiki/Binary-Classification#dump-model}.
|
|
See demo/ for walkthrough example in R, and
|
|
\url{https://github.com/dmlc/xgboost/blob/master/demo/data/featmap.txt}
|
|
for example Format.}
|
|
|
|
\item{with_stats}{whether to dump some additional statistics about the splits.
|
|
When this option is on, the model dump contains two additional values:
|
|
gain is the approximate loss function gain we get in each split;
|
|
cover is the sum of second order gradient in each node.}
|
|
|
|
\item{dump_format}{either 'text' or 'json' format could be specified.}
|
|
|
|
\item{...}{currently not used}
|
|
}
|
|
\value{
|
|
If fname is not provided or set to \code{NULL} the function will return the model
|
|
as a \code{character} vector. Otherwise it will return \code{TRUE}.
|
|
}
|
|
\description{
|
|
Dump an xgboost model in text format.
|
|
}
|
|
\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")
|
|
# 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, with_stats = TRUE))
|
|
|
|
# print in JSON format:
|
|
cat(xgb.dump(bst, with_stats = TRUE, dump_format='json'))
|
|
|
|
}
|
|
|