xgboost4j_2.12 1.6.2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package ml
  Definition Classes
    root
-  package dmlc
  Definition Classes
    ml
-  package xgboost4j
  Definition Classes
    dmlc
-  package java
  Definition Classes
    xgboost4j
-  package util
  Definition Classes
    java
- Booster
- Column
- ColumnBatch
- DMatrix
- DeviceQuantileDMatrix
- ExternalCheckpointManager
- IEvaluation
- IObjective
- IRabitTracker
- Rabit
- RabitTracker
- TrackerProperties
- XGBoost
- XGBoostError

c

ml.dmlc.xgboost4j.java

# ColumnBatch 

###

#### abstract class ColumnBatch extends AutoCloseable

The abstracted XGBoost ColumnBatch to get array interface from columnar data format. For example, the cuDF dataframe which employs apache arrow specification.

Linear Supertypes
AutoCloseable, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ColumnBatch
2. AutoCloseable
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new ColumnBatch()

### Abstract Value Members

1.  abstract def getBaseMarginsArrayInterface(): String

   Get the cuda array interface of the base margin columns.

   Get the cuda array interface of the base margin columns. The returned value can be null or empty

2.  abstract def getFeatureArrayInterface(): String

   Get the cuda array interface of the feature columns.

   Get the cuda array interface of the feature columns. The returned value must not be null or empty

3.  abstract def getLabelsArrayInterface(): String

   Get the cuda array interface of the label columns.

   Get the cuda array interface of the label columns. The returned value must not be null or empty if we're creating `float, int, int)`

4.  abstract def getWeightsArrayInterface(): String

   Get the cuda array interface of the weight columns.

   Get the cuda array interface of the weight columns. The returned value can be null or empty

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
6.  def close(): Unit
   Definition Classes
     ColumnBatch → AutoCloseable
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
9.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
10.  final def getArrayInterfaceJson(): String

    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.

    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.

11.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
12.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
13.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
14.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
15.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
16.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
17.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
18.  def toString(): String
    Definition Classes
      AnyRef → Any
19.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
20.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
21.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AutoCloseable

### Inherited from AnyRef

### Inherited from Any

### Ungrouped