Class XGBoostModel<T extends Output<T>>
- All Implemented Interfaces:
com.oracle.labs.mlrg.olcut.provenance.Provenancable<ModelProvenance>,Serializable,ProtoSerializable<org.tribuo.protos.core.ModelProto>
Model which wraps around a XGBoost.Booster.
XGBoost is a fast implementation of gradient boosted decision trees.
Throws IllegalStateException if the XGBoost C++ library fails to load or throws an exception.
See:
Chen T, Guestrin C. "XGBoost: A Scalable Tree Boosting System" Proceedings of the 22nd ACM SIGKDD International Conference on Knowledge Discovery and Data Mining, 2016.and for the original algorithm:
Friedman JH. "Greedy Function Approximation: a Gradient Boosting Machine" Annals of statistics, 2001.
N.B.: XGBoost4J wraps the native C implementation of xgboost that links to various C libraries, including libgomp and glibc (on Linux). If you're running on Alpine, which does not natively use glibc, you'll need to install glibc into the container. On the macOS binary on Maven Central is compiled without OpenMP support, meaning that XGBoost is single threaded on macOS. You can recompile the macOS binary with OpenMP support after installing libomp from homebrew if necessary.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intProtobuf serialization version.protected List<ml.dmlc.xgboost4j.java.Booster> The XGBoost4J Boosters.Fields inherited from class org.tribuo.Model
ALL_OUTPUTS, BIAS_FEATURE, featureIDMap, generatesProbabilities, name, outputIDInfo, provenance, provenanceOutputFields inherited from interface org.tribuo.protos.ProtoSerializable
DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER -
Method Summary
Modifier and TypeMethodDescriptioncopy(String newName, ModelProvenance newProvenance) static XGBoostModel<?> deserializeFromProto(int version, String className, com.google.protobuf.Any message) Deserialization factory.Creates objects to report feature importance metrics for XGBoost.List<ml.dmlc.xgboost4j.java.Booster> Returns an unmodifiable list containing a copy of each model.Returns the string model dumps from each Booster.getTopFeatures(int n) List<Prediction<T>> Uses the model to predict the label for multiple examples.List<Prediction<T>> Uses the model to predict the labels for multiple examples contained in a data set.org.tribuo.protos.core.ModelProtovoidsetNumThreads(int threads) Sets the number of threads to use at prediction time.Methods inherited from class org.tribuo.Model
castModel, copy, createDataCarrier, deserialize, deserializeFromFile, deserializeFromStream, generatesProbabilities, getExcuses, getFeatureIDMap, getName, getOutputIDInfo, getProvenance, innerPredict, serializeToFile, serializeToStream, setName, toString, validate
-
Field Details
-
CURRENT_VERSION
-
models
-
-
Method Details
-
deserializeFromProto
public static XGBoostModel<?> deserializeFromProto(int version, String className, com.google.protobuf.Any message) throws com.google.protobuf.InvalidProtocolBufferException, ml.dmlc.xgboost4j.java.XGBoostError, IOException Deserialization factory.- Parameters:
version- The serialized object version.className- The class name.message- The serialized data.- Returns:
- The deserialized object.
- Throws:
com.google.protobuf.InvalidProtocolBufferException- If the protobuf could not be parsed from themessage.ml.dmlc.xgboost4j.java.XGBoostError- If the XGBoost byte array failed to parse.IOException- If the XGBoost byte array failed to parse.
-
getInnerModels
Returns an unmodifiable list containing a copy of each model.As XGBoost4J models don't expose a copy constructor this requires serializing each model to a byte array and rebuilding it, and is thus quite expensive.
- Returns:
- A copy of all of the models.
-
setNumThreads
Sets the number of threads to use at prediction time.If set to 0 sets nthreads = num hardware threads.
- Parameters:
threads- The new number of threads.
-
predict
Uses the model to predict the labels for multiple examples contained in a data set. -
predict
Uses the model to predict the label for multiple examples. -
predict
-
getFeatureImportance
Creates objects to report feature importance metrics for XGBoost. See the documentation ofXGBoostFeatureImportancefor more information on what those metrics mean. Typically this list will contain a single instance for the entire model. For multidimensional regression the list will have one entry per dimension, in dimension order.- Returns:
- The feature importance object(s).
-
getTopFeatures
-
getModelDump
Returns the string model dumps from each Booster.- Returns:
- The model dumps.
-
getExcuse
-
copy
-
serialize
-