com.feedzai.openml.python

Class ClassificationPythonModel

java.lang.Object

com.feedzai.openml.python.ClassificationPythonModel

All Implemented Interfaces:

com.feedzai.openml.model.ClassificationMLModel, com.feedzai.openml.model.MachineLearningModel, AutoCloseable

public class ClassificationPythonModel
extends Object
implements com.feedzai.openml.model.ClassificationMLModel

Representation of a Python classification model that has been loaded to the given Jep instance. The model should be in a "global" variable in the Jep instance with name id.

This representation is used for any Python based model including Scikit models and Generic user made models.

Some use cases can reuse this implementation and simply instantiate it with custom function names passed to the constructor.

Author:

Luis Reis (luis.reis@feedzai.com)

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CLASSIFY_FUNCTION_NAME Default name for the Python function that returns the index of the class for the prediction on a given instance.
static String	DEFAULT_GETCLASSDISTRIBUTION_FUNCTION_NAME Default name for the Python function that returns the probability distribution array for the prediction on a given instance.

Constructor Summary

Constructors

Constructor and Description
ClassificationPythonModel(JepInstance jepInstance, com.feedzai.openml.data.schema.DatasetSchema schema, String id) Constructor for this model's representation using default names for classification and scoring.
ClassificationPythonModel(JepInstance jepInstance, com.feedzai.openml.data.schema.DatasetSchema schema, String id, String classifyFunctionName, String getClassDistributionFunctionName) Constructor for this model's representation.

Method Summary

Modifier and Type	Method and Description
int	classify(com.feedzai.openml.data.Instance instance)
void	close()
double[]	getClassDistribution(com.feedzai.openml.data.Instance instance)
com.feedzai.openml.data.schema.DatasetSchema	getSchema()
boolean	save(Path dir, String name)
void	validate(JepInstance jepInstance, String id) Validates that the model's Jep environment has everything loaded and available.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLASSIFY_FUNCTION_NAME

public static final String DEFAULT_CLASSIFY_FUNCTION_NAME

Default name for the Python function that returns the index of the class for the prediction on a given instance.

See Also:

Constant Field Values

DEFAULT_GETCLASSDISTRIBUTION_FUNCTION_NAME

public static final String DEFAULT_GETCLASSDISTRIBUTION_FUNCTION_NAME

Default name for the Python function that returns the probability distribution array for the prediction on a given instance.

See Also:

Constant Field Values

Constructor Detail

ClassificationPythonModel

public ClassificationPythonModel(JepInstance jepInstance,
                                 com.feedzai.openml.data.schema.DatasetSchema schema,
                                 String id,
                                 String classifyFunctionName,
                                 String getClassDistributionFunctionName)

Constructor for this model's representation.

Parameters:

jepInstance - Jep instance where this model is loaded.

schema - Schema of the instances this model receives.

id - Name of the variable that stores this model in the Jep instance.

classifyFunctionName - Name of the Python function in the loaded model that returns the index of the class for the prediction on a given instance.

getClassDistributionFunctionName - Name of the Python function in the loaded model that returns the probability distribution array for the prediction on a given instance.

ClassificationPythonModel

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

Constructor for this model's representation using default names for classification and scoring.

Parameters:

jepInstance - Jep instance where this model is loaded.

schema - Schema of the instances this model receives.

id - Name of the variable that stores this model in the Jep instance.

Method Detail

save

public boolean save(Path dir,
                    String name)

Specified by:

save in interface com.feedzai.openml.model.MachineLearningModel

getSchema

public com.feedzai.openml.data.schema.DatasetSchema getSchema()

Specified by:

getSchema in interface com.feedzai.openml.model.MachineLearningModel

getClassDistribution

public double[] getClassDistribution(com.feedzai.openml.data.Instance instance)

Specified by:

getClassDistribution in interface com.feedzai.openml.model.ClassificationMLModel

classify

public int classify(com.feedzai.openml.data.Instance instance)

Specified by:

classify in interface com.feedzai.openml.model.ClassificationMLModel

validate

public void validate(JepInstance jepInstance,
                     String id)
              throws com.feedzai.openml.provider.exception.ModelLoadingException

Validates that the model's Jep environment has everything loaded and available.

Parameters:

jepInstance - The Jep environment.

id - The id with which the model has been declared in the environment.

Throws:

com.feedzai.openml.provider.exception.ModelLoadingException - If there is an error in the current environment.

close

public void close()

Specified by:

close in interface AutoCloseable