A B C D F G I L M N S V

A

addConstraintGroupValue(int) - Method in class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Adds a value to the constraint group ChunkedArray.

addFeatureValue(double) - Method in class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Adds a value to the features' ChunkedArray.

addLabelValue(float) - Method in class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Adds a value to the labels' ChunkedArray.

AlgoDescriptorUtil - Class in com.feedzai.openml.provider.lightgbm

AlgoDescriptorUtil() - Constructor for class com.feedzai.openml.provider.lightgbm.AlgoDescriptorUtil

B

BAGGING_FRACTION_PARAMETER_NAME - Static variable in class com.feedzai.openml.provider.lightgbm.LightGBMDescriptorUtil

Bagging fraction parameter name.

BAGGING_FREQUENCY_PARAMETER_NAME - Static variable in class com.feedzai.openml.provider.lightgbm.LightGBMDescriptorUtil

Bagging frequency parameter name.

BOOSTING_TYPE_PARAMETER_NAME - Static variable in class com.feedzai.openml.provider.lightgbm.LightGBMDescriptorUtil

Boosting type parameter name.

C

classify(Instance) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

close() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

close() - Method in class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Release any allocated resources.

com.feedzai.openml.provider.lightgbm - package com.feedzai.openml.provider.lightgbm

OpenML LightGBM provider.

CONSTRAINT_GROUP_COLUMN_PARAMETER_NAME - Static variable in class com.feedzai.openml.provider.lightgbm.FairGBMDescriptorUtil

D

doubleRange(double, double, double) - Static method in class com.feedzai.openml.provider.lightgbm.AlgoDescriptorUtil

Helper method to return a range of type DOUBLE.

F

FairGBMDescriptorUtil - Class in com.feedzai.openml.provider.lightgbm

Utility to organize all the necessary Machine Learning Hyper-Parameters for configuring the training of LightGBM.

FairGBMDescriptorUtil() - Constructor for class com.feedzai.openml.provider.lightgbm.FairGBMDescriptorUtil

FairGBMMLProvider - Class in com.feedzai.openml.provider.lightgbm

This class implements Feedzai's OpenML MachineLearningProvider interface for FairGBM (constrained LightGBM).

FairGBMMLProvider() - Constructor for class com.feedzai.openml.provider.lightgbm.FairGBMMLProvider

FairGBMParamParserUtil - Class in com.feedzai.openml.provider.lightgbm

Utility to parse parameters specific to the FairGBM model.

fairnessConstrained - Variable in class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Whether the LightGBM model is fairness constrained (aka FairGBM).

FEATURE_FRACTION_PARAMETER_DESCRIPTION - Static variable in class com.feedzai.openml.provider.lightgbm.LightGBMDescriptorUtil

Public-visible (UI) description of the feature fraction parameter.

fit(Dataset, Random, Map<String, String>) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

G

getAlgorithmDescriptor() - Method in enum com.feedzai.openml.provider.lightgbm.LightGBMAlgorithms

getAlgorithms() - Method in class com.feedzai.openml.provider.lightgbm.FairGBMMLProvider

getAlgorithms() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMMLProvider

getBoosterFeatureNames() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

getBoosterNumFeatures() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

getBoosterNumIterations() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

getClassDistribution(Instance) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

getConstraintGroupColumnIndex(Map<String, String>, DatasetSchema) - Static method in class com.feedzai.openml.provider.lightgbm.FairGBMParamParserUtil

Gets the (canonical) index of the constraint group column.

getConstraintGroupColumnIndexWithoutLabel(Map<String, String>, DatasetSchema) - Static method in class com.feedzai.openml.provider.lightgbm.FairGBMParamParserUtil

Gets the index of the constraint group column without the label column (LightGBM-specific format)

getFeatureContributions(Instance) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMTreeSHAPFeatureContributionExplainer

getModelCreator(String) - Method in class com.feedzai.openml.provider.lightgbm.FairGBMMLProvider

getModelCreator(String) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMMLProvider

getName() - Method in class com.feedzai.openml.provider.lightgbm.FairGBMMLProvider

getName() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMMLProvider

getNumInstancesChunk() - Method in class com.feedzai.openml.provider.lightgbm.SWIGTrainData

getSchema() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

I

intRange(int, int, int) - Static method in class com.feedzai.openml.provider.lightgbm.AlgoDescriptorUtil

Helper method to return a range of type INT.

