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:
  • Field Details

  • Constructor Details

  • Method Details

    • readParam

      void readParam(ModelReader reader) throws IOException
      Throws:
      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 vector
      output_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 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
    • 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 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
    • 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 vector
      ntree_limit - limit
      Returns:
      leaf indexes
    • getSparkModelParam

      public SparkModelParam getSparkModelParam()
    • getNumClass

      public int getNumClass()
      Returns number of class.
      Returns:
      number of class