biz.k11i.xgboost

Class Predictor

java.lang.Object

biz.k11i.xgboost.Predictor

All Implemented Interfaces:

java.io.Serializable

public class Predictor
extends java.lang.Object
implements java.io.Serializable

Predicts using the Xgboost model.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Predictor(java.io.InputStream in)
Predictor(java.io.InputStream in, PredictorConfiguration configuration) Instantiates with the Xgboost model

Method Summary

Methods

Modifier and Type	Method and Description
int	getNumClass() Returns number of class.
SparkModelParam	getSparkModelParam()
double[]	predict(FVec feat) Generates predictions for given feature vector.
double[]	predict(FVec feat, boolean output_margin) Generates predictions for given feature vector.
double[]	predict(FVec feat, boolean output_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.
double	predictSingle(FVec feat) Generates a prediction for given feature vector.
double	predictSingle(FVec feat, boolean output_margin) Generates a prediction for given feature vector.
double	predictSingle(FVec feat, boolean output_margin, int ntree_limit) Generates a prediction for given feature vector.

Methods inherited from class java.lang.Object

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

Constructor Detail

Predictor

public Predictor(java.io.InputStream in)
          throws java.io.IOException

Throws:

java.io.IOException

Predictor

public Predictor(java.io.InputStream in,
         PredictorConfiguration configuration)
          throws java.io.IOException

Instantiates with the Xgboost model

Parameters:

in - input stream

configuration - configuration

Throws:

java.io.IOException - If an I/O error occurs

Method Detail

predict

public double[] predict(FVec feat)

Generates predictions for given feature vector.

Parameters:

feat - feature vector

Returns:

prediction values

predict

public double[] 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 double[] 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 double 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 double 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 double 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

Returns:

leaf indexes

getSparkModelParam

public SparkModelParam getSparkModelParam()

getNumClass

public int getNumClass()

Returns number of class.

Returns:

number of class