Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve doc in predict

Browse Source
This commit is contained in:
hetong 2014-09-01 15:38:29 -07:00
parent 025ca170ec
commit b973a4dcaa
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
R-package/R/predict.xgb.Booster.R
View File

@ -12,7 +12,7 @@ setClass("xgb.Booster")
#' untransformed margin value. In logistic regression, outputmargin=T will #' untransformed margin value. In logistic regression, outputmargin=T will
#' output value before logistic transformation. #' output value before logistic transformation.
#' @param ntreelimit limit number of trees used in prediction, this parameter is only valid for gbtree, but not for gblinear. #' @param ntreelimit limit number of trees used in prediction, this parameter is only valid for gbtree, but not for gblinear.
#' set it to be value bigger than 0 #' set it to be value bigger than 0. It will use all trees by default.
#' @examples #' @examples
#' data(iris) #' data(iris)
#' bst <- xgboost(as.matrix(iris[,1:4]),as.numeric(iris[,5]), nrounds = 2) #' bst <- xgboost(as.matrix(iris[,1:4]),as.numeric(iris[,5]), nrounds = 2)

12
R-package/man/predict-xgb.Booster-method.Rd
View File

@ -4,7 +4,8 @@
\alias{predict,xgb.Booster-method} \alias{predict,xgb.Booster-method}
\title{Predict method for eXtreme Gradient Boosting model} \title{Predict method for eXtreme Gradient Boosting model}
\usage{ \usage{
\S4method{predict}{xgb.Booster}(object, newdata, outputmargin = FALSE) \S4method{predict}{xgb.Booster}(object, newdata, outputmargin = FALSE,
ntreelimit = NULL)
} }
\arguments{ \arguments{
\item{object}{Object of class "xgb.Boost"} \item{object}{Object of class "xgb.Boost"}
@ -13,9 +14,12 @@
\code{xgb.DMatrix}.} \code{xgb.DMatrix}.}
\item{outputmargin}{whether the prediction should be shown in the original \item{outputmargin}{whether the prediction should be shown in the original
value of sum of functions, when outputmargin=TRUE, the prediction is value of sum of functions, when outputmargin=TRUE, the prediction is
untransformed margin value. In logistic regression, outputmargin=T will untransformed margin value. In logistic regression, outputmargin=T will
output value before logistic transformation.} output value before logistic transformation.}
\item{ntreelimit}{limit number of trees used in prediction, this parameter is only valid for gbtree, but not for gblinear.
set it to be value bigger than 0. It will use all trees by default.}
} }
\description{ \description{
Predicted values based on xgboost model object. Predicted values based on xgboost model object.