ML.DMLC.XGBoost.FFI

Documentation

newtype DMatrix

Constructors

DMatrix (Ptr ())

Instances

Eq DMatrix

Methods

(==) :: DMatrix -> DMatrix -> Bool

(/=) :: DMatrix -> DMatrix -> Bool

Storable DMatrix

Methods

sizeOf :: DMatrix -> Int

alignment :: DMatrix -> Int

peekElemOff :: Ptr DMatrix -> Int -> IO DMatrix

pokeElemOff :: Ptr DMatrix -> Int -> DMatrix -> IO ()

peekByteOff :: Ptr b -> Int -> IO DMatrix

pokeByteOff :: Ptr b -> Int -> DMatrix -> IO ()

peek :: Ptr DMatrix -> IO DMatrix

poke :: Ptr DMatrix -> DMatrix -> IO ()

PrimType DMatrix

Methods

primSizeInBytes :: Proxy * DMatrix -> CountOf Word8

primShiftToBytes :: Proxy * DMatrix -> Int

primBaUIndex :: ByteArray# -> Offset DMatrix -> DMatrix

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset DMatrix -> prim DMatrix

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset DMatrix -> DMatrix -> prim ()

primAddrIndex :: Addr# -> Offset DMatrix -> DMatrix

primAddrRead :: PrimMonad prim => Addr# -> Offset DMatrix -> prim DMatrix

primAddrWrite :: PrimMonad prim => Addr# -> Offset DMatrix -> DMatrix -> prim ()

Storable DMatrix

Methods

peek :: Ptr DMatrix -> IO DMatrix

poke :: Ptr DMatrix -> DMatrix -> IO ()

type DMatrixArray = Ptr DMatrix

newtype Booster

Constructors

Booster (Ptr ())

Instances

Storable Booster

Methods

sizeOf :: Booster -> Int

alignment :: Booster -> Int

peekElemOff :: Ptr Booster -> Int -> IO Booster

pokeElemOff :: Ptr Booster -> Int -> Booster -> IO ()

peekByteOff :: Ptr b -> Int -> IO Booster

pokeByteOff :: Ptr b -> Int -> Booster -> IO ()

peek :: Ptr Booster -> IO Booster

poke :: Ptr Booster -> Booster -> IO ()

Storable Booster

Methods

peek :: Ptr Booster -> IO Booster

poke :: Ptr Booster -> Booster -> IO ()

newtype DataIter

Constructors

DataIter (Ptr ())

Instances

Storable DataIter

Methods

sizeOf :: DataIter -> Int

alignment :: DataIter -> Int

peekElemOff :: Ptr DataIter -> Int -> IO DataIter

pokeElemOff :: Ptr DataIter -> Int -> DataIter -> IO ()

peekByteOff :: Ptr b -> Int -> IO DataIter

pokeByteOff :: Ptr b -> Int -> DataIter -> IO ()

peek :: Ptr DataIter -> IO DataIter

poke :: Ptr DataIter -> DataIter -> IO ()

Storable DataIter

Methods

peek :: Ptr DataIter -> IO DataIter

poke :: Ptr DataIter -> DataIter -> IO ()

newtype DataHolder

Constructors

DataHolder (Ptr ())

Instances

Storable DataHolder

Methods

sizeOf :: DataHolder -> Int

alignment :: DataHolder -> Int

peekElemOff :: Ptr DataHolder -> Int -> IO DataHolder

pokeElemOff :: Ptr DataHolder -> Int -> DataHolder -> IO ()

peekByteOff :: Ptr b -> Int -> IO DataHolder

pokeByteOff :: Ptr b -> Int -> DataHolder -> IO ()

peek :: Ptr DataHolder -> IO DataHolder

poke :: Ptr DataHolder -> DataHolder -> IO ()

Storable DataHolder

Methods

peek :: Ptr DataHolder -> IO DataHolder

poke :: Ptr DataHolder -> DataHolder -> IO ()

newtype XGBoostBatchCSR

Constructors

XGBoostBatchCSR (Ptr ())

Instances

Storable XGBoostBatchCSR

Methods

sizeOf :: XGBoostBatchCSR -> Int

alignment :: XGBoostBatchCSR -> Int

peekElemOff :: Ptr XGBoostBatchCSR -> Int -> IO XGBoostBatchCSR

pokeElemOff :: Ptr XGBoostBatchCSR -> Int -> XGBoostBatchCSR -> IO ()

peekByteOff :: Ptr b -> Int -> IO XGBoostBatchCSR

