Package ai.djl.ml.xgboost

Class XgbSymbolBlock

java.lang.Object
ai.djl.nn.AbstractBaseBlock
ai.djl.nn.AbstractSymbolBlock
ai.djl.ml.xgboost.XgbSymbolBlock
All Implemented Interfaces:
ai.djl.nn.Block, ai.djl.nn.SymbolBlock, AutoCloseable
public class XgbSymbolBlock extends ai.djl.nn.AbstractSymbolBlock implements AutoCloseable
XgbSymbolBlock is the XGBoost implementation of SymbolBlock.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    XgbSymbolBlock.Mode
    The mode of inference for OptionMask.

  • Field Summary

    Fields inherited from class ai.djl.nn.AbstractBaseBlock

    inputNames, inputShapes, outputDataTypes, version

  • Constructor Summary

    Constructors
    Constructor
    Description
    XgbSymbolBlock(XgbNDManager manager, long handle)
    Constructs a XgbSymbolBlock.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    protected ai.djl.ndarray.NDList
    forwardInternal(ai.djl.training.ParameterStore parameterStore, ai.djl.ndarray.NDList inputs, boolean training, ai.djl.util.PairList<String,Object> params)
    ai.djl.nn.ParameterList
    getDirectParameters()
    Long
    getHandle()
    Gets the native XGBoost Booster pointer.

    Methods inherited from class ai.djl.nn.AbstractSymbolBlock

    getChildren, getOutputShapes

    Methods inherited from class ai.djl.nn.AbstractBaseBlock

    beforeInitialize, cast, clear, describeInput, forward, forward, forwardInternal, getInputShapes, getOutputDataTypes, getParameters, initialize, initializeChildBlocks, isInitialized, loadMetadata, loadParameters, prepare, readInputShapes, saveInputShapes, saveMetadata, saveParameters, setInitializer, setInitializer, setInitializer, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface ai.djl.nn.Block

    cast, clear, describeInput, forward, forward, forward, freezeParameters, freezeParameters, getInputShapes, getOutputDataTypes, getOutputShapes, getParameters, initialize, isInitialized, loadParameters, saveParameters, setInitializer, setInitializer, setInitializer

    Methods inherited from interface ai.djl.nn.SymbolBlock

    describeOutput, removeLastBlock

  • Constructor Details

    • XgbSymbolBlock

      public XgbSymbolBlock(XgbNDManager manager, long handle)
      Constructs a XgbSymbolBlock.

      You can create a XgbSymbolBlock using Model.load(java.nio.file.Path, String).

      Parameters:
      manager - the manager to use for the block
      handle - the Booster handle

  • Method Details

    • forwardInternal

      protected ai.djl.ndarray.NDList forwardInternal(ai.djl.training.ParameterStore parameterStore, ai.djl.ndarray.NDList inputs, boolean training, ai.djl.util.PairList<String,Object> params)
      Specified by:
      forwardInternal in class ai.djl.nn.AbstractBaseBlock

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • getHandle

      public Long getHandle()
      Gets the native XGBoost Booster pointer.
      Returns:
      the pointer

    • getDirectParameters

      public ai.djl.nn.ParameterList getDirectParameters()
      Specified by:
      getDirectParameters in interface ai.djl.nn.Block