Package ai.libs.jaicore.ml.scikitwrapper.simple

Class ASimpleScikitLearnWrapper<P extends org.api4.java.ai.ml.core.evaluation.IPrediction,B extends org.api4.java.ai.ml.core.evaluation.IPredictionBatch>

java.lang.Object

ai.libs.jaicore.ml.core.learner.ASupervisedLearner<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>,P,B>

ai.libs.jaicore.ml.scikitwrapper.simple.ASimpleScikitLearnWrapper<P,B>

All Implemented Interfaces:

IScikitLearnWrapper, org.api4.java.ai.ml.core.learner.IFittable<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>>, org.api4.java.ai.ml.core.learner.IFittablePredictor<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>>, org.api4.java.ai.ml.core.learner.ILearnerConfigHandler, org.api4.java.ai.ml.core.learner.IPredictor<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>>, org.api4.java.ai.ml.core.learner.ISupervisedLearner<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>>, org.api4.java.common.control.ILoggingCustomizable

Direct Known Subclasses:

SimpleScikitLearnClassifier, SimpleScikitLearnRegressor

public abstract class ASimpleScikitLearnWrapper<P extends org.api4.java.ai.ml.core.evaluation.IPrediction,B extends org.api4.java.ai.ml.core.evaluation.IPredictionBatch>
extends ASupervisedLearner<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>,P,B>
implements IScikitLearnWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	constructorCall
protected java.lang.String	imports
protected java.lang.String	problem
static int	PYTHON_MINIMUM_REQUIRED_VERSION_MAJ
static int	PYTHON_MINIMUM_REQUIRED_VERSION_MIN
static int	PYTHON_MINIMUM_REQUIRED_VERSION_REL
protected static java.lang.String[]	PYTHON_OPTIONAL_MODULES
protected static java.lang.String[]	PYTHON_REQUIRED_MODULES
protected ai.libs.python.IPythonConfig	pythonC
protected IScikitLearnWrapperConfig	sklearnClassifierConfig
protected org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>	trainingData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ASimpleScikitLearnWrapper(java.lang.String constructorCall, java.lang.String imports, java.lang.String problem)
protected	ASimpleScikitLearnWrapper(java.lang.String constructorCall, java.lang.String imports, java.lang.String problem, ai.libs.python.IPythonConfig pythonConfig)

Method Summary

Modifier and Type	Method	Description
protected java.io.File	executePipeline(org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance> dTest)
void	fit(java.lang.String trainingDataName)
void	fit(org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance> dTrain)
java.lang.String	getDataName(org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance> data)
java.lang.String	getLoggerName()
java.io.File	getModelFile()
java.io.File	getModelPath()
java.io.File	getOutputFile(java.lang.String dataName)
java.io.File	getSKLearnScriptFile()
P	predict(org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance xTest)
B	predict(org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance[] dTest)
void	setLoggerName(java.lang.String name)
void	setModelPath(java.lang.String modelPath)
void	setPythonConfig(ai.libs.python.IPythonConfig pythonConfig)
void	setPythonTemplate(java.lang.String pythonTemplatePath)
void	setScikitLearnWrapperConfig(IScikitLearnWrapperConfig scikitLearnWrapperConfig)
void	setSeed(long seed)
void	setTargetIndices(int... targetIndices)
void	setTimeout(org.api4.java.algorithm.Timeout timeout)
java.lang.String	toString()

Methods inherited from class ai.libs.jaicore.ml.core.learner.ASupervisedLearner

fitAndPredict, fitAndPredict, fitAndPredict, getConfig, predict, setConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.api4.java.ai.ml.core.learner.IFittablePredictor

fitAndPredict, fitAndPredict, fitAndPredict

Methods inherited from interface org.api4.java.ai.ml.core.learner.ILearnerConfigHandler

getConfig, setConfig

Methods inherited from interface org.api4.java.ai.ml.core.learner.IPredictor

predict

Field Detail

PYTHON_MINIMUM_REQUIRED_VERSION_REL

public static final int PYTHON_MINIMUM_REQUIRED_VERSION_REL

See Also:

Constant Field Values

PYTHON_MINIMUM_REQUIRED_VERSION_MAJ

public static final int PYTHON_MINIMUM_REQUIRED_VERSION_MAJ

See Also:

Constant Field Values

PYTHON_MINIMUM_REQUIRED_VERSION_MIN

public static final int PYTHON_MINIMUM_REQUIRED_VERSION_MIN

See Also:

Constant Field Values

PYTHON_REQUIRED_MODULES

protected static final java.lang.String[] PYTHON_REQUIRED_MODULES

PYTHON_OPTIONAL_MODULES

protected static final java.lang.String[] PYTHON_OPTIONAL_MODULES

sklearnClassifierConfig

protected IScikitLearnWrapperConfig sklearnClassifierConfig

pythonC

protected ai.libs.python.IPythonConfig pythonC

problem

protected final java.lang.String problem

constructorCall

protected final java.lang.String constructorCall

imports

protected final java.lang.String imports

trainingData

protected org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance> trainingData

Constructor Detail

ASimpleScikitLearnWrapper

protected ASimpleScikitLearnWrapper(java.lang.String constructorCall,
                                    java.lang.String imports,
                                    java.lang.String problem)
                             throws java.io.IOException,
                                    java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