pokeByteOff :: Ptr b -> Int -> XGBoostBatchCSR -> IO ()

peek :: Ptr XGBoostBatchCSR -> IO XGBoostBatchCSR

poke :: Ptr XGBoostBatchCSR -> XGBoostBatchCSR -> IO ()

Storable XGBoostBatchCSR

Methods

peek :: Ptr XGBoostBatchCSR -> IO XGBoostBatchCSR

poke :: Ptr XGBoostBatchCSR -> XGBoostBatchCSR -> IO ()

type XGBCallbackSetData = Ptr ()

type XGBCallbackDataIterNext = Ptr ()

c_xgbGetLastError :: IO StringPtr

c_xgDMatrixCreateFromFile :: StringPtr -> Int32 -> Ptr DMatrix -> IO Int32

c_xgDMatrixCreateFromDataIter :: DataIter -> XGBCallbackDataIterNext -> StringPtr -> Ptr DMatrix -> IO Int32

c_xgDMatrixCreateFromMat :: FloatArray -> Word64 -> Word64 -> CFloat -> Ptr DMatrix -> IO Int32

c_xgDMatrixFree :: DMatrix -> IO Int32

c_xgDMatrixSaveBinary :: DMatrix -> StringPtr -> Int32 -> IO Int32

c_xgDMatrixSetFloatInfo :: DMatrix -> StringPtr -> FloatArray -> Word64 -> IO Int32

c_xgDMatrixSetUIntInfo :: DMatrix -> StringPtr -> UIntArray -> Word64 -> IO Int32

c_xgDMatrixGetFloatInfo :: DMatrix -> StringPtr -> Ptr Word64 -> Ptr FloatArray -> IO Int32

c_xgDMatrixGetUIntInfo :: DMatrix -> StringPtr -> Ptr Word64 -> Ptr UIntArray -> IO Int32

c_xgDMatrixNumRow :: DMatrix -> Ptr Word64 -> IO Int32

c_xgDMatrixNumCol :: DMatrix -> Ptr Word64 -> IO Int32

c_xgBoosterCreate :: DMatrixArray -> Word64 -> Ptr Booster -> IO Int32

c_xgBoosterFree :: Booster -> IO Int32

c_xgBoosterSetParam :: Booster -> StringPtr -> StringPtr -> IO Int32

c_xgBoosterUpdateOneIter :: Booster -> Int32 -> DMatrix -> IO Int32

c_xgBoosterBoostOneIter :: Booster -> DMatrix -> FloatArray -> FloatArray -> Word64 -> IO Int32

c_xgBoosterEvalOneIter :: Booster -> Int32 -> DMatrixArray -> StringArray -> Word64 -> Ptr StringPtr -> IO Int32

c_xgBoosterPredict :: Booster -> DMatrix -> Int32 -> Int32 -> Ptr Word64 -> Ptr FloatArray -> IO Int32

c_xgBoosterLoadModel :: Booster -> StringPtr -> IO Int32

c_xgBoosterSaveModel :: Booster -> StringPtr -> IO Int32

c_xgBoosterLoadModelFromBuffer :: Booster -> ByteArray -> Word64 -> IO Int32

c_xgBoosterGetModelRaw :: Booster -> Ptr Word64 -> Ptr ByteArray -> IO Int32

c_xgBoosterDumpModel :: Booster -> StringArray -> Int32 -> Ptr Word64 -> Ptr StringArray -> IO Int32

c_xgBoosterGetAttr :: Booster -> StringPtr -> Ptr StringPtr -> Ptr Int32 -> IO Int32

c_xgBoosterSetAttr :: Booster -> StringPtr -> StringPtr -> IO Int32

c_xgBoosterGetAttrNames :: Booster -> Ptr Word64 -> Ptr StringArray -> IO Int32

c_xgBoosterLoadRabitCheckpoint :: Booster -> Ptr Int32 -> IO Int32

c_xgBoosterSaveRabitCheckpoint :: Booster -> IO Int32

data FloatInfoField

In XGBoost, the float info is correctly restricted to DMatrix's meta information, namely label and weight.

Ref: https:github.comdmlcxgboostissues1026#issuecomment-199873890.

Constructors

LabelInfo

WeightInfo

BaseMarginInfo

Instances

Eq FloatInfoField

Methods

(==) :: FloatInfoField -> FloatInfoField -> Bool

(/=) :: FloatInfoField -> FloatInfoField -> Bool

Show FloatInfoField

Methods

showsPrec :: Int -> FloatInfoField -> ShowS

