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

fix doc with redirection to inst/examples

Browse Source
This commit is contained in:
hetong 2014-09-01 15:07:17 -07:00
parent 4c451de90b
commit 24e87e1cf8
7 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
R-package/DESCRIPTION
View File

@ -5,13 +5,15 @@ Version: 0.3-0
Date: 2014-08-23
Author: Tianqi Chen <tianqi.tchen@gmail.com>, Tong He <hetong007@gmail.com>
Maintainer: Tong He <hetong007@gmail.com>
Description: This package is a R wrapper of xgboost, which is short for eXtreme Gradient Boosting.
It is an efficient and scalable implementation of gradient boosting framework.
The package includes efficient linear model solver and tree learning algorithm.
The package can automatically do parallel computation with OpenMP, and it can be
more than 10 times faster than existing gradient boosting packages such as gbm.
It supports various objective functions, including regression, classification and ranking.
The package is made to be extensible, so that user are also allowed to define there own objectives easily.
Description: This package is a R wrapper of xgboost, which is short for eXtreme
Gradient Boosting. It is an efficient and scalable implementation of
gradient boosting framework. The package includes efficient linear model
solver and tree learning algorithm. The package can automatically do
parallel computation with OpenMP, and it can be more than 10 times faster
than existing gradient boosting packages such as gbm. It supports various
objective functions, including regression, classification and ranking. The
package is made to be extensible, so that user are also allowed to define
there own objectives easily.
License: Apache License (== 2.0) | file LICENSE
URL: https://github.com/tqchen/xgboost
BugReports: https://github.com/tqchen/xgboost/issues

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

@ -5,7 +5,7 @@
#' @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 demo/demo.R for result and demo/featmap.txt for example
#' 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
#'
#' @examples

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

@ -15,7 +15,7 @@
#' }
#'
#' See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for
#' further details. See also demo/demo.R for walkthrough example in R.
#' further details. See also inst/examples/demo.R for walkthrough example in R.
#' @param dtrain takes an \code{xgb.DMatrix} as the input.
#' @param nrounds the max number of iterations
#' @param watchlist what information should be printed when \code{verbose=1} or

2
R-package/R/xgboost.R
View File

@ -19,7 +19,7 @@
#' }
#'
#' See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for
#' further details. See also demo/demo.R for walkthrough example in R.
#' further details. See also inst/examples/demo.R for walkthrough example in R.
#' @param nrounds the max number of iterations
#' @param verbose If 0, xgboost will stay silent. If 1, xgboost will print
#' information of performance. If 2, xgboost will print information of both

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

@ -11,7 +11,7 @@ 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 demo/demo.R for result and demo/featmap.txt for example
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}
}
\description{

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

@ -20,7 +20,7 @@ xgb.train(params = list(), dtrain, nrounds, watchlist = list(),
}
See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for
further details. See also demo/demo.R for walkthrough example in R.}
further details. See also inst/examples/demo.R for walkthrough example in R.}
\item{dtrain}{takes an \code{xgb.DMatrix} as the input.}

2
R-package/man/xgboost.Rd
View File

@ -25,7 +25,7 @@ xgboost(data = NULL, label = NULL, params = list(), nrounds,
}
See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for
further details. See also demo/demo.R for walkthrough example in R.}
further details. See also inst/examples/demo.R for walkthrough example in R.}
\item{nrounds}{the max number of iterations}