Class GBTree

  • All Implemented Interfaces:
    GradBooster, java.io.Serializable
    Direct Known Subclasses:
    Dart

    public class GBTree
    extends GBBase
    Gradient boosted tree implementation.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      GBTree()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void loadModel​(ModelReader reader, boolean with_pbuffer)
      Loads model from stream.
      (package private) float pred​(FVec feat, int bst_group, int root_index, int ntree_limit)  
      float[] predict​(FVec feat, int ntree_limit)
      Generates predictions for given feature vector.
      int[] predictLeaf​(FVec feat, int ntree_limit)
      Predicts the leaf index of each tree.
      float predictSingle​(FVec feat, int ntree_limit)
      Generates a prediction for given feature vector.
      (package private) int[] predPath​(FVec feat, int root_index, int ntree_limit)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GBTree

        GBTree()
    • Method Detail

      • loadModel

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

        public float[] predict​(FVec feat,
                               int ntree_limit)
        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
        Returns:
        prediction result
      • predictSingle

        public float predictSingle​(FVec feat,
                                   int ntree_limit)
        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
        Returns:
        prediction result
      • pred

        float pred​(FVec feat,
                   int bst_group,
                   int root_index,
                   int ntree_limit)
      • 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
      • predPath

        int[] predPath​(FVec feat,
                       int root_index,
                       int ntree_limit)