ml.dmlc.xgboost4j.java

Class BoosterHelper

java.lang.Object

ml.dmlc.xgboost4j.java.BoosterHelper

public class BoosterHelperextends java.lang.Object

Utility to access package private Booster methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BoosterHelper.BoosterOp<X>

Constructor Summary

Constructors

Constructor and Description
BoosterHelper()

Method Summary

Modifier and Type	Method and Description
static void	dispose(java.lang.Object... xgbObjects) Invalidates XGBoost objects (Booster, DMatrix) and frees up their memory
static <X> X	doWithLocalRabit(BoosterHelper.BoosterOp<X> op, ml.dmlc.xgboost4j.java.Booster booster)
static ml.dmlc.xgboost4j.java.Booster	loadModel(java.io.InputStream in)

Methods inherited from class java.lang.Object

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

Constructor Detail

BoosterHelper

public BoosterHelper()

Method Detail

loadModel

public static ml.dmlc.xgboost4j.java.Booster loadModel(java.io.InputStream in)                                                throws ml.dmlc.xgboost4j.java.XGBoostError,                                                       java.io.IOException

Throws:

ml.dmlc.xgboost4j.java.XGBoostError

java.io.IOException

dispose

public static void dispose(java.lang.Object... xgbObjects)                    throws java.lang.IllegalStateException

Invalidates XGBoost objects (Booster, DMatrix) and frees up their memory

Parameters:

xgbObjects - list of XGBoost objects

Throws:

java.lang.IllegalStateException - when object invalidation fails, only the first exception will be reported (as the exception cause), we assume the other ones will have a same reason

doWithLocalRabit

public static <X> X doWithLocalRabit(BoosterHelper.BoosterOp<X> op,                                     ml.dmlc.xgboost4j.java.Booster booster)                              throws ml.dmlc.xgboost4j.java.XGBoostError

Throws:

ml.dmlc.xgboost4j.java.XGBoostError