From 6ca76fe784b42283281ce9fd80c73b62e7c527e5 Mon Sep 17 00:00:00 2001 From: pommedeterresautee Date: Sun, 15 Mar 2015 23:59:28 +0100 Subject: [PATCH] doc --- R-package/R/getinfo.xgb.DMatrix.R | 8 ++++---- R-package/R/setinfo.xgb.DMatrix.R | 8 ++++---- R-package/man/getinfo.Rd | 8 ++++---- R-package/man/setinfo.Rd | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/R-package/R/getinfo.xgb.DMatrix.R b/R-package/R/getinfo.xgb.DMatrix.R index 518cf10c5..26523699a 100644 --- a/R-package/R/getinfo.xgb.DMatrix.R +++ b/R-package/R/getinfo.xgb.DMatrix.R @@ -7,10 +7,10 @@ setClass('xgb.DMatrix') #' The information can be one of the following: #' #' \itemize{ -#' \item \code{label} -#' \item \code{weight} -#' \item \code{base_margin} -#' \item \code{nrow} +#' \item \code{label}: label Xgboost learn from ; +#' \item \code{weight}: to do a weight rescale ; +#' \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}. #' } #' #' @examples diff --git a/R-package/R/setinfo.xgb.DMatrix.R b/R-package/R/setinfo.xgb.DMatrix.R index 3ed2fbecc..61019d8e2 100644 --- a/R-package/R/setinfo.xgb.DMatrix.R +++ b/R-package/R/setinfo.xgb.DMatrix.R @@ -5,10 +5,10 @@ #' It can be one of the following: #' #' \itemize{ -#' \item \code{label} -#' \item \code{weight} -#' \item \code{base_margin} -#' \item \code{group} +#' \item \code{label}: label Xgboost learn from ; +#' \item \code{weight}: to do a weight rescale ; +#' \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ; +#' \item \code{group}. #' } #' #' @examples diff --git a/R-package/man/getinfo.Rd b/R-package/man/getinfo.Rd index 4f5fd71bc..618d0d44b 100644 --- a/R-package/man/getinfo.Rd +++ b/R-package/man/getinfo.Rd @@ -24,10 +24,10 @@ Get information of an xgb.DMatrix object The information can be one of the following: \itemize{ - \item \code{label} - \item \code{weight} - \item \code{base_margin} - \item \code{nrow} + \item \code{label}: label Xgboost learn from ; + \item \code{weight}: to do a weight rescale ; + \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}. } } \examples{ diff --git a/R-package/man/setinfo.Rd b/R-package/man/setinfo.Rd index 334a67b27..9512f1dfb 100644 --- a/R-package/man/setinfo.Rd +++ b/R-package/man/setinfo.Rd @@ -26,10 +26,10 @@ Set information of an xgb.DMatrix object It can be one of the following: \itemize{ - \item \code{label} - \item \code{weight} - \item \code{base_margin} - \item \code{group} + \item \code{label}: label Xgboost learn from ; + \item \code{weight}: to do a weight rescale ; + \item \code{base_margin}: base margin is the base prediction Xgboost will boost from ; + \item \code{group}. } } \examples{