Package org.tribuo.common.xgboost

Enum Class XGBoostTrainer.TreeMethod

java.lang.Object

java.lang.Enum<XGBoostTrainer.TreeMethod>

org.tribuo.common.xgboost.XGBoostTrainer.TreeMethod

All Implemented Interfaces:

Serializable, Comparable<XGBoostTrainer.TreeMethod>, Constable

Enclosing class:

XGBoostTrainer<T extends Output<T>>

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

The tree building algorithm.

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
APPROX	Approximate greedy algorithm, using a quantile sketch of the data and a gradient histogram.
AUTO	XGBoost chooses between EXACT and APPROX depending on dataset size.
EXACT	Exact greedy algorithm, enumerates all split candidates.
GPU_HIST	GPU implementation of the HIST algorithm.
HIST	Faster histogram optimized approximate algorithm.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static XGBoostTrainer.TreeMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XGBoostTrainer.TreeMethod[]	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

AUTO

public static final XGBoostTrainer.TreeMethod AUTO

XGBoost chooses between EXACT and APPROX depending on dataset size.

EXACT

public static final XGBoostTrainer.TreeMethod EXACT

Exact greedy algorithm, enumerates all split candidates.

APPROX

public static final XGBoostTrainer.TreeMethod APPROX

Approximate greedy algorithm, using a quantile sketch of the data and a gradient histogram.

HIST

public static final XGBoostTrainer.TreeMethod HIST

Faster histogram optimized approximate algorithm.

GPU_HIST

public static final XGBoostTrainer.TreeMethod GPU_HIST

GPU implementation of the HIST algorithm.

Note: GPU computation may not be supported on all platforms, and Tribuo is not tested with XGBoost GPU support.

Field Details

paramName

public final String paramName

The parameter name used by the XGBoost native library.

Method Details

values

public static XGBoostTrainer.TreeMethod[] 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.TreeMethod 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