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

Improve setinfo documentation on R package (#2357)

Browse Source
This commit is contained in:
Michaël Benesty 2017-05-30 20:08:31 +02:00 committed by GitHub
parent 433269c335
commit 8e2a1ff2bf
3 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
R-package/R/xgb.DMatrix.R
View File

@ -163,8 +163,11 @@ dimnames.xgb.DMatrix <- function(x) {
#' \item \code{weight}: to do a weight rescale ; #' \item \code{weight}: to do a weight rescale ;
#' \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ; #' \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ;
#' \item \code{nrow}: number of rows of the \code{xgb.DMatrix}. #' \item \code{nrow}: number of rows of the \code{xgb.DMatrix}.
#'
#' } #' }
#' #'
#' \code{group} can be setup by \code{setinfo} but can't be retrieved by \code{getinfo}.
#'
#' @examples #' @examples
#' data(agaricus.train, package='xgboost') #' data(agaricus.train, package='xgboost')
#' train <- agaricus.train #' train <- agaricus.train
@ -214,7 +217,7 @@ getinfo.xgb.DMatrix <- function(object, name, ...) {
#' \item \code{label}: label Xgboost learn from ; #' \item \code{label}: label Xgboost learn from ;
#' \item \code{weight}: to do a weight rescale ; #' \item \code{weight}: to do a weight rescale ;
#' \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ; #' \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ;
#' \item \code{group}. #' \item \code{group}: number of rows in each group (to use with \code{rank:pairwise} objective).
#' } #' }
#' #'
#' @examples #' @examples

3
R-package/man/getinfo.Rd
View File

@ -27,7 +27,10 @@ The \code{name} field can be one of the following:
\item \code{weight}: to do a weight rescale ; \item \code{weight}: to do a weight rescale ;
\item \code{base_margin}: base margin is the base prediction Xgboost will boost from ; \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ;
\item \code{nrow}: number of rows of the \code{xgb.DMatrix}. \item \code{nrow}: number of rows of the \code{xgb.DMatrix}.
} }
\code{group} can be setup by \code{setinfo} but can't be retrieved by \code{getinfo}.
} }
\examples{ \examples{
data(agaricus.train, package='xgboost') data(agaricus.train, package='xgboost')

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

@ -28,7 +28,7 @@ The \code{name} field can be one of the following:
\item \code{label}: label Xgboost learn from ; \item \code{label}: label Xgboost learn from ;
\item \code{weight}: to do a weight rescale ; \item \code{weight}: to do a weight rescale ;
\item \code{base_margin}: base margin is the base prediction Xgboost will boost from ; \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ;
\item \code{group}. \item \code{group}: number of rows in each group (to use with \code{rank:pairwise} objective).
} }
} }
\examples{ \examples{