com.feedzai.openml.provider.lightgbm

Class LightGBMModelCreator

java.lang.Object

com.feedzai.openml.provider.lightgbm.LightGBMModelCreator

All Implemented Interfaces:

com.feedzai.openml.provider.model.MachineLearningModelLoader<LightGBMBinaryClassificationModel>, com.feedzai.openml.provider.model.MachineLearningModelTrainer<LightGBMBinaryClassificationModel>

public class LightGBMModelCreator
extends Object
implements com.feedzai.openml.provider.model.MachineLearningModelTrainer<LightGBMBinaryClassificationModel>

Loads and/or fits LightGBM models.

Author:

Alberto Ferreira (alberto.ferreira@feedzai.com)

Since:

1.0.10

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_BINARY_RESOURCE_FILE_NAME LightGBM model resource file name inside the mode folder, when model is saved/loaded in/from directory.

Constructor Summary

Constructors

Constructor and Description
LightGBMModelCreator() Constructor.

Method Summary

Modifier and Type	Method and Description
LightGBMBinaryClassificationModel	fit(com.feedzai.openml.data.Dataset dataset, Random random, Map<String,String> params)
LightGBMBinaryClassificationModel	loadModel(Path modelPath, com.feedzai.openml.data.schema.DatasetSchema schema)
com.feedzai.openml.data.schema.DatasetSchema	loadSchema(Path modelPath)
List<com.feedzai.openml.provider.descriptor.fieldtype.ParamValidationError>	validateForFit(Path pathToPersist, com.feedzai.openml.data.schema.DatasetSchema schema, Map<String,String> params)
List<com.feedzai.openml.provider.descriptor.fieldtype.ParamValidationError>	validateForLoad(Path modelPath, com.feedzai.openml.data.schema.DatasetSchema schema, Map<String,String> params)

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_BINARY_RESOURCE_FILE_NAME

public static final String MODEL_BINARY_RESOURCE_FILE_NAME

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

See Also:

Constant Field Values

Constructor Detail

LightGBMModelCreator

public LightGBMModelCreator()

Constructor. Must load the libraries so that the rest of the classes work. Without the libraries instantiated, not even LightGBM exceptions can be thrown.

Method Detail

fit

public LightGBMBinaryClassificationModel fit(com.feedzai.openml.data.Dataset dataset,
                                             Random random,
                                             Map<String,String> params)

Specified by:

fit in interface com.feedzai.openml.provider.model.MachineLearningModelTrainer<LightGBMBinaryClassificationModel>

validateForFit

public List<com.feedzai.openml.provider.descriptor.fieldtype.ParamValidationError> validateForFit(Path pathToPersist,
                                                                                                  com.feedzai.openml.data.schema.DatasetSchema schema,
                                                                                                  Map<String,String> params)

Specified by:

validateForFit in interface com.feedzai.openml.provider.model.MachineLearningModelTrainer<LightGBMBinaryClassificationModel>

loadModel

public LightGBMBinaryClassificationModel loadModel(Path modelPath,
                                                   com.feedzai.openml.data.schema.DatasetSchema schema)
                                            throws com.feedzai.openml.provider.exception.ModelLoadingException

Specified by:

loadModel in interface com.feedzai.openml.provider.model.MachineLearningModelLoader<LightGBMBinaryClassificationModel>

Throws:

com.feedzai.openml.provider.exception.ModelLoadingException

validateForLoad

public List<com.feedzai.openml.provider.descriptor.fieldtype.ParamValidationError> validateForLoad(Path modelPath,
                                                                                                   com.feedzai.openml.data.schema.DatasetSchema schema,
                                                                                                   Map<String,String> params)

Specified by:

validateForLoad in interface com.feedzai.openml.provider.model.MachineLearningModelLoader<LightGBMBinaryClassificationModel>

loadSchema

public com.feedzai.openml.data.schema.DatasetSchema loadSchema(Path modelPath)
                                                        throws com.feedzai.openml.provider.exception.ModelLoadingException

Specified by:

loadSchema in interface com.feedzai.openml.provider.model.MachineLearningModelLoader<LightGBMBinaryClassificationModel>

Throws:

com.feedzai.openml.provider.exception.ModelLoadingException