ml.dmlc.xgboost4j.java.ColumnBatch Class Reference

The abstracted XGBoost ColumnBatch to get array interface from columnar data format. More...

Inheritance diagram for ml.dmlc.xgboost4j.java.ColumnBatch:

Public Member Functions
final String	getArrayInterfaceJson ()
	Get the cuda array interface json string for the whole ColumnBatch including the must-have feature, label columns and the optional weight, base margin columns.
abstract String	getFeatureArrayInterface ()
	Get the cuda array interface of the feature columns.
abstract String	getLabelsArrayInterface ()
	Get the cuda array interface of the label columns.
abstract String	getWeightsArrayInterface ()
	Get the cuda array interface of the weight columns.
abstract String	getBaseMarginsArrayInterface ()
	Get the cuda array interface of the base margin columns.
void	close () throws Exception

Detailed Description

The abstracted XGBoost ColumnBatch to get array interface from columnar data format.

For example, the cuDF dataframe which employs apache arrow specification.

Member Function Documentation

getArrayInterfaceJson()

final String ml.dmlc.xgboost4j.java.ColumnBatch.getArrayInterfaceJson ( )

inline

Get the cuda array interface json string for the whole ColumnBatch including the must-have feature, label columns and the optional weight, base margin columns.

This function is be called by native code during iteration and can be made as private method. We keep it as public simply to silent the linter.

getBaseMarginsArrayInterface()

abstract String ml.dmlc.xgboost4j.java.ColumnBatch.getBaseMarginsArrayInterface ( )

abstract

Get the cuda array interface of the base margin columns.

The returned value can be null or empty

getFeatureArrayInterface()

abstract String ml.dmlc.xgboost4j.java.ColumnBatch.getFeatureArrayInterface ( )

abstract

Get the cuda array interface of the feature columns.

The returned value must not be null or empty

getLabelsArrayInterface()

abstract String ml.dmlc.xgboost4j.java.ColumnBatch.getLabelsArrayInterface ( )

abstract

Get the cuda array interface of the label columns.

The returned value must not be null or empty if we're creating QuantileDMatrix#QuantileDMatrix(Iterator, float, int, int)

getWeightsArrayInterface()

abstract String ml.dmlc.xgboost4j.java.ColumnBatch.getWeightsArrayInterface ( )

abstract

Get the cuda array interface of the weight columns.

The returned value can be null or empty

---

The documentation for this class was generated from the following file:

• External/xgboost/jvm-packages/xgboost4j/src/main/java/ml/dmlc/xgboost4j/java/ColumnBatch.java