ml.dmlc.xgboost4j.java

Class XGBoostJNI

java.lang.Object

ml.dmlc.xgboost4j.java.XGBoostJNI

public class XGBoostJNI
extends Object

xgboost JNI functions change 2015-7-6: *use a long[] (length=1) as container of handle to get the output DMatrix or Booster

Author:

hzx

Constructor Summary

Constructors

Constructor and Description
XGBoostJNI()

Method Summary

Modifier and Type	Method and Description
static int	CommunicatorFinalize()
static int	CommunicatorGetRank(int[] out)
static int	CommunicatorGetWorldSize(int[] out)
static int	CommunicatorInit(String args)
static int	CommunicatorPrint(String msg)
static int	CudaSetDevice(int deviceId)
static int	TrackerCreate(String host, int nWorkers, int port, int sortby, long timeout, long[] out)
static int	TrackerFree(long handle)
static int	TrackerRun(long handle)
static int	TrackerWaitFor(long handle, long timeout)
static int	TrackerWorkerArgs(long handle, long timeout, String[] out)
static int	XGBGetGlobalConfig(String[] out)
static String	XGBGetLastError()
static int	XGBoosterCreate(long[] handles, long[] out)
static int	XGBoosterDumpModelEx(long handle, String fmap, int with_stats, String format, String[][] out_strings)
static int	XGBoosterDumpModelExWithFeatures(long handle, String[] feature_names, int with_stats, String format, String[][] out_strings)
static int	XGBoosterEvalOneIter(long handle, int iter, long[] dmats, String[] evnames, String[] eval_info)
static int	XGBoosterFree(long handle)
static int	XGBoosterGetAttr(long handle, String key, String[] out_string)
static int	XGBoosterGetAttrNames(long handle, String[][] out_strings)
static int	XGBoosterGetNumBoostedRound(long handle, int[] rounds)
static int	XGBoosterGetNumFeature(long handle, long[] feature)
static int	XGBoosterGetStrFeatureInfo(long handle, String field, String[] out)
static int	XGBoosterLoadModel(long handle, String fname)
static int	XGBoosterLoadModelFromBuffer(long handle, byte[] bytes)
static int	XGBoosterPredict(long handle, long dmat, int option_mask, int ntree_limit, float[][] predicts)
static int	XGBoosterPredictFromDense(long handle, float[] data, long nrow, long ncol, float missing, int iteration_begin, int iteration_end, int predict_type, float[] margin, float[][] predicts)
static int	XGBoosterSaveModel(long handle, String fname)
static int	XGBoosterSaveModelToBuffer(long handle, String format, byte[][] out_bytes)
static int	XGBoosterSetAttr(long handle, String key, String value)
static int	XGBoosterSetParam(long handle, String name, String value)
static int	XGBoosterSetStrFeatureInfo(long handle, String field, String[] features)
static int	XGBoosterTrainOneIter(long handle, long dtrain, int iter, float[] grad, float[] hess)
static int	XGBoosterUpdateOneIter(long handle, int iter, long dtrain)
static int	XGBSetGlobalConfig(String config)
static int	XGDMatrixCreateFromArrayInterfaceColumns(String featureJson, float missing, int nthread, long[] out)
static int	XGDMatrixCreateFromCSC(long[] colptr, int[] indices, float[] data, int shapeParam, float missing, int nthread, long[] out)
static int	XGDMatrixCreateFromCSR(long[] indptr, int[] indices, float[] data, int shapeParam, float missing, int nthread, long[] out)
static int	XGDMatrixCreateFromFile(String fname, int silent, long[] out)
static int	XGDMatrixCreateFromMat(float[] data, int nrow, int ncol, float missing, long[] out)
static int	XGDMatrixCreateFromMatRef(long dataRef, int nrow, int ncol, float missing, long[] out)
static int	XGDMatrixFree(long handle)
static int	XGDMatrixGetFloatInfo(long handle, String field, float[][] info)
static int	XGDMatrixGetQuantileCut(long handle, long[][] outIndptr, float[][] outValues)
static int	XGDMatrixGetStrFeatureInfo(long handle, String field, long[] outLength, String[][] outValues)
static int	XGDMatrixGetUIntInfo(long handle, String filed, int[][] info)
static int	XGDMatrixNumNonMissing(long handle, long[] nonMissings)
static int	XGDMatrixNumRow(long handle, long[] row)
static int	XGDMatrixSaveBinary(long handle, String fname, int silent)
static int	XGDMatrixSetFloatInfo(long handle, String field, float[] array)
static int	XGDMatrixSetInfoFromInterface(long handle, String field, String json)
static int	XGDMatrixSetStrFeatureInfo(long handle, String field, String[] values) Set the feature information
static int	XGDMatrixSetUIntInfo(long handle, String field, int[] array)
static int	XGDMatrixSliceDMatrix(long handle, int[] idxset, long[] out)
static int	XGExtMemQuantileDMatrixCreateFromCallback(Iterator<ColumnBatch> iter, long[] ref, String config, long[] out)
static int	XGQuantileDMatrixCreateFromCallback(Iterator<ColumnBatch> iter, long[] ref, String config, long[] out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XGBoostJNI

public XGBoostJNI()

Method Detail

XGBGetLastError

public static final String XGBGetLastError()

XGDMatrixCreateFromFile

public static final int XGDMatrixCreateFromFile(String fname,
                                                int silent,
                                                long[] out)

XGDMatrixCreateFromCSR

public static final int XGDMatrixCreateFromCSR(long[] indptr,
                                               int[] indices,
                                               float[] data,
                                               int shapeParam,
                                               float missing,
                                               int nthread,
                                               long[] out)

XGDMatrixCreateFromCSC

public static final int XGDMatrixCreateFromCSC(long[] colptr,
                                               int[] indices,
                                               float[] data,
                                               int shapeParam,
                                               float missing,
                                               int nthread,
                                               long[] out)

XGDMatrixCreateFromMat

public static final int XGDMatrixCreateFromMat(float[] data,
                                               int nrow,
                                               int ncol,
                                               float missing,
                                               long[] out)

XGDMatrixCreateFromMatRef

public static final int XGDMatrixCreateFromMatRef(long dataRef,
                                                  int nrow,
                                                  int ncol,
                                                  float missing,
                                                  long[] out)

XGDMatrixSliceDMatrix

public static final int XGDMatrixSliceDMatrix(long handle,
                                              int[] idxset,
                                              long[] out)

XGDMatrixFree

public static final int XGDMatrixFree(long handle)

XGDMatrixSaveBinary

public static final int XGDMatrixSaveBinary(long handle,
                                            String fname,
                                            int silent)

XGDMatrixSetFloatInfo

public static final int XGDMatrixSetFloatInfo(long handle,
                                              String field,
                                              float[] array)

XGDMatrixSetUIntInfo

public static final int XGDMatrixSetUIntInfo(long handle,
                                             String field,
                                             int[] array)

XGDMatrixGetFloatInfo

public static final int XGDMatrixGetFloatInfo(long handle,
                                              String field,
                                              float[][] info)

XGDMatrixGetUIntInfo

public static final int XGDMatrixGetUIntInfo(long handle,
                                             String filed,
                                             int[][] info)

XGDMatrixSetStrFeatureInfo

public static final int XGDMatrixSetStrFeatureInfo(long handle,
                                                   String field,
                                                   String[] values)

Set the feature information

Parameters:

handle - the DMatrix native address

field - "feature_names" or "feature_types"

values - an array of string

Returns:

0 when success, -1 when failure happens

XGDMatrixGetStrFeatureInfo

public static final int XGDMatrixGetStrFeatureInfo(long handle,
                                                   String field,
                                                   long[] outLength,
                                                   String[][] outValues)

XGDMatrixNumRow

public static final int XGDMatrixNumRow(long handle,
                                        long[] row)

XGDMatrixNumNonMissing

public static final int XGDMatrixNumNonMissing(long handle,
                                               long[] nonMissings)

XGBoosterCreate

public static final int XGBoosterCreate(long[] handles,
                                        long[] out)

XGBoosterFree

public static final int XGBoosterFree(long handle)

XGBoosterSetParam

public static final int XGBoosterSetParam(long handle,
                                          String name,
                                          String value)

XGBoosterUpdateOneIter

public static final int XGBoosterUpdateOneIter(long handle,
                                               int iter,
                                               long dtrain)

XGBoosterTrainOneIter

public static final int XGBoosterTrainOneIter(long handle,
                                              long dtrain,
                                              int iter,
                                              float[] grad,
                                              float[] hess)

XGBoosterEvalOneIter

public static final int XGBoosterEvalOneIter(long handle,
                                             int iter,
                                             long[] dmats,
                                             String[] evnames,
                                             String[] eval_info)

XGBoosterPredict

public static final int XGBoosterPredict(long handle,
                                         long dmat,
                                         int option_mask,
                                         int ntree_limit,
                                         float[][] predicts)

XGBoosterPredictFromDense

public static final int XGBoosterPredictFromDense(long handle,
                                                  float[] data,
                                                  long nrow,
                                                  long ncol,
                                                  float missing,
                                                  int iteration_begin,
                                                  int iteration_end,
                                                  int predict_type,
                                                  float[] margin,
                                                  float[][] predicts)

XGBoosterLoadModel

public static final int XGBoosterLoadModel(long handle,
                                           String fname)

XGBoosterSaveModel

public static final int XGBoosterSaveModel(long handle,
                                           String fname)

XGBoosterLoadModelFromBuffer

public static final int XGBoosterLoadModelFromBuffer(long handle,
                                                     byte[] bytes)

XGBoosterSaveModelToBuffer

public static final int XGBoosterSaveModelToBuffer(long handle,
                                                   String format,
                                                   byte[][] out_bytes)

XGBoosterDumpModelEx

public static final int XGBoosterDumpModelEx(long handle,
                                             String fmap,
                                             int with_stats,
                                             String format,
                                             String[][] out_strings)

XGBoosterDumpModelExWithFeatures

public static final int XGBoosterDumpModelExWithFeatures(long handle,
                                                         String[] feature_names,
                                                         int with_stats,
                                                         String format,
                                                         String[][] out_strings)

XGBoosterGetAttrNames

public static final int XGBoosterGetAttrNames(long handle,
                                              String[][] out_strings)

XGBoosterGetAttr

public static final int XGBoosterGetAttr(long handle,
                                         String key,
                                         String[] out_string)

XGBoosterSetAttr

public static final int XGBoosterSetAttr(long handle,
                                         String key,
                                         String value)

XGBoosterGetNumFeature

public static final int XGBoosterGetNumFeature(long handle,
                                               long[] feature)

XGBoosterGetNumBoostedRound

public static final int XGBoosterGetNumBoostedRound(long handle,
                                                    int[] rounds)

CommunicatorInit

public static final int CommunicatorInit(String args)

CommunicatorFinalize

public static final int CommunicatorFinalize()

CommunicatorPrint

public static final int CommunicatorPrint(String msg)

CommunicatorGetRank

public static final int CommunicatorGetRank(int[] out)

CommunicatorGetWorldSize

public static final int CommunicatorGetWorldSize(int[] out)

TrackerCreate

public static final int TrackerCreate(String host,
                                      int nWorkers,
                                      int port,
                                      int sortby,
                                      long timeout,
                                      long[] out)

TrackerRun

public static final int TrackerRun(long handle)

TrackerWaitFor

public static final int TrackerWaitFor(long handle,
                                       long timeout)

TrackerWorkerArgs

public static final int TrackerWorkerArgs(long handle,
                                          long timeout,
                                          String[] out)

TrackerFree

public static final int TrackerFree(long handle)

XGDMatrixSetInfoFromInterface

public static final int XGDMatrixSetInfoFromInterface(long handle,
                                                      String field,
                                                      String json)

XGQuantileDMatrixCreateFromCallback

public static final int XGQuantileDMatrixCreateFromCallback(Iterator<ColumnBatch> iter,
                                                            long[] ref,
                                                            String config,
                                                            long[] out)

XGExtMemQuantileDMatrixCreateFromCallback

public static final int XGExtMemQuantileDMatrixCreateFromCallback(Iterator<ColumnBatch> iter,
                                                                  long[] ref,
                                                                  String config,
                                                                  long[] out)

XGDMatrixCreateFromArrayInterfaceColumns

public static final int XGDMatrixCreateFromArrayInterfaceColumns(String featureJson,
                                                                 float missing,
                                                                 int nthread,
                                                                 long[] out)

XGBoosterSetStrFeatureInfo

public static final int XGBoosterSetStrFeatureInfo(long handle,
                                                   String field,
                                                   String[] features)

XGBoosterGetStrFeatureInfo

public static final int XGBoosterGetStrFeatureInfo(long handle,
                                                   String field,
                                                   String[] out)

XGDMatrixGetQuantileCut

public static final int XGDMatrixGetQuantileCut(long handle,
                                                long[][] outIndptr,
                                                float[][] outValues)

XGBSetGlobalConfig

public static final int XGBSetGlobalConfig(String config)

XGBGetGlobalConfig

public static final int XGBGetGlobalConfig(String[] out)

CudaSetDevice

public static final int CudaSetDevice(int deviceId)