isFairnessConstrained(Map<String, String>) - Static method in class com.feedzai.openml.provider.lightgbm.FairGBMParamParserUtil

Whether the given mapParams correspond to a constrained LightGBM objective (aka FairGBM).

isModelBinary() - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

L

LightGBMAlgorithms - Enum in com.feedzai.openml.provider.lightgbm

Specifies the LightGBM algorithms that can be imported.

LightGBMBinaryClassificationModel - Class in com.feedzai.openml.provider.lightgbm

This class is responsible for loading a saved LightGBM model binary and scoring instances.

LightGBMDescriptorUtil - Class in com.feedzai.openml.provider.lightgbm

Utility to organize all the necessary Machine Learning Hyper-Parameters for configuring the training of LightGBM.

LightGBMDescriptorUtil() - Constructor for class com.feedzai.openml.provider.lightgbm.LightGBMDescriptorUtil

LightGBMException - Exception in com.feedzai.openml.provider.lightgbm

Many calls to the SWIG LightGBM interface can error out.

LightGBMException() - Constructor for exception com.feedzai.openml.provider.lightgbm.LightGBMException

Creates a new LightGBM RuntimeException to be used after a LightGBM SWIG call fails (returnCodeLGBM==-1).

LightGBMMLProvider - Class in com.feedzai.openml.provider.lightgbm

This class implements Feedzai's OpenML MachineLearningProvider interface for LightGBM.

LightGBMMLProvider() - Constructor for class com.feedzai.openml.provider.lightgbm.LightGBMMLProvider

LightGBMModelCreator - Class in com.feedzai.openml.provider.lightgbm

Loads and/or fits LightGBM models.

LightGBMModelCreator() - Constructor for class com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

Constructor.

LightGBMTreeSHAPFeatureContributionExplainer - Class in com.feedzai.openml.provider.lightgbm

A TreeSHAP feature contribution provider for the predictions of the LightGBMBinaryClassificationModel.

LightGBMTreeSHAPFeatureContributionExplainer(LightGBMBinaryClassificationModel) - Constructor for class com.feedzai.openml.provider.lightgbm.LightGBMTreeSHAPFeatureContributionExplainer

Constructor.

LightGBMUtils - Class in com.feedzai.openml.provider.lightgbm

Collection of util methods specific to the LightGBM OpenML Provider.

LightGBMUtils() - Constructor for class com.feedzai.openml.provider.lightgbm.LightGBMUtils

loadLibs() - Static method in class com.feedzai.openml.provider.lightgbm.LightGBMUtils

Loads the SWIG LightGBM dynamic libraries.

loadModel(Path, DatasetSchema) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

loadSchema(Path) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

M

MANDATORY - Static variable in class com.feedzai.openml.provider.lightgbm.AlgoDescriptorUtil

An alias to ease the readability of parameters' configuration that are not mandatory.

MODEL_BINARY_RESOURCE_FILE_NAME - Static variable in class com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

LightGBM model resource file name inside the mode folder, when model is saved/loaded in/from directory.

N

NOT_MANDATORY - Static variable in class com.feedzai.openml.provider.lightgbm.AlgoDescriptorUtil

An alias to ease the readability of parameters' configuration that are not mandatory.

NUM_ITERATIONS_PARAMETER_NAME - Static variable in class com.feedzai.openml.provider.lightgbm.LightGBMDescriptorUtil

The number of boosting iterations parameter name.

numFeatures - Variable in class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Number of features per instance.

S

save(Path, String) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMBinaryClassificationModel

SEED_PARAMETER_DESCRIPTION - Static variable in class com.feedzai.openml.provider.lightgbm.LightGBMDescriptorUtil

Global seed parameter name.

SWIGTrainData - Class in com.feedzai.openml.provider.lightgbm

Handles train data resources and provides basic operations to manipulate train data.

SWIGTrainData(int, long) - Constructor for class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Constructor.

SWIGTrainData(int, long, boolean) - Constructor for class com.feedzai.openml.provider.lightgbm.SWIGTrainData

Constructor.

V

validateForFit(Path, DatasetSchema, Map<String, String>) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

validateForLoad(Path, DatasetSchema, Map<String, String>) - Method in class com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

valueOf(String) - Static method in enum com.feedzai.openml.provider.lightgbm.LightGBMAlgorithms

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.feedzai.openml.provider.lightgbm.LightGBMAlgorithms

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

A B C D F G I L M N S V