Package ai.libs.jaicore.ml.scikitwrapper

Interface IScikitLearnWrapper

  • All Superinterfaces:
    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.common.control.ILoggingCustomizable, 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>>
    All Known Implementing Classes:
    AScikitLearnWrapper, ASimpleScikitLearnWrapper, ScikitLearnClassificationWrapper, ScikitLearnMultiTargetRegressionWrapper, ScikitLearnRegressionWrapper, ScikitLearnTimeSeriesFeatureEngineeringWrapper, ScikitLearnTimeSeriesRegressionWrapper, SimpleScikitLearnClassifier, SimpleScikitLearnRegressor
    public interface IScikitLearnWrapper
extends 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
    Handles the execution of a scikit-learn pipeline in python and makes the according predictions available. A scikit-learn pipeline is a composition of one or multiple (ML) algorithms.
    See Also:
    scikit-learn: Pipelines and composite estimators

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void fit​(java.lang.String trainingDataName)  
      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.io.File getModelFile()  
      java.io.File getModelPath()  
      java.io.File getOutputFile​(java.lang.String dataName)  
      java.io.File getSKLearnScriptFile()  
      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)  

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

        fit

      • 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.common.control.ILoggingCustomizable

        getLoggerName, setLoggerName

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

        predict, predict, predict

    • Method Detail

      • setPythonTemplate

        void setPythonTemplate​(java.lang.String pythonTemplatePath)
                throws java.io.IOException
        Throws:
        java.io.IOException

      • setModelPath

        void setModelPath​(java.lang.String modelPath)
           throws java.io.IOException
        Throws:
        java.io.IOException

      • getModelPath

        java.io.File getModelPath()

      • setSeed

        void setSeed​(long seed)

      • setTimeout

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

      • fit

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

      • getDataName

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

      • getOutputFile

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

      • setPythonConfig

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

      • getSKLearnScriptFile

        java.io.File getSKLearnScriptFile()

      • getModelFile

        java.io.File getModelFile()

      • setTargetIndices

        void setTargetIndices​(int... targetIndices)