Package 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
Predictor.ModelParam
Parameters.
-
Field Summary
Fields Modifier and Type Field Description private GradBooster
gbm
private Predictor.ModelParam
mparam
private java.lang.String
name_gbm
private java.lang.String
name_obj
private ObjFunction
obj
private SparkModelParam
sparkModelParam
-
Constructor Summary
Constructors Constructor Description Predictor(java.io.InputStream in)
Predictor(java.io.InputStream in, PredictorConfiguration configuration)
Instantiates with the Xgboost model
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getNumClass()
Returns number of class.SparkModelParam
getSparkModelParam()
(package private) void
initObjFunction(PredictorConfiguration configuration)
(package private) void
initObjGbm()
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.int[]
predictLeaf(FVec feat)
Predicts leaf index of each tree.int[]
predictLeaf(FVec feat, int ntree_limit)
Predicts leaf index of each tree.(package private) float[]
predictRaw(FVec feat, int ntree_limit)
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.(package private) float
predictSingleRaw(FVec feat, int ntree_limit)
(package private) void
readParam(ModelReader reader)
-
-
-
Field Detail
-
mparam
private Predictor.ModelParam mparam
-
sparkModelParam
private SparkModelParam sparkModelParam
-
name_obj
private java.lang.String name_obj
-
name_gbm
private java.lang.String name_gbm
-
obj
private ObjFunction obj
-
gbm
private GradBooster gbm
-
-
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 streamconfiguration
- configuration- Throws:
java.io.IOException
- If an I/O error occurs
-
-
Method Detail
-
readParam
void readParam(ModelReader reader) throws java.io.IOException
- Throws:
java.io.IOException
-
initObjFunction
void initObjFunction(PredictorConfiguration configuration)
-
initObjGbm
void initObjGbm()
-
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 vectoroutput_margin
- whether to only predict margin value instead of transformed 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 vectoroutput_margin
- whether to only predict margin value instead of transformed predictionntree_limit
- limit the number of trees used in prediction- Returns:
- prediction values
-
predictRaw
float[] predictRaw(FVec feat, int ntree_limit)
-
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 vectoroutput_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 vectoroutput_margin
- whether to only predict margin value instead of transformed predictionntree_limit
- limit the number of trees used in prediction- Returns:
- prediction value
-
predictSingleRaw
float predictSingleRaw(FVec feat, int ntree_limit)
-
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 vectorntree_limit
- limit- Returns:
- leaf indexes
-
getSparkModelParam
public SparkModelParam getSparkModelParam()
-
getNumClass
public int getNumClass()
Returns number of class.- Returns:
- number of class
-
-