Functions |
| void | XGBoostVersion (int *major, int *minor, int *patch) |
| | Return the version of the XGBoost library.More...
|
| |
| int | XGBuildInfo (char const **out) |
| | Get compile information of the shared XGBoost library.More...
|
| |
| const char * | XGBGetLastError () |
| | Get the string message of the last error.More...
|
| |
| int | XGBRegisterLogCallback (void(*callback)(const char *)) |
| | register callback function for LOG(INFO) messages – helpful messages that are not errors.More...
|
| |
| int | XGBSetGlobalConfig (char const *config) |
| | Set global configuration (collection of parameters that apply globally). This function accepts the list of key-value pairs representing the global-scope parameters to be configured. The list of key-value pairs are passed in as a JSON string.More...
|
| |
| int | XGBGetGlobalConfig (char const **out_config) |
| | Get current global configuration (collection of parameters that apply globally).More...
|
| |
| int | XGDMatrixCreateFromFile (const char *fname, int silent,DMatrixHandle *out) |
| | load a data matrixMore...
|
| |
| int | XGDMatrixCreateFromURI (char const *config,DMatrixHandle *out) |
| | load a data matrixMore...
|
| |
| int | XGDMatrixCreateFromColumnar (char const *data, char const *config,DMatrixHandle *out) |
| | Create a DMatrix from columnar data. (table)More...
|
| |
| int | XGDMatrixCreateFromCSR (char const *indptr, char const *indices, char const *data,bst_ulong ncol, char const *config,DMatrixHandle *out) |
| | Create a DMatrix from CSR matrix.More...
|
| |
| int | XGDMatrixCreateFromDense (char const *data, char const *config,DMatrixHandle *out) |
| | Create a DMatrix from dense array.More...
|
| |
| int | XGDMatrixCreateFromCSC (char const *indptr, char const *indices, char const *data,bst_ulong nrow, char const *config,DMatrixHandle *out) |
| | Create a DMatrix from a CSC matrix.More...
|
| |
| int | XGDMatrixCreateFromMat (const float *data,bst_ulong nrow,bst_ulong ncol, float missing,DMatrixHandle *out) |
| | create matrix content from dense matrixMore...
|
| |
| int | XGDMatrixCreateFromMat_omp (const float *data,bst_ulong nrow,bst_ulong ncol, float missing,DMatrixHandle *out, int nthread) |
| | create matrix content from dense matrixMore...
|
| |
| int | XGDMatrixCreateFromCudaColumnar (char const *data, char const *config,DMatrixHandle *out) |
| | Create DMatrix from CUDA columnar format. (cuDF)More...
|
| |
| int | XGDMatrixCreateFromCudaArrayInterface (char const *data, char const *config,DMatrixHandle *out) |
| | Create DMatrix from CUDA array.More...
|
| |
| int | XGDMatrixCreateFromDataIter (DataIterHandle data_handle,XGBCallbackDataIterNext *callback, const char *cache_info, float missing,DMatrixHandle *out) |
| | Create a DMatrix from a data iterator.More...
|
| |
| int | XGProxyDMatrixCreate (DMatrixHandle *out) |
| | Create a DMatrix proxy for setting data, can be freed byXGDMatrixFree.More...
|
| |
| int | XGDMatrixCreateFromCallback (DataIterHandle iter,DMatrixHandle proxy,DataIterResetCallback *reset,XGDMatrixCallbackNext *next, char const *config,DMatrixHandle *out) |
| | Create an external memory DMatrix with data iterator.More...
|
| |
| int | XGQuantileDMatrixCreateFromCallback (DataIterHandle iter,DMatrixHandle proxy,DataIterHandle ref,DataIterResetCallback *reset,XGDMatrixCallbackNext *next, char const *config,DMatrixHandle *out) |
| | Create a Quantile DMatrix with a data iterator.More...
|
| |
| int | XGExtMemQuantileDMatrixCreateFromCallback (DataIterHandle iter,DMatrixHandle proxy,DataIterHandle ref,DataIterResetCallback *reset,XGDMatrixCallbackNext *next, char const *config,DMatrixHandle *out) |
| | Create a Quantile DMatrix backed by external memory.More...
|
| |
| int | XGProxyDMatrixSetDataCudaArrayInterface (DMatrixHandle handle, const char *data) |
| | Set data on a DMatrix proxy.More...
|
| |
| int | XGProxyDMatrixSetDataColumnar (DMatrixHandle handle, char const *data) |
| | Set columnar (table) data on a DMatrix proxy.More...
|
| |
| int | XGProxyDMatrixSetDataCudaColumnar (DMatrixHandle handle, const char *data) |
| | Set CUDA-based columnar (table) data on a DMatrix proxy.More...
|
| |
| int | XGProxyDMatrixSetDataDense (DMatrixHandle handle, char const *data) |
| | Set data on a DMatrix proxy.More...
|
| |
| int | XGProxyDMatrixSetDataCSR (DMatrixHandle handle, char const *indptr, char const *indices, char const *data,bst_ulong ncol) |
| | Set data on a DMatrix proxy.More...
|
| |
| int | XGDMatrixSliceDMatrix (DMatrixHandle handle, const int *idxset,bst_ulong len,DMatrixHandle *out) |
| | create a new dmatrix from sliced content of existing matrixMore...
|
| |
| int | XGDMatrixSliceDMatrixEx (DMatrixHandle handle, const int *idxset,bst_ulong len,DMatrixHandle *out, int allow_groups) |
| | create a new dmatrix from sliced content of existing matrixMore...
|
| |
| int | XGDMatrixFree (DMatrixHandle handle) |
| | Free a DMatrix object.More...
|
| |
| int | XGDMatrixSaveBinary (DMatrixHandle handle, const char *fname, int silent) |
| | Save the DMatrix object into a file.QuantileDMatrix and external memory DMatrix are not supported.More...
|
| |
| int | XGDMatrixSetInfoFromInterface (DMatrixHandle handle, char const *field, char const *data) |
| | Set content in array interface to a content in info.More...
|
| |
| int | XGDMatrixSetFloatInfo (DMatrixHandle handle, const char *field, const float *array,bst_ulong len) |
| | set float vector to a content in infoMore...
|
| |
| int | XGDMatrixSetUIntInfo (DMatrixHandle handle, const char *field, const unsigned *array,bst_ulong len) |
| |
| int | XGDMatrixSetStrFeatureInfo (DMatrixHandle handle, const char *field, const char **features, constbst_ulong size) |
| | Set string encoded information of all features.More...
|
| |
| int | XGDMatrixGetStrFeatureInfo (DMatrixHandle handle, const char *field,bst_ulong *size, const char ***out_features) |
| | Get string encoded information of all features.More...
|
| |
| int | XGDMatrixSetDenseInfo (DMatrixHandle handle, const char *field, void const *data,bst_ulong size, int type) |
| |
| int | XGDMatrixGetFloatInfo (constDMatrixHandle handle, const char *field,bst_ulong *out_len, const float **out_dptr) |
| | get float info vector from matrix.More...
|
| |
| int | XGDMatrixGetUIntInfo (constDMatrixHandle handle, const char *field,bst_ulong *out_len, const unsigned **out_dptr) |
| | get uint32 info vector from matrixMore...
|
| |
| int | XGDMatrixNumRow (DMatrixHandle handle,bst_ulong *out) |
| | Get the number of rows from a DMatrix.More...
|
| |
| int | XGDMatrixNumCol (DMatrixHandle handle,bst_ulong *out) |
| | Get the number of columns from a DMatrix.More...
|
| |
| int | XGDMatrixNumNonMissing (DMatrixHandle handle,bst_ulong *out) |
| | Get number of valid values from a DMatrix.More...
|
| |
| int | XGDMatrixDataSplitMode (DMatrixHandle handle,bst_ulong *out) |
| | Get the data split mode from DMatrix.More...
|
| |
| int | XGDMatrixGetDataAsCSR (DMatrixHandle const handle, char const *config,bst_ulong *out_indptr, unsigned *out_indices, float *out_data) |
| | Get the predictors from DMatrix as CSR matrix for testing. If this is a quantized DMatrix, quantized values are returned instead.More...
|
| |
| int | XGDMatrixGetQuantileCut (DMatrixHandle const handle, char const *config, char const **out_indptr, char const **out_data) |
| | Export the quantile cuts used for training histogram-based models likehist andapprox. Useful for model compression.More...
|
| |
| int | XGBoosterCreate (constDMatrixHandle dmats[],bst_ulong len,BoosterHandle *out) |
| | Create a XGBoost learner (booster)More...
|
| |
| int | XGBoosterFree (BoosterHandle handle) |
| | Delete the booster.More...
|
| |
| int | XGBoosterReset (BoosterHandle handle) |
| | Reset the booster object to release data caches used for training.More...
|
| |
| int | XGBoosterSlice (BoosterHandle handle, int begin_layer, int end_layer, int step,BoosterHandle *out) |
| | Slice a model using boosting index. The slice m:n indicates taking all trees that were fit during the boosting rounds m, (m+1), (m+2), ..., (n-1).More...
|
| |
| int | XGBoosterBoostedRounds (BoosterHandle handle, int *out) |
| | Get number of boosted rounds from gradient booster. When process_type is update, this number might drop due to removed tree.More...
|
| |
| int | XGBoosterSetParam (BoosterHandle handle, const char *name, const char *value) |
| | set parametersMore...
|
| |
| int | XGBoosterGetNumFeature (BoosterHandle handle,bst_ulong *out) |
| | get number of featuresMore...
|
| |
| int | XGBoosterUpdateOneIter (BoosterHandle handle, int iter,DMatrixHandle dtrain) |
| | update the model in one round using dtrainMore...
|
| |
| int | XGBoosterBoostOneIter (BoosterHandle handle,DMatrixHandle dtrain, float *grad, float *hess,bst_ulong len) |
| |
| int | XGBoosterTrainOneIter (BoosterHandle handle,DMatrixHandle dtrain, int iter, char const *grad, char const *hess) |
| | Update a model with gradient and Hessian. This is used for training with a custom objective function.More...
|
| |
| int | XGBoosterEvalOneIter (BoosterHandle handle, int iter,DMatrixHandle dmats[], const char *evnames[],bst_ulong len, const char **out_result) |
| | get evaluation statistics for xgboostMore...
|
| |
| int | XGBoosterPredict (BoosterHandle handle,DMatrixHandle dmat, int option_mask, unsigned ntree_limit, int training,bst_ulong *out_len, const float **out_result) |
| | make prediction based on dmat (deprecated, useXGBoosterPredictFromDMatrix instead)More...
|
| |
| int | XGBoosterPredictFromDMatrix (BoosterHandle handle,DMatrixHandle dmat, char const *config,bst_ulong const **out_shape,bst_ulong *out_dim, float const **out_result) |
| | Make prediction from DMatrix, replacingXGBoosterPredict.More...
|
| |
| int | XGBoosterPredictFromDense (BoosterHandle handle, char const *values, char const *config,DMatrixHandle m,bst_ulong const **out_shape,bst_ulong *out_dim, const float **out_result) |
| | Inplace prediction from CPU dense matrix.More...
|
| |
| int | XGBoosterPredictFromColumnar (BoosterHandle handle, char const *values, char const *config,DMatrixHandle m,bst_ulong const **out_shape,bst_ulong *out_dim, const float **out_result) |
| | Inplace prediction from CPU columnar data. (Table)More...
|
| |
| int | XGBoosterPredictFromCSR (BoosterHandle handle, char const *indptr, char const *indices, char const *values,bst_ulong ncol, char const *config,DMatrixHandle m,bst_ulong const **out_shape,bst_ulong *out_dim, const float **out_result) |
| | Inplace prediction from CPU CSR matrix.More...
|
| |
| int | XGBoosterPredictFromCudaArray (BoosterHandle handle, char const *values, char const *config,DMatrixHandle proxy,bst_ulong const **out_shape,bst_ulong *out_dim, const float **out_result) |
| | Inplace prediction from CUDA Dense matrix (cupy in Python).More...
|
| |
| int | XGBoosterPredictFromCudaColumnar (BoosterHandle handle, char const *data, char const *config,DMatrixHandle proxy,bst_ulong const **out_shape,bst_ulong *out_dim, const float **out_result) |
| | Inplace prediction from CUDA dense dataframe (cuDF in Python).More...
|
| |
| int | XGBoosterLoadModel (BoosterHandle handle, const char *fname) |
| | Load the model from an existing file.More...
|
| |
| int | XGBoosterSaveModel (BoosterHandle handle, const char *fname) |
| | Save the model into an existing file.More...
|
| |
| int | XGBoosterLoadModelFromBuffer (BoosterHandle handle, const void *buf,bst_ulong len) |
| | load model from in memory bufferMore...
|
| |
| int | XGBoosterSaveModelToBuffer (BoosterHandle handle, char const *config,bst_ulong *out_len, char const **out_dptr) |
| | Save model into raw bytes, return header of the array. User must copy the result out, before next xgboost call.More...
|
| |
| int | XGBoosterSerializeToBuffer (BoosterHandle handle,bst_ulong *out_len, const char **out_dptr) |
| | Memory snapshot based serialization method. Saves everything states into buffer.More...
|
| |
| int | XGBoosterUnserializeFromBuffer (BoosterHandle handle, const void *buf,bst_ulong len) |
| | Memory snapshot based serialization method. Loads the buffer returned fromXGBoosterSerializeToBuffer.More...
|
| |
| int | XGBoosterSaveJsonConfig (BoosterHandle handle,bst_ulong *out_len, char const **out_str) |
| | Save XGBoost's internal configuration into a JSON document. Currently the support is experimental, function signature may change in the future without notice.More...
|
| |
| int | XGBoosterLoadJsonConfig (BoosterHandle handle, char const *config) |
| | Load XGBoost's internal configuration from a JSON document. Currently the support is experimental, function signature may change in the future without notice.More...
|
| |
| int | XGBoosterDumpModel (BoosterHandle handle, const char *fmap, int with_stats,bst_ulong *out_len, const char ***out_dump_array) |
| | dump model, return array of strings representing model dumpMore...
|
| |
| int | XGBoosterDumpModelEx (BoosterHandle handle, const char *fmap, int with_stats, const char *format,bst_ulong *out_len, const char ***out_dump_array) |
| | dump model, return array of strings representing model dumpMore...
|
| |
| int | XGBoosterDumpModelWithFeatures (BoosterHandle handle, int fnum, const char **fname, const char **ftype, int with_stats,bst_ulong *out_len, const char ***out_models) |
| | dump model, return array of strings representing model dumpMore...
|
| |
| int | XGBoosterDumpModelExWithFeatures (BoosterHandle handle, int fnum, const char **fname, const char **ftype, int with_stats, const char *format,bst_ulong *out_len, const char ***out_models) |
| | dump model, return array of strings representing model dumpMore...
|
| |
| int | XGBoosterGetAttr (BoosterHandle handle, const char *key, const char **out, int *success) |
| | Get string attribute from Booster.More...
|
| |
| int | XGBoosterSetAttr (BoosterHandle handle, const char *key, const char *value) |
| | Set or delete string attribute.More...
|
| |
| int | XGBoosterGetAttrNames (BoosterHandle handle,bst_ulong *out_len, const char ***out) |
| | Get the names of all attribute from Booster.More...
|
| |
| int | XGBoosterSetStrFeatureInfo (BoosterHandle handle, const char *field, const char **features, constbst_ulong size) |
| | Set string encoded feature info in Booster, similar to the feature info in DMatrix.More...
|
| |
| int | XGBoosterGetStrFeatureInfo (BoosterHandle handle, const char *field,bst_ulong *len, const char ***out_features) |
| | Get string encoded feature info from Booster, similar to the feature info in DMatrix.More...
|
| |
| int | XGBoosterFeatureScore (BoosterHandle handle, const char *config,bst_ulong *out_n_features, char const ***out_features,bst_ulong *out_dim,bst_ulong const **out_shape, float const **out_scores) |
| | Calculate feature scores for tree models. When used on linear model, only theweight importance type is defined, and output scores is a row major matrix with shape [n_features, n_classes] for multi-class model. For tree model, out_n_feature is always equal to out_n_scores and has multiple definitions of importance type.More...
|
| |
| int | XGTrackerCreate (char const *config,TrackerHandle *handle) |
| | Create a new tracker.More...
|
| |
| int | XGTrackerWorkerArgs (TrackerHandle handle, char const **args) |
| | Get the arguments needed for running workers. This should be called afterXGTrackerRun().More...
|
| |
| int | XGTrackerRun (TrackerHandle handle, char const *config) |
| | Start the tracker. The tracker runs in the background and this function returns once the tracker is started.More...
|
| |
| int | XGTrackerWaitFor (TrackerHandle handle, char const *config) |
| | Wait for the tracker to finish, should be called afterXGTrackerRun(). This function will block until the tracker task is finished or timeout is reached.More...
|
| |
| int | XGTrackerFree (TrackerHandle handle) |
| | Free a tracker instance. This should be called afterXGTrackerWaitFor(). If the tracker is not properly waited, this function will shutdown all connections with the tracker, potentially leading to undefined behavior.More...
|
| |
| int | XGCommunicatorInit (char const *config) |
| | Initialize the collective communicator.More...
|
| |
| int | XGCommunicatorFinalize (void) |
| | Finalize the collective communicator.More...
|
| |
| int | XGCommunicatorGetRank (void) |
| | Get rank of the current process.More...
|
| |
| int | XGCommunicatorGetWorldSize (void) |
| | Get the total number of processes.More...
|
| |
| int | XGCommunicatorIsDistributed (void) |
| | Get if the communicator is distributed.More...
|
| |
| int | XGCommunicatorPrint (char const *message) |
| | Print the message to the tracker.More...
|
| |
| int | XGCommunicatorGetProcessorName (const char **name_str) |
| | Get the name of the processor.More...
|
| |
| int | XGCommunicatorBroadcast (void *send_receive_buffer, size_t size, int root) |
| | Broadcast a memory region to all others from root. This function is NOT thread-safe.More...
|
| |
| int | XGCommunicatorAllreduce (void *send_receive_buffer, size_t count, int data_type, int op) |
| | Perform in-place allreduce. This function is NOT thread-safe.More...
|
| |
