getinfo: Get information of an xgb.DMatrix object

In xgboost: Extreme Gradient Boosting

Get information of an xgb.DMatrix object

Description

Get information of an xgb.DMatrix object

Usage

getinfo(object, ...)

## S3 method for class 'xgb.DMatrix'
getinfo(object, name, ...)

Arguments

object	Object of class xgb.DMatrix
...	other parameters
name	the name of the information field to get (see details)

Details

The name field can be one of the following:

• label: label XGBoost learn from ;

• weight: to do a weight rescale ;

• base_margin: base margin is the base prediction XGBoost will boost from ;

• nrow: number of rows of the xgb.DMatrix.

group can be setup by setinfo but can't be retrieved by 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))

xgboost documentation built on June 8, 2025, 11:43 a.m.