org.tribuo.regression.xgboost

Class XGBoostRegressionConverter

java.lang.Object

org.tribuo.regression.xgboost.XGBoostRegressionConverter

All Implemented Interfaces:

Serializable, XGBoostOutputConverter<Regressor>

public final class XGBoostRegressionConverter
extends Object
implements XGBoostOutputConverter<Regressor>

Converts XGBoost outputs into Regressor Predictions.

Instances of this class are stateless and thread-safe.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XGBoostRegressionConverter() Construct an XGBoostRegressionConverter.

Method Summary

Modifier and Type	Method and Description
List<Prediction<Regressor>>	convertBatchOutput(ImmutableOutputInfo<Regressor> info, List<float[][]> probabilities, int[] numValidFeatures, Example<Regressor>[] examples) Converts a list of float arrays from XGBoost Boosters into a Tribuo Prediction.
Prediction<Regressor>	convertOutput(ImmutableOutputInfo<Regressor> info, List<float[]> probabilities, int numValidFeatures, Example<Regressor> example) Converts a list of float arrays from XGBoost Boosters into a Tribuo Prediction.
boolean	generatesProbabilities() Does this converter produce probabilities?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XGBoostRegressionConverter

public XGBoostRegressionConverter()

Construct an XGBoostRegressionConverter.

Method Detail

generatesProbabilities

public boolean generatesProbabilities()

Description copied from interface: XGBoostOutputConverter

Does this converter produce probabilities?

Specified by:

generatesProbabilities in interface XGBoostOutputConverter<Regressor>

Returns:

True if it produces probabilities.

convertOutput

public Prediction<Regressor> convertOutput(ImmutableOutputInfo<Regressor> info,
                                           List<float[]> probabilities,
                                           int numValidFeatures,
                                           Example<Regressor> example)

Description copied from interface: XGBoostOutputConverter

Converts a list of float arrays from XGBoost Boosters into a Tribuo Prediction.

Specified by:

convertOutput in interface XGBoostOutputConverter<Regressor>

Parameters:

info - The output info.

probabilities - The XGBoost output.

numValidFeatures - The number of valid features used in the prediction.

example - The example this prediction was generated from.

Returns:

The prediction object.

convertBatchOutput

public List<Prediction<Regressor>> convertBatchOutput(ImmutableOutputInfo<Regressor> info,
                                                      List<float[][]> probabilities,
                                                      int[] numValidFeatures,
                                                      Example<Regressor>[] examples)

Description copied from interface: XGBoostOutputConverter

Converts a list of float arrays from XGBoost Boosters into a Tribuo Prediction.

Specified by:

convertBatchOutput in interface XGBoostOutputConverter<Regressor>

Parameters:

info - The output info.

probabilities - The XGBoost output, list dimension is across models, first array dimension is across examples, second array dimension is across outputs.

numValidFeatures - The number of valid features used in each prediction.

examples - The examples these predictions were generated from.

Returns:

The prediction object.