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

[R] Add note about serialization of DMatrix objects (#9853)

Browse Source
This commit is contained in:
david-cortes 2023-12-06 20:11:15 +01:00 committed by GitHub
parent 4bc1f3a388
commit 9e9d41b95c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -16,6 +16,12 @@
#' @param nthread Number of threads used for creating DMatrix. #' @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. #' @param ... the \code{info} data could be passed directly as parameters, without creating an \code{info} list.
#' #'
#' @details
#' Note that DMatrix objects are not serializable through R functions such as \code{saveRDS} or \code{save}.
#' If a DMatrix gets serialized and then de-serialized (for example, when saving data in an R session or caching
#' chunks in an Rmd file), the resulting object will not be usable anymore and will need to be reconstructed
#' from the original source of data.
#'
#' @examples #' @examples
#' data(agaricus.train, package='xgboost') #' data(agaricus.train, package='xgboost')
#' ## Keep the number of threads to 1 for examples #' ## Keep the number of threads to 1 for examples

6
R-package/man/xgb.DMatrix.Rd
View File

@ -36,6 +36,12 @@ Construct xgb.DMatrix object from either a dense matrix, a sparse matrix, or a l
Supported input file formats are either a LIBSVM text file or a binary file that was created previously by Supported input file formats are either a LIBSVM text file or a binary file that was created previously by
\code{\link{xgb.DMatrix.save}}). \code{\link{xgb.DMatrix.save}}).
} }
\details{
Note that DMatrix objects are not serializable through R functions such as \code{saveRDS} or \code{save}.
If a DMatrix gets serialized and then de-serialized (for example, when saving data in an R session or caching
chunks in an Rmd file), the resulting object will not be usable anymore and will need to be reconstructed
from the original source of data.
}
\examples{ \examples{
data(agaricus.train, package='xgboost') data(agaricus.train, package='xgboost')
## Keep the number of threads to 1 for examples ## Keep the number of threads to 1 for examples