From 203c72529908109bd98e3df644b64ccaf602d9c3 Mon Sep 17 00:00:00 2001 From: Jiaming Yuan Date: Tue, 28 Sep 2021 11:46:24 +0800 Subject: [PATCH] [R] Fix document for `nthread`. (#7263) --- R-package/R/xgb.DMatrix.R | 1 + R-package/man/xgb.DMatrix.Rd | 11 ++++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/R-package/R/xgb.DMatrix.R b/R-package/R/xgb.DMatrix.R index 3ff0fae4f3aa..f6155d1a9fda 100644 --- a/R-package/R/xgb.DMatrix.R +++ b/R-package/R/xgb.DMatrix.R @@ -11,6 +11,7 @@ #' @param missing a float value to represents missing values in data (used only when input is a dense matrix). #' It is useful when a 0 or some other extreme value represents missing values in data. #' @param silent whether to suppress printing an informational message after loading from a file. +#' @param nthread Number of threads used for creating DMatrix. #' @param ... the \code{info} data could be passed directly as parameters, without creating an \code{info} list. #' #' @examples diff --git a/R-package/man/xgb.DMatrix.Rd b/R-package/man/xgb.DMatrix.Rd index 32bd150660c1..df99776530e1 100644 --- a/R-package/man/xgb.DMatrix.Rd +++ b/R-package/man/xgb.DMatrix.Rd @@ -4,7 +4,14 @@ \alias{xgb.DMatrix} \title{Construct xgb.DMatrix object} \usage{ -xgb.DMatrix(data, info = list(), missing = NA, silent = FALSE, ...) +xgb.DMatrix( + data, + info = list(), + missing = NA, + silent = FALSE, + nthread = NULL, + ... +) } \arguments{ \item{data}{a \code{matrix} object (either numeric or integer), a \code{dgCMatrix} object, or a character @@ -18,6 +25,8 @@ It is useful when a 0 or some other extreme value represents missing values in d \item{silent}{whether to suppress printing an informational message after loading from a file.} +\item{nthread}{Number of threads used for creating DMatrix.} + \item{...}{the \code{info} data could be passed directly as parameters, without creating an \code{info} list.} } \description{