ASimpleScikitLearnWrapper

protected ASimpleScikitLearnWrapper(java.lang.String constructorCall,
                                    java.lang.String imports,
                                    java.lang.String problem,
                                    ai.libs.python.IPythonConfig pythonConfig)
                             throws java.io.IOException,
                                    java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

Method Detail

fit

public void fit(org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance> dTrain)
         throws org.api4.java.ai.ml.core.exception.TrainingException,
                java.lang.InterruptedException

Specified by:

fit in interface org.api4.java.ai.ml.core.learner.IFittable<P extends org.api4.java.ai.ml.core.evaluation.IPrediction,B extends org.api4.java.ai.ml.core.evaluation.IPredictionBatch>

Throws:

org.api4.java.ai.ml.core.exception.TrainingException

java.lang.InterruptedException

getLoggerName

public java.lang.String getLoggerName()

Specified by:

getLoggerName in interface org.api4.java.common.control.ILoggingCustomizable

setLoggerName

public void setLoggerName(java.lang.String name)

Specified by:

setLoggerName in interface org.api4.java.common.control.ILoggingCustomizable

executePipeline

protected java.io.File executePipeline(org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance> dTest)
                                throws java.io.IOException,
                                       java.lang.InterruptedException,
                                       ScikitLearnWrapperExecutionFailedException

Throws:

java.io.IOException

java.lang.InterruptedException

ScikitLearnWrapperExecutionFailedException

setModelPath

public void setModelPath(java.lang.String modelPath)
                  throws java.io.IOException

Specified by:

setModelPath in interface IScikitLearnWrapper

Throws:

java.io.IOException

getModelPath

public java.io.File getModelPath()

Specified by:

getModelPath in interface IScikitLearnWrapper

getModelFile

public java.io.File getModelFile()

Specified by:

getModelFile in interface IScikitLearnWrapper

setTargetIndices

public void setTargetIndices(int... targetIndices)

Specified by:

setTargetIndices in interface IScikitLearnWrapper

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setSeed

public void setSeed(long seed)

Specified by:

setSeed in interface IScikitLearnWrapper

setTimeout

public void setTimeout(org.api4.java.algorithm.Timeout timeout)

Specified by:

setTimeout in interface IScikitLearnWrapper

fit

public void fit(java.lang.String trainingDataName)
         throws org.api4.java.ai.ml.core.exception.TrainingException,
                java.lang.InterruptedException

Specified by:

fit in interface IScikitLearnWrapper

Throws:

org.api4.java.ai.ml.core.exception.TrainingException

java.lang.InterruptedException

getOutputFile

public java.io.File getOutputFile(java.lang.String dataName)

Specified by:

getOutputFile in interface IScikitLearnWrapper

setPythonTemplate

public void setPythonTemplate(java.lang.String pythonTemplatePath)
                       throws java.io.IOException

Specified by:

setPythonTemplate in interface IScikitLearnWrapper

Throws:

java.io.IOException

setPythonConfig

public void setPythonConfig(ai.libs.python.IPythonConfig pythonConfig)
                     throws java.io.IOException,
                            java.lang.InterruptedException

Specified by:

setPythonConfig in interface IScikitLearnWrapper

Throws:

java.io.IOException

java.lang.InterruptedException

setScikitLearnWrapperConfig

public void setScikitLearnWrapperConfig(IScikitLearnWrapperConfig scikitLearnWrapperConfig)

Specified by:

setScikitLearnWrapperConfig in interface IScikitLearnWrapper

getSKLearnScriptFile

public java.io.File getSKLearnScriptFile()

Specified by:

getSKLearnScriptFile in interface IScikitLearnWrapper

getDataName

public java.lang.String getDataName(org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance> data)

Specified by:

getDataName in interface IScikitLearnWrapper

predict

public B predict(org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance[] dTest)
          throws org.api4.java.ai.ml.core.exception.PredictionException,
                 java.lang.InterruptedException

Specified by:

predict in interface org.api4.java.ai.ml.core.learner.IPredictor<P extends org.api4.java.ai.ml.core.evaluation.IPrediction,B extends org.api4.java.ai.ml.core.evaluation.IPredictionBatch>

Specified by:

predict in class ASupervisedLearner<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>,P extends org.api4.java.ai.ml.core.evaluation.IPrediction,B extends org.api4.java.ai.ml.core.evaluation.IPredictionBatch>

Throws:

org.api4.java.ai.ml.core.exception.PredictionException

java.lang.InterruptedException

predict

public P predict(org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance xTest)
          throws org.api4.java.ai.ml.core.exception.PredictionException,
                 java.lang.InterruptedException

Specified by:

predict in interface org.api4.java.ai.ml.core.learner.IPredictor<P extends org.api4.java.ai.ml.core.evaluation.IPrediction,B extends org.api4.java.ai.ml.core.evaluation.IPredictionBatch>

Specified by:

predict in class ASupervisedLearner<org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance,org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<? extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledInstance>,P extends org.api4.java.ai.ml.core.evaluation.IPrediction,B extends org.api4.java.ai.ml.core.evaluation.IPredictionBatch>

Throws:

org.api4.java.ai.ml.core.exception.PredictionException

java.lang.InterruptedException