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

attemp to fix line breaking issue of doc

Browse Source
This commit is contained in:
hetong 2014-09-01 17:43:28 -07:00
parent 19887dcc37
commit 76d5fc7e78
4 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
R-package/R/xgb.dump.R
View File

@ -4,9 +4,12 @@
#'
#' @param model the model object.
#' @param fname the name of the binary file.
#' @param fmap feature map file representing the type of feature, to make it
#' look nice, run inst/examples/demo.R for result and inst/examples/featmap.txt for example
#' Format: https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model
#' @param fmap feature map file representing the type of feature.
#' Detailed description could be found at
#' \url{https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model}.
#' Run inst/examples/demo.R for the result and inst/examples/featmap.txt
#' for example Format.
#'
#'
#' @examples
#' data(iris)

9
R-package/R/xgb.train.R
View File

@ -24,10 +24,11 @@
#' watchlist=list(validation1=mat1, validation2=mat2) to watch
#' the performance of each round's model on mat1 and mat2
#'
#' @param obj customized objective function. Given prediction and dtrain,
#' return gradient and second order gradient.
#' @param feval custimized evaluation function. Given prediction and dtrain,
#' return a \code{list(metric='metric-name', value='metric-value')}.
#' @param obj customized objective function. Returns gradient and second order
#' gradient with given prediction and dtrain,
#' @param feval custimized evaluation function. Returns
#' \code{list(metric='metric-name', value='metric-value')} with given
#' prediction and dtrain,
#' @param ... other parameters to pass to \code{params}.
#'
#' @details

8
R-package/man/xgb.dump.Rd
View File

@ -10,9 +10,11 @@ xgb.dump(model, fname, fmap = "")
\item{fname}{the name of the binary file.}
\item{fmap}{feature map file representing the type of feature, to make it
look nice, run inst/examples/demo.R for result and inst/examples/featmap.txt for example
Format: https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model}
\item{fmap}{feature map file representing the type of feature.
Detailed description could be found at
\url{https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model}.
Run inst/examples/demo.R for the result and inst/examples/featmap.txt
for example Format.}
}
\description{
Save a xgboost model to text file. Could be parsed later.

9
R-package/man/xgb.train.Rd
View File

@ -32,11 +32,12 @@ xgb.train(params = list(), dtrain, nrounds, watchlist = list(),
watchlist=list(validation1=mat1, validation2=mat2) to watch
the performance of each round's model on mat1 and mat2}
\item{obj}{customized objective function. Given prediction and dtrain,
return gradient and second order gradient.}
\item{obj}{customized objective function. Returns gradient and second order
gradient with given prediction and dtrain,}
\item{feval}{custimized evaluation function. Given prediction and dtrain,
return a \code{list(metric='metric-name', value='metric-value')}.}
\item{feval}{custimized evaluation function. Returns
\code{list(metric='metric-name', value='metric-value')} with given
prediction and dtrain,}
\item{...}{other parameters to pass to \code{params}.}
}