refactor dump function to adapt to the new possibilities of exporting a String

This commit is contained in:
El Potaeto
2015-01-09 00:14:01 +01:00
parent 6fd8bbe71a
commit 3e1eea0eea
4 changed files with 21 additions and 9 deletions

View File

@@ -4,12 +4,12 @@
\alias{xgb.dump}
\title{Save xgboost model to text file}
\usage{
xgb.dump(model, fname, fmap = "", with.stats = FALSE)
xgb.dump(model, fname = NULL, fmap = "", with.stats = FALSE)
}
\arguments{
\item{model}{the model object.}
\item{fname}{the name of the binary file.}
\item{fname}{the name of the text file where to save the model. If not provided or set to \code{NULL} the function will return the model as a \code{character} vector.}
\item{fmap}{feature map file representing the type of feature.
Detailed description could be found at
@@ -23,6 +23,9 @@ for example Format.}
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 \code{NULL} the function will return the model as a \code{character} vector. Otherwise it will return \code{TRUE}.
}
\description{
Save a xgboost model to text file. Could be parsed later.
}