com.feedzai.openml.provider.lightgbm

Enum LightGBMAlgorithms

java.lang.Object

java.lang.Enum<LightGBMAlgorithms>

com.feedzai.openml.provider.lightgbm.LightGBMAlgorithms

All Implemented Interfaces:

com.feedzai.openml.util.algorithm.MLAlgorithmEnum, Serializable, Comparable<LightGBMAlgorithms>

public enum LightGBMAlgorithms
extends Enum<LightGBMAlgorithms>
implements com.feedzai.openml.util.algorithm.MLAlgorithmEnum

Specifies the LightGBM algorithms that can be imported.

Author:

Alberto Ferreira (alberto.ferreira@feedzai.com)

Since:

1.0.10

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIRGBM_BINARY_CLASSIFIER FairGBM binary classifier algorithm.
LIGHTGBM_BINARY_CLASSIFIER LightGBM binary classifier algorithm.

Field Summary

Fields inherited from interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum

logger

Method Summary

Modifier and Type	Method and Description
com.feedzai.openml.provider.descriptor.MLAlgorithmDescriptor	getAlgorithmDescriptor()
static LightGBMAlgorithms	valueOf(String name) Returns the enum constant of this type with the specified name.
static LightGBMAlgorithms[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum

createDescriptor, getByName, getDescriptors, getName

Enum Constant Detail

LIGHTGBM_BINARY_CLASSIFIER

public static final LightGBMAlgorithms LIGHTGBM_BINARY_CLASSIFIER

LightGBM binary classifier algorithm.

FAIRGBM_BINARY_CLASSIFIER

public static final LightGBMAlgorithms FAIRGBM_BINARY_CLASSIFIER

FairGBM binary classifier algorithm.

Method Detail

values

public static LightGBMAlgorithms[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LightGBMAlgorithms c : LightGBMAlgorithms.values())
    System.out.println(c);

Returns:

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

valueOf

public static LightGBMAlgorithms valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getAlgorithmDescriptor

public com.feedzai.openml.provider.descriptor.MLAlgorithmDescriptor getAlgorithmDescriptor()

Specified by:

getAlgorithmDescriptor in interface com.feedzai.openml.util.algorithm.MLAlgorithmEnum