show :: FloatInfoField -> String

showList :: [FloatInfoField] -> ShowS

data UIntInfoField

In XGBoost, the only uint field valid is "root_index".

Ref: https:github.comdmlcxgboostissues1787#issuecomment-261653748.

Constructors

RootIndexInfo

Instances

Eq UIntInfoField

Methods

(==) :: UIntInfoField -> UIntInfoField -> Bool

(/=) :: UIntInfoField -> UIntInfoField -> Bool

Show UIntInfoField

Methods

showsPrec :: Int -> UIntInfoField -> ShowS

show :: UIntInfoField -> String

showList :: [UIntInfoField] -> ShowS

data PredictMask

See https://github.com/dmlc/xgboost/blob/master/include/xgboost/c_api.h#L399

Constructors

Normal

Margin

LeafIndex

FeatureContrib

Instances

Enum PredictMask

Methods

succ :: PredictMask -> PredictMask

pred :: PredictMask -> PredictMask

toEnum :: Int -> PredictMask

fromEnum :: PredictMask -> Int

enumFrom :: PredictMask -> [PredictMask]

enumFromThen :: PredictMask -> PredictMask -> [PredictMask]

enumFromTo :: PredictMask -> PredictMask -> [PredictMask]

enumFromThenTo :: PredictMask -> PredictMask -> PredictMask -> [PredictMask]

guard_ffi :: IO Int32 -> IO ()

xgbGetLastError :: IO String

xgbFromFile

Arguments

:: String

file name

-> Bool

print messages during loading

-> IO DMatrix

xgbFromDataIter :: DataIter -> XGBCallbackDataIterNext -> String -> IO DMatrix

xgbFromMat

Arguments

:: UArray Float

mat

-> Int

rows

-> Int

columns

-> Float

missing value

-> IO DMatrix

dmatrixFree :: DMatrix -> IO ()

xgbSetFloatInfo

Arguments

:: DMatrix

-> FloatInfoField

label field

-> UArray Float

info vector

-> IO ()

xgbGetFloatInfo

Arguments

:: DMatrix

-> FloatInfoField

label field

-> IO (UArray Float)

info vector

xgbGetLabel :: DMatrix -> IO (UArray Float)

xgbGetWeight :: DMatrix -> IO (UArray Float)

xgbGetBaseMargin :: DMatrix -> IO (UArray Float)

xgbSetLabel :: DMatrix -> UArray Float -> IO ()

xgbSetWeight :: DMatrix -> UArray Float -> IO ()

xgbSetBaseMargin :: DMatrix -> UArray Float -> IO ()

xgbSetUIntInfo

Arguments

:: DMatrix

-> UIntInfoField

label field

-> UArray Word32

info vector

-> IO ()

xgbGetUIntInfo

Arguments

:: DMatrix

-> UIntInfoField

label field

-> IO (UArray Word32)

info vector

xgbMatRow :: DMatrix -> IO Integer

xgbMatCol :: DMatrix -> IO Integer

xgbBooster :: [DMatrix] -> IO Booster

boosterFree :: Booster -> IO ()

setParam

Arguments

:: Booster

-> String

Name of parameter.

-> String

Value of parameter.

-> IO ()

updateOneIter

Arguments

:: Booster

-> Int32

Current iteration rounds

-> DMatrix

Training data

-> IO ()

boostOneIter

Arguments

:: Booster

-> DMatrix

Training data

-> UArray Float

Gradient statistics

-> UArray Float

Second order gradient statistics, should have the same length with gradient statistics array (but not checked)

-> IO ()

evalOneIter

Arguments

:: Booster

-> Int32

Current iteration rounds

-> [DMatrix]

Pointers to data to be evaluated

-> [String]

Names of each data, should have the same length with data array (but not checked)

-> IO String

The string containing evaluation statistics

boosterPredict :: Booster -> DMatrix -> [PredictMask] -> Int32 -> IO (UArray Float)

loadModel

Arguments

:: Booster

-> String

File name

-> IO ()

saveModel

Arguments

:: Booster

-> String

File name

-> IO ()

loadModelFromBuffer

Arguments

:: Booster

-> ByteArray

Pointer to buffer

-> Int32

-> IO ()

getBoosterAttr :: Booster -> String -> IO String

setBoosterAttr :: Booster -> String -> String -> IO ()

getAttrNames :: Booster -> IO [String]

loadRabitCheckpoint

Arguments

:: Booster

-> IO Int32

Return output version of the model

saveRabitCheckpoint :: Booster -> IO ()