a347cd512b
- Limit the number of used CPU cores in examples. - Add a note for the constraint. - Bring back the cleanup script.
45 lines
1.2 KiB
R
45 lines
1.2 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/xgb.DMatrix.R
|
|
\name{getinfo}
|
|
\alias{getinfo}
|
|
\alias{getinfo.xgb.DMatrix}
|
|
\title{Get information of an xgb.DMatrix object}
|
|
\usage{
|
|
getinfo(object, ...)
|
|
|
|
\method{getinfo}{xgb.DMatrix}(object, name, ...)
|
|
}
|
|
\arguments{
|
|
\item{object}{Object of class \code{xgb.DMatrix}}
|
|
|
|
\item{...}{other parameters}
|
|
|
|
\item{name}{the name of the information field to get (see details)}
|
|
}
|
|
\description{
|
|
Get information of an xgb.DMatrix object
|
|
}
|
|
\details{
|
|
The \code{name} field can be one of the following:
|
|
|
|
\itemize{
|
|
\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}.
|
|
|
|
}
|
|
|
|
\code{group} can be setup by \code{setinfo} but can't be retrieved by \code{getinfo}.
|
|
}
|
|
\examples{
|
|
data(agaricus.train, package='xgboost')
|
|
dtrain <- with(agaricus.train, xgb.DMatrix(data, label = label, nthread = 2))
|
|
|
|
labels <- getinfo(dtrain, 'label')
|
|
setinfo(dtrain, 'label', 1-labels)
|
|
|
|
labels2 <- getinfo(dtrain, 'label')
|
|
stopifnot(all(labels2 == 1-labels))
|
|
}
|