xgb.DataIter: XGBoost Data Iterator

In xgboost: Extreme Gradient Boosting

XGBoost Data Iterator

Description

Interface to create a custom data iterator in order to construct a DMatrix from external memory.

This function is responsible for generating an R object structure containing callback functions and an environment shared with them.

The output structure from this function is then meant to be passed to xgb.ExtMemDMatrix(), which will consume the data and create a DMatrix from it by executing the callback functions.

For more information, and for a usage example, see the documentation for xgb.ExtMemDMatrix().

Usage

xgb.DataIter(env = new.env(), f_next, f_reset)

Arguments

env	An R environment to pass to the callback functions supplied here, which can be used to keep track of variables to determine how to handle the batches. For example, one might want to keep track of an iteration number in this environment in order to know which part of the data to pass next.
f_next	⁠function(env)⁠ which is responsible for: Accessing or retrieving the next batch of data in the iterator. Supplying this data by calling function xgb.DataBatch() on it and returning the result. Keeping track of where in the iterator batch it is or will go next, which can for example be done by modifiying variables in the env variable that is passed here. Signaling whether there are more batches to be consumed or not, by returning NULL when the stream of data ends (all batches in the iterator have been consumed), or the result from calling xgb.DataBatch() when there are more batches in the line to be consumed.
f_reset	⁠function(env)⁠ which is responsible for reseting the data iterator (i.e. taking it back to the first batch, called before and after the sequence of batches has been consumed). Note that, after resetting the iterator, the batches will be accessed again, so the same data (and in the same order) must be passed in subsequent iterations.

Value

An xgb.DataIter object, containing the same inputs supplied here, which can then be passed to xgb.ExtMemDMatrix().

See Also

xgb.ExtMemDMatrix(), xgb.DataBatch().

xgboost documentation built on Dec. 3, 2025, 5:06 p.m.