Package org.tribuo.common.xgboost

Enum Class XGBoostTrainer.BoosterType

java.lang.Object

java.lang.Enum<XGBoostTrainer.BoosterType>

org.tribuo.common.xgboost.XGBoostTrainer.BoosterType

All Implemented Interfaces:

Serializable, Comparable<XGBoostTrainer.BoosterType>, Constable

Enclosing class:

XGBoostTrainer<T extends Output<T>>

public static enum XGBoostTrainer.BoosterType
extends Enum<XGBoostTrainer.BoosterType>

The type of XGBoost model.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DART	A gradient boosted decision tree using dropout.
GBTREE	A gradient boosted decision tree.
LINEAR	A boosted linear model.

Field Summary

Fields

Modifier and Type	Field	Description
final String	paramName	The parameter value used by the XGBoost native library.

Method Summary

Modifier and Type	Method	Description
static XGBoostTrainer.BoosterType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XGBoostTrainer.BoosterType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LINEAR

public static final XGBoostTrainer.BoosterType LINEAR

A boosted linear model.

GBTREE

public static final XGBoostTrainer.BoosterType GBTREE

A gradient boosted decision tree.

DART

public static final XGBoostTrainer.BoosterType DART

A gradient boosted decision tree using dropout.

Field Details

paramName

public final String paramName

The parameter value used by the XGBoost native library.

Method Details

values

public static XGBoostTrainer.BoosterType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static XGBoostTrainer.BoosterType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null