com.feedzai.openml.provider.lightgbm

Class FairGBMParamParserUtil

java.lang.Object

com.feedzai.openml.provider.lightgbm.FairGBMParamParserUtil

public class FairGBMParamParserUtil
extends Object

Utility to parse parameters specific to the FairGBM model.

Author:

Andre Cruz (andre.cruz@feedzai.com)

Since:

1.4.0

Method Summary

Modifier and Type	Method and Description
static Optional<Integer>	getConstraintGroupColumnIndex(Map<String,String> mapParams, com.feedzai.openml.data.schema.DatasetSchema schema) Gets the (canonical) index of the constraint group column.
static Optional<Integer>	getConstraintGroupColumnIndexWithoutLabel(Map<String,String> mapParams, com.feedzai.openml.data.schema.DatasetSchema schema) Gets the index of the constraint group column without the label column (LightGBM-specific format)
static boolean	isFairnessConstrained(Map<String,String> mapParams) Whether the given mapParams correspond to a constrained LightGBM objective (aka FairGBM).

Methods inherited from class java.lang.Object

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

Method Detail

isFairnessConstrained

public static boolean isFairnessConstrained(Map<String,String> mapParams)

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

Parameters:

mapParams - set of train parameters for LightGBM.

Returns:

whether it is a fairness constrained objective.

getConstraintGroupColumnIndex

public static Optional<Integer> getConstraintGroupColumnIndex(Map<String,String> mapParams,
                                                              com.feedzai.openml.data.schema.DatasetSchema schema)

Gets the (canonical) index of the constraint group column. NOTE: the constraint group column must be part of the features in the Dataset, but it may be ignored for training

Parameters:

mapParams - LightGBM train parameters.

schema - Schema of the dataset.

Returns:

the index of the constraint group column if one was provided, else returns an empty Optional.

getConstraintGroupColumnIndexWithoutLabel

public static Optional<Integer> getConstraintGroupColumnIndexWithoutLabel(Map<String,String> mapParams,
                                                                          com.feedzai.openml.data.schema.DatasetSchema schema)

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

Parameters:

mapParams - LightGBM train parameters.

schema - Schema of the dataset.

Returns:

the index of the constraint group column without the label if the constraint_group_column parameter was provided, else returns an empty Optional.