com.feedzai.openml.python

Class AbstractClassificationPythonModelLoaderImpl

java.lang.Object

com.feedzai.openml.python.AbstractClassificationPythonModelLoaderImpl

All Implemented Interfaces:

com.feedzai.openml.provider.model.MachineLearningModelLoader<ClassificationPythonModel>

public abstract class AbstractClassificationPythonModelLoaderImpl
extends Object
implements com.feedzai.openml.provider.model.MachineLearningModelLoader<ClassificationPythonModel>

Abstract implementation of a model loader for classification models implemented in Python. Any model loader that loads python models should extend this class. In theory the only thing a python model loader should need to implement is the getModelImpl(DatasetSchema, JepInstance, String) method, and even then it can be made very easy if the ClassificationPythonModel can be reused.

Author:

Luis Reis (luis.reis@feedzai.com)

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
AbstractClassificationPythonModelLoaderImpl()

Method Summary

Modifier and Type	Method and Description
protected ClassificationPythonModel	getModelImpl(com.feedzai.openml.data.schema.DatasetSchema schema, JepInstance jepInstance, String id) Gets the actual instance of the MachineLearningModel to use.
ClassificationPythonModel	loadModel(Path modelPath, com.feedzai.openml.data.schema.DatasetSchema schema)
com.feedzai.openml.data.schema.DatasetSchema	loadSchema(Path modelPath)
protected abstract void	modelLoadLogic(JepInstance jepInstance, String id, Path modelPath) Specific implementation of python logic that loads the model.
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

Constructor Detail

AbstractClassificationPythonModelLoaderImpl

public AbstractClassificationPythonModelLoaderImpl()

Method Detail

loadModel

public ClassificationPythonModel 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<ClassificationPythonModel>

Throws:

com.feedzai.openml.provider.exception.ModelLoadingException

getModelImpl

protected ClassificationPythonModel getModelImpl(com.feedzai.openml.data.schema.DatasetSchema schema,
                                                 JepInstance jepInstance,
                                                 String id)

Gets the actual instance of the MachineLearningModel to use.

Parameters:

schema - The DatasetSchema of the incoming instances.

jepInstance - The JepInstance that provides access to the python environment.

id - The identifier that has been assigned to the model.

Returns:

The concrete model implementation.

modelLoadLogic

protected abstract void modelLoadLogic(JepInstance jepInstance,
                                       String id,
                                       Path modelPath)
                                throws InterruptedException,
                                       ExecutionException,
                                       com.feedzai.openml.provider.exception.ModelLoadingException

Specific implementation of python logic that loads the model.

Parameters:

jepInstance - Instance of Jep that will store and handle the model.

id - Name of the variable on the Jep environment that will hold the model.

modelPath - Path to the model.

Throws:

InterruptedException - Exception that is thrown in case the Jep instance is closed during or before the evaluation of the model loading function.

ExecutionException - Exception that is thrown in case a JepException is thrown while loading the model.

com.feedzai.openml.provider.exception.ModelLoadingException - Generic exception for problems that may occur during model loading.

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<ClassificationPythonModel>

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<ClassificationPythonModel>

Throws:

com.feedzai.openml.provider.exception.ModelLoadingException