xgboost
|
The Booster
class is the gradient-boosted model for XGBoost.
More...
Modules | |
Prediction | |
These functions are used for running prediction and explanation algorithms. | |
Serialization | |
There are multiple ways to serialize a Booster object depending on the use case. | |
Functions | |
int | XGBoosterCreate (const DMatrixHandle dmats[], bst_ulong len, BoosterHandle *out) |
create xgboost learner More... | |
int | XGBoosterFree (BoosterHandle handle) |
free obj in handle 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 parameters More... | |
int | XGBoosterGetNumFeature (BoosterHandle handle, bst_ulong *out) |
get number of features More... | |
int | XGBoosterUpdateOneIter (BoosterHandle handle, int iter, DMatrixHandle dtrain) |
update the model in one round using dtrain More... | |
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 xgboost 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 dump More... | |
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 dump More... | |
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 dump More... | |
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 dump More... | |
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, const bst_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 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 the weight 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... | |
The Booster
class is the gradient-boosted model for XGBoost.
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.
handle | Handle to booster. |
out | Pointer to output integer. |
int XGBoosterBoostOneIter | ( | BoosterHandle | handle, |
DMatrixHandle | dtrain, | ||
float * | grad, | ||
float * | hess, | ||
bst_ulong | len | ||
) |
int XGBoosterCreate | ( | const DMatrixHandle | dmats[], |
bst_ulong | len, | ||
BoosterHandle * | out | ||
) |
create xgboost learner
dmats | matrices that are set to be cached |
len | length of dmats |
out | handle to the result booster |
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 dump
handle | handle |
fmap | name to fmap can be empty string |
with_stats | whether to dump with statistics |
out_len | length of output array |
out_dump_array | pointer to hold representing dump of each model |
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 dump
handle | handle |
fmap | name to fmap can be empty string |
with_stats | whether to dump with statistics |
format | the format to dump the model in |
out_len | length of output array |
out_dump_array | pointer to hold representing dump of each model |
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 dump
handle | handle |
fnum | number of features |
fname | names of features |
ftype | types of features |
with_stats | whether to dump with statistics |
format | the format to dump the model in |
out_len | length of output array |
out_models | pointer to hold representing dump of each model |
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 dump
handle | handle |
fnum | number of features |
fname | names of features |
ftype | types of features |
with_stats | whether to dump with statistics |
out_len | length of output array |
out_models | pointer to hold representing dump of each model |
int XGBoosterEvalOneIter | ( | BoosterHandle | handle, |
int | iter, | ||
DMatrixHandle | dmats[], | ||
const char * | evnames[], | ||
bst_ulong | len, | ||
const char ** | out_result | ||
) |
get evaluation statistics for xgboost
handle | handle |
iter | current iteration rounds |
dmats | pointers to data to be evaluated |
evnames | pointers to names of each data |
len | length of dmats |
out_result | the string containing evaluation statistics |
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 the weight
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.
handle | An instance of Booster |
config | Parameters for computing scores encoded as JSON. Accepted JSON keys are:
|
out_n_features | Length of output feature names. |
out_features | An array of string as feature names, ordered the same as output scores. |
out_dim | Dimension of output feature scores. |
out_shape | Shape of output feature scores with length of out_dim . |
out_scores | An array of floating point as feature scores with shape of out_shape . |
int XGBoosterFree | ( | BoosterHandle | handle | ) |
free obj in handle
handle | handle to be freed |
int XGBoosterGetAttr | ( | BoosterHandle | handle, |
const char * | key, | ||
const char ** | out, | ||
int * | success | ||
) |
Get string attribute from Booster.
handle | handle |
key | The key of the attribute. |
out | The result attribute, can be NULL if the attribute do not exist. |
success | Whether the result is contained in out. |
int XGBoosterGetAttrNames | ( | BoosterHandle | handle, |
bst_ulong * | out_len, | ||
const char *** | out | ||
) |
Get the names of all attribute from Booster.
handle | handle |
out_len | the argument to hold the output length |
out | pointer to hold the output attribute stings |
int XGBoosterGetNumFeature | ( | BoosterHandle | handle, |
bst_ulong * | out | ||
) |
get number of features
handle | Handle to booster. |
out | number of features |
int XGBoosterGetStrFeatureInfo | ( | BoosterHandle | handle, |
const char * | field, | ||
bst_ulong * | len, | ||
const char *** | out_features | ||
) |
Get string encoded feature info from Booster, similar to feature info in DMatrix.
Accepted fields are:
Caller is responsible for copying out the data, before next call to any API function of XGBoost.
handle | An instance of Booster |
field | Field name |
len | Size of output pointer features (number of strings returned). |
out_features | Address of a pointer to array of strings. Result is stored in thread local memory. |
int XGBoosterSetAttr | ( | BoosterHandle | handle, |
const char * | key, | ||
const char * | value | ||
) |
Set or delete string attribute.
handle | handle |
key | The key of the attribute. |
value | The value to be saved. If nullptr, the attribute would be deleted. |
int XGBoosterSetParam | ( | BoosterHandle | handle, |
const char * | name, | ||
const char * | value | ||
) |
set parameters
handle | handle |
name | parameter name |
value | value of parameter |
int XGBoosterSetStrFeatureInfo | ( | BoosterHandle | handle, |
const char * | field, | ||
const char ** | features, | ||
const bst_ulong | size | ||
) |
Set string encoded feature info in Booster, similar to the feature info in DMatrix.
Accepted fields are:
handle | An instance of Booster |
field | Field name |
features | Pointer to array of strings. |
size | Size of features pointer (number of strings passed in). |
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).
handle | Booster to be sliced. |
begin_layer | start of the slice |
end_layer | end of the slice; end_layer=0 is equivalent to end_layer=num_boost_round |
step | step size of the slice |
out | Sliced booster. |
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.
handle | handle |
dtrain | The training data. |
iter | The current iteration round. When training continuation is used, the count should restart. |
grad | Json encoded __(cuda)_array_interface__ for gradient. |
hess | Json encoded __(cuda)_array_interface__ for Hessian. |
int XGBoosterUpdateOneIter | ( | BoosterHandle | handle, |
int | iter, | ||
DMatrixHandle | dtrain | ||
) |
update the model in one round using dtrain
handle | handle |
iter | current iteration rounds |
dtrain | training data |