Index

A C D E G H I L M N O P S T V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

APPROX - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
Approximate greedy algorithm, using a quantile sketch of the data and a gradient histogram.
AUTO - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
XGBoost chooses between XGBoostTrainer.TreeMethod.EXACT and XGBoostTrainer.TreeMethod.APPROX depending on dataset size.

C

convertBatchOutput(ImmutableOutputInfo<T>, List<float[][]>, int[], Example<T>[]) - Method in interface org.tribuo.common.xgboost.XGBoostOutputConverter
Converts a list of float arrays from XGBoost Boosters into a Tribuo Prediction.
convertDataset(Dataset<T>) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Converts a dataset into a DMatrix.
convertDataset(Dataset<T>, Function<T, Float>) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Converts a dataset into a DMatrix.
convertExample(Example<T>, ImmutableFeatureMap) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Converts an example into a DMatrix.
convertExample(Example<T>, ImmutableFeatureMap, Function<T, Float>) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Converts an example into a DMatrix.
convertExamples(Iterable<Example<T>>, ImmutableFeatureMap) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Converts an iterable of examples into a DMatrix.
convertExamples(Iterable<Example<T>>, ImmutableFeatureMap, Function<T, Float>) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Converts an iterable of examples into a DMatrix.
convertFeatures(SparseVector) - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 
convertFeaturesList(List<SparseVector>) - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 
convertOutput(float[][], int[], List<Example<T>>) - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 
convertOutput(float[][], int, Example<T>) - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 
convertOutput(ImmutableOutputInfo<T>, List<float[]>, int, Example<T>) - Method in interface org.tribuo.common.xgboost.XGBoostOutputConverter
Converts a list of float arrays from XGBoost Boosters into a Tribuo Prediction.
convertSingleExample(Example<T>, ImmutableFeatureMap, ArrayList<Float>, ArrayList<Integer>, ArrayList<Long>, long) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Writes out the features from an example into the three supplied ArrayLists.
convertSparseVector(SparseVector) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Used when predicting with an externally trained XGBoost model.
convertSparseVectors(List<SparseVector>) - Static method in class org.tribuo.common.xgboost.XGBoostTrainer
Used when predicting with an externally trained XGBoost model.
copy(String, ModelProvenance) - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 
copy(String, ModelProvenance) - Method in class org.tribuo.common.xgboost.XGBoostModel
 
copyParams(Map<String, ?>) - Method in class org.tribuo.common.xgboost.XGBoostTrainer
Returns a copy of the supplied parameter map which has the appropriate type for passing to XGBoost.train.
createModel(String, ModelProvenance, ImmutableFeatureMap, ImmutableOutputInfo<T>, List<Booster>, XGBoostOutputConverter<T>) - Method in class org.tribuo.common.xgboost.XGBoostTrainer
Creates an XGBoost model from the booster list.
createXGBoostModel(OutputFactory<T>, Map<String, Integer>, Map<T, Integer>, XGBoostOutputConverter<T>, String) - Static method in class org.tribuo.common.xgboost.XGBoostExternalModel
Creates an XGBoostExternalModel from the supplied model on disk.
createXGBoostModel(OutputFactory<T>, Map<String, Integer>, Map<T, Integer>, XGBoostOutputConverter<T>, Path) - Static method in class org.tribuo.common.xgboost.XGBoostExternalModel
Creates an XGBoostExternalModel from the supplied model on disk.
createXGBoostModel(OutputFactory<T>, Map<String, Integer>, Map<T, Integer>, XGBoostOutputConverter<T>, Booster, URL) - Static method in class org.tribuo.common.xgboost.XGBoostExternalModel
Deprecated.
As the URL argument must always be valid. To wrap an in-memory booster use XGBoostExternalModel.createXGBoostModel(OutputFactory, Map, Map, XGBoostOutputConverter, Booster, Map).
createXGBoostModel(OutputFactory<T>, Map<String, Integer>, Map<T, Integer>, XGBoostOutputConverter<T>, Booster, Map<String, Provenance>) - Static method in class org.tribuo.common.xgboost.XGBoostExternalModel
Creates an XGBoostExternalModel from the supplied in-memory XGBoost Booster.
CURRENT_VERSION - Static variable in class org.tribuo.common.xgboost.XGBoostExternalModel
Protobuf serialization version.
CURRENT_VERSION - Static variable in class org.tribuo.common.xgboost.XGBoostModel
Protobuf serialization version.

D

DART - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.BoosterType
A gradient boosted decision tree using dropout.
data - Variable in class org.tribuo.common.xgboost.XGBoostTrainer.DMatrixTuple
The data matrix.
DEBUG - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.LoggingVerbosity
All the logging.
deserializeFromProto(int, String, Any) - Static method in class org.tribuo.common.xgboost.XGBoostExternalModel
Deserialization factory.
deserializeFromProto(int, String, Any) - Static method in class org.tribuo.common.xgboost.XGBoostModel
Deserialization factory.
DMatrixTuple(DMatrix, int[], Example<T>[]) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer.DMatrixTuple
Constructs a tuple containing the data and some Tribuo metadata.

E

EXACT - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
Exact greedy algorithm, enumerates all split candidates.
examples - Variable in class org.tribuo.common.xgboost.XGBoostTrainer.DMatrixTuple
The examples.
externalPrediction(DMatrix) - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 

G

GBTREE - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.BoosterType
A gradient boosted decision tree.
generatesProbabilities() - Method in interface org.tribuo.common.xgboost.XGBoostOutputConverter
Does this converter produce probabilities?
getCover() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Cover measures the number of examples a given feature discriminates across, relative to the total number of examples all features discriminate across.
getCover() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance.XGBoostFeatureImportanceInstance
The number of examples a feature discriminates between.
getCover(int) - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Cover measures the number of examples a given feature discriminates across, relative to the total.
getExcuse(Example<T>) - Method in class org.tribuo.common.xgboost.XGBoostModel
 
getFeatureImportance() - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
Creates objects to report feature importance metrics for XGBoost.
getFeatureImportance() - Method in class org.tribuo.common.xgboost.XGBoostModel
Creates objects to report feature importance metrics for XGBoost.
getFeatureName() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance.XGBoostFeatureImportanceInstance
The feature name.
getGain() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Gain measures the improvement in accuracy that a feature brings to the branches on which it appears.
getGain() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance.XGBoostFeatureImportanceInstance
The information gain a feature provides when split on.
getGain(int) - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Gain measures the improvement in accuracy that a feature brings to the branches on which it appears.
getImportances() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Gets all the feature importances for all the features.
getImportances(int) - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Gets the feature importances for the top n features sorted by gain.
getInnerModels() - Method in class org.tribuo.common.xgboost.XGBoostModel
Returns an unmodifiable list containing a copy of each model.
getInvocationCount() - Method in class org.tribuo.common.xgboost.XGBoostTrainer
 
getModelDump() - Method in class org.tribuo.common.xgboost.XGBoostModel
Returns the string model dumps from each Booster.
getTopFeatures(int) - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 
getTopFeatures(int) - Method in class org.tribuo.common.xgboost.XGBoostModel
 
getTotalCover() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Total Cover is similar to cover, but not locally averaged by weight, and thus not skewed in the way that weight can be skewed.
getTotalCover() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance.XGBoostFeatureImportanceInstance
The total number of examples a feature discrimnates between.
getTotalCover(int) - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Total Cover is similar to cover, but not locally averaged by weight, and thus not skewed in the way that weight can be skewed.
getTotalGain() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Total Gain is similar to gain, but not locally averaged by weight, and thus not skewed in the way that weight can be skewed.
getTotalGain() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance.XGBoostFeatureImportanceInstance
The total gain across all times the feature is used to split.
getTotalGain(int) - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Total Gain is similar to gain, but not locally averaged by weight, and thus not skewed in the way that weight can be skewed.
getTypeWitness() - Method in interface org.tribuo.common.xgboost.XGBoostOutputConverter
Gets the type witness for the output this converter uses.
getWeight() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Weight measures the number a times a feature occurs in the model.
getWeight() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance.XGBoostFeatureImportanceInstance
The number of times a feature is used in the model.
getWeight(int) - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
Weight measures the number a times a feature occurs in the model.
GPU_HIST - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
GPU implementation of the XGBoostTrainer.TreeMethod.HIST algorithm.

H

HIST - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
Faster histogram optimized approximate algorithm.

I

INFO - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.LoggingVerbosity
Tree building info is logged as well as warnings.

L

LINEAR - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.BoosterType
A boosted linear model.

M

model - Variable in class org.tribuo.common.xgboost.XGBoostExternalModel
Transient as we rely upon the native serialisation mechanism to bytes rather than Java serializing the Booster.
models - Variable in class org.tribuo.common.xgboost.XGBoostModel
The XGBoost4J Boosters.

N

numTrees - Variable in class org.tribuo.common.xgboost.XGBoostTrainer
The number of trees to build.
numValidFeatures - Variable in class org.tribuo.common.xgboost.XGBoostTrainer.DMatrixTuple
The number of valid features in each example.

O

org.tribuo.common.xgboost - package org.tribuo.common.xgboost
Provides abstract classes for interfacing with XGBoost abstracting away all the Output dependent parts.
overrideParameters - Variable in class org.tribuo.common.xgboost.XGBoostTrainer
Override for the parameter map, must contain all parameters, including the objective function.

P

parameters - Variable in class org.tribuo.common.xgboost.XGBoostTrainer
The XGBoost parameter map, only accessed internally.
paramName - Variable in enum org.tribuo.common.xgboost.XGBoostTrainer.BoosterType
The parameter value used by the XGBoost native library.
paramName - Variable in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
The parameter name used by the XGBoost native library.
postConfig() - Method in class org.tribuo.common.xgboost.XGBoostTrainer
Used by the OLCUT configuration system, and should not be called by external code.
predict(Iterable<Example<T>>) - Method in class org.tribuo.common.xgboost.XGBoostModel
Uses the model to predict the label for multiple examples.
predict(Dataset<T>) - Method in class org.tribuo.common.xgboost.XGBoostModel
Uses the model to predict the labels for multiple examples contained in a data set.
predict(Example<T>) - Method in class org.tribuo.common.xgboost.XGBoostModel
 

S

serialize() - Method in class org.tribuo.common.xgboost.XGBoostExternalModel
 
serialize() - Method in class org.tribuo.common.xgboost.XGBoostModel
 
setInvocationCount(int) - Method in class org.tribuo.common.xgboost.XGBoostTrainer
 
setNumThreads(int) - Method in class org.tribuo.common.xgboost.XGBoostModel
Sets the number of threads to use at prediction time.
SILENT - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.LoggingVerbosity
No logging.

T

toString() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance
 
toString() - Method in class org.tribuo.common.xgboost.XGBoostFeatureImportance.XGBoostFeatureImportanceInstance
 
toString() - Method in class org.tribuo.common.xgboost.XGBoostTrainer
 
trainInvocationCounter - Variable in class org.tribuo.common.xgboost.XGBoostTrainer
Number of times the train method has been called on this object.

V

value - Variable in enum org.tribuo.common.xgboost.XGBoostTrainer.LoggingVerbosity
The log value used by the XGBoost native library.
valueOf(String) - Static method in enum org.tribuo.common.xgboost.XGBoostTrainer.BoosterType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.tribuo.common.xgboost.XGBoostTrainer.LoggingVerbosity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.tribuo.common.xgboost.XGBoostTrainer.BoosterType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.tribuo.common.xgboost.XGBoostTrainer.LoggingVerbosity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod
Returns an array containing the constants of this enum type, in the order they are declared.

W

WARNING - Enum constant in enum org.tribuo.common.xgboost.XGBoostTrainer.LoggingVerbosity
Only warnings are logged.

X

XGBoostExternalModel<T> - Class in org.tribuo.common.xgboost
A Model which wraps around a XGBoost.Booster which was trained by a system other than Tribuo.
XGBoostFeatureImportance - Class in org.tribuo.common.xgboost
Generate and collate feature importance information from the XGBoost model.
XGBoostFeatureImportance.XGBoostFeatureImportanceInstance - Class in org.tribuo.common.xgboost
An instance of feature importance values for a single feature.
XGBoostModel<T> - Class in org.tribuo.common.xgboost
A Model which wraps around a XGBoost.Booster.
XGBoostOutputConverter<T> - Interface in org.tribuo.common.xgboost
Converts the output of XGBoost into the appropriate prediction type.
XGBoostTrainer<T> - Class in org.tribuo.common.xgboost
A Trainer which wraps the XGBoost training procedure.
XGBoostTrainer() - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer
For olcut.
XGBoostTrainer(int) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer
Constructs an XGBoost trainer using the specified number of trees.
XGBoostTrainer(int, double, double, int, double, double, double, double, double, int, boolean, long) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer
Create an XGBoost trainer.
XGBoostTrainer(int, int, boolean) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer
Constructs an XGBoost trainer using the specified number of trees.
XGBoostTrainer(int, Map<String, Object>) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer
This gives direct access to the XGBoost parameter map.
XGBoostTrainer(XGBoostTrainer.BoosterType, XGBoostTrainer.TreeMethod, int, double, double, int, double, double, double, double, double, int, XGBoostTrainer.LoggingVerbosity, long) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer
Create an XGBoost trainer.
XGBoostTrainer.BoosterType - Enum in org.tribuo.common.xgboost
The type of XGBoost model.
XGBoostTrainer.DMatrixTuple<T> - Class in org.tribuo.common.xgboost
Tuple of a DMatrix, the number of valid features in each example, and the examples themselves.
XGBoostTrainer.LoggingVerbosity - Enum in org.tribuo.common.xgboost
The logging verbosity of the native library.
XGBoostTrainer.TreeMethod - Enum in org.tribuo.common.xgboost
The tree building algorithm.
XGBoostTrainer.XGBoostTrainerProvenance - Class in org.tribuo.common.xgboost
Deprecated.
Unused.
XGBoostTrainerProvenance(Map<String, Provenance>) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer.XGBoostTrainerProvenance
Deprecated.
Deserializes an XGBoostTrainerProvenance.
XGBoostTrainerProvenance(XGBoostTrainer<T>) - Constructor for class org.tribuo.common.xgboost.XGBoostTrainer.XGBoostTrainerProvenance
Deprecated.
Constructs an XGBoostTrainerProvenance
A C D E G H I L M N O P S T V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form