Class GBTree

java.lang.Object
biz.k11i.xgboost.gbm.GBTree
All Implemented Interfaces:
GradBooster, Serializable
Direct Known Subclasses:
Dart
public class GBTree extends Object
Gradient boosted tree implementation.
See Also:

  • Field Details

    • num_class

      protected int num_class

    • num_feature

      protected int num_feature

    • num_output_group

      protected int num_output_group

  • Constructor Details

    • GBTree

      public GBTree()

  • Method Details

    • loadModel

      public void loadModel(PredictorConfiguration config, ModelReader reader, boolean with_pbuffer) throws IOException
      Description copied from interface: GradBooster
      Loads model from stream.
      Parameters:
      config - predictor configuration
      reader - input stream
      with_pbuffer - whether the incoming data contains pbuffer
      Throws:
      IOException - If an I/O error occurs

    • predict

      public float[] predict(FVec feat, int ntree_limit, float base_score)
      Description copied from interface: GradBooster
      Generates predictions for given feature vector.
      Parameters:
      feat - feature vector
      ntree_limit - limit the number of trees used in prediction
      base_score - base score to initialize prediction
      Returns:
      prediction result

    • predictSingle

      public float predictSingle(FVec feat, int ntree_limit, float base_score)
      Description copied from interface: GradBooster
      Generates a prediction for given feature vector.

      This method only works when the model outputs single value.

      Parameters:
      feat - feature vector
      ntree_limit - limit the number of trees used in prediction
      base_score - base score to initialize prediction
      Returns:
      prediction result

    • predictLeaf

      public int[] predictLeaf(FVec feat, int ntree_limit)
      Description copied from interface: GradBooster
      Predicts the leaf index of each tree. This is only valid in gbtree predictor.
      Parameters:
      feat - feature vector
      ntree_limit - limit the number of trees used in prediction
      Returns:
      predicted leaf indexes

    • predictLeafPath

      public String[] predictLeafPath(FVec feat, int ntree_limit)
      Description copied from interface: GradBooster
      Predicts the path to leaf of each tree. This is only valid in gbtree predictor.
      Parameters:
      feat - feature vector
      ntree_limit - limit the number of trees used in prediction
      Returns:
      predicted path to leaves

    • getGroupedTrees

      public RegTree[][] getGroupedTrees()
      Returns:
      A two-dim array, with trees grouped into classes.

    • setNumClass

      public void setNumClass(int numClass)
      Specified by:
      setNumClass in interface GradBooster

    • setNumFeature

      public void setNumFeature(int numFeature)
      Specified by:
      setNumFeature in interface GradBooster