Class Predictor

java.lang.Object

biz.k11i.xgboost.Predictor

All Implemented Interfaces:

Serializable

public class Predictor
extends Object
implements Serializable

Predicts using the Xgboost model.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Predictor(InputStream in)
Predictor(InputStream in, PredictorConfiguration configuration)	Instantiates with the Xgboost model

Method Summary

Modifier and Type	Method	Description
float	getBaseScore()
GradBooster	getBooster()
int	getNumClass()	Returns number of class.
String	getObjName()
SparkModelParam	getSparkModelParam()
float[]	predict(FVec feat)	Generates predictions for given feature vector.
float[]	predict(FVec feat, boolean output_margin)	Generates predictions for given feature vector.
float[]	predict(FVec feat, boolean output_margin, int ntree_limit)	Generates predictions for given feature vector.
float[]	predict(FVec feat, float base_margin)	Generates predictions for given feature vector.
float[]	predict(FVec feat, float base_margin, int ntree_limit)	Generates predictions for given feature vector.
int[]	predictLeaf(FVec feat)	Predicts leaf index of each tree.
int[]	predictLeaf(FVec feat, int ntree_limit)	Predicts leaf index of each tree.
String[]	predictLeafPath(FVec feat)	Predicts path to leaf of each tree.
String[]	predictLeafPath(FVec feat, int ntree_limit)	Predicts path to leaf of each tree.
float	predictSingle(FVec feat)	Generates a prediction for given feature vector.
float	predictSingle(FVec feat, boolean output_margin)	Generates a prediction for given feature vector.
float	predictSingle(FVec feat, boolean output_margin, int ntree_limit)	Generates a prediction for given feature vector.

Methods inherited from class Object

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

Constructor Details

Predictor

public Predictor(InputStream in)
          throws IOException

Throws:

IOException

Predictor

public Predictor(InputStream in,
 PredictorConfiguration configuration)
          throws IOException

Instantiates with the Xgboost model

Parameters:

in - input stream

configuration - configuration

Throws:

IOException - If an I/O error occurs

Method Details

predict

public float[] predict(FVec feat)

Generates predictions for given feature vector.

Parameters:

feat - feature vector

Returns:

prediction values

predict

public float[] predict(FVec feat,
 boolean output_margin)

Generates predictions for given feature vector.

Parameters:

feat - feature vector

output_margin - whether to only predict margin value instead of transformed prediction

Returns:

prediction values

predict

public float[] predict(FVec feat,
 float base_margin)

Generates predictions for given feature vector.

Parameters:

feat - feature vector

base_margin - predict with base margin for each prediction

Returns:

prediction values

predict

public float[] predict(FVec feat,
 float base_margin,
 int ntree_limit)

Generates predictions for given feature vector.

Parameters:

feat - feature vector

base_margin - predict with base margin for each prediction

ntree_limit - limit the number of trees used in prediction

Returns:

prediction values

predict

public float[] predict(FVec feat,
 boolean output_margin,
 int ntree_limit)

Generates predictions for given feature vector.

Parameters:

feat - feature vector

output_margin - whether to only predict margin value instead of transformed prediction

ntree_limit - limit the number of trees used in prediction

Returns:

prediction values

predictSingle

public float predictSingle(FVec feat)

Generates a prediction for given feature vector.

This method only works when the model outputs single value.

Parameters:

feat - feature vector

Returns:

prediction value

predictSingle

public float predictSingle(FVec feat,
 boolean output_margin)

Generates a prediction for given feature vector.

This method only works when the model outputs single value.

Parameters:

feat - feature vector

output_margin - whether to only predict margin value instead of transformed prediction

Returns:

prediction value

predictSingle

public float predictSingle(FVec feat,
 boolean output_margin,
 int ntree_limit)

Generates a prediction for given feature vector.

This method only works when the model outputs single value.

Parameters:

feat - feature vector

output_margin - whether to only predict margin value instead of transformed prediction

ntree_limit - limit the number of trees used in prediction

Returns:

prediction value

predictLeaf

public int[] predictLeaf(FVec feat)

Predicts leaf index of each tree.

Parameters:

feat - feature vector

Returns:

leaf indexes

predictLeaf

public int[] predictLeaf(FVec feat,
 int ntree_limit)

Predicts leaf index of each tree.

Parameters:

feat - feature vector

ntree_limit - limit, 0 for all

Returns:

leaf indexes

predictLeafPath

public String[] predictLeafPath(FVec feat)

Predicts path to leaf of each tree.

Parameters:

feat - feature vector

Returns:

leaf paths

predictLeafPath

public String[] predictLeafPath(FVec feat,
 int ntree_limit)

Predicts path to leaf of each tree.

Parameters:

feat - feature vector

ntree_limit - limit, 0 for all

Returns:

leaf paths

getSparkModelParam

public SparkModelParam getSparkModelParam()

getNumClass

public int getNumClass()

Returns number of class.

Returns:

number of class

getBooster

public GradBooster getBooster()

getObjName

public String getObjName()

getBaseScore

public float getBaseScore()