Package ai.libs.mlplan.multiclass.sklearn.builder

Class MLPlanScikitLearnBuilder

  • All Implemented Interfaces:
    ai.libs.mlplan.core.IMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>, org.api4.java.common.control.ILoggingCustomizable
    public class MLPlanScikitLearnBuilder
extends ai.libs.mlplan.core.AMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ai.libs.mlplan.core.MLPlan<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>> build()  
      static MLPlanScikitLearnBuilder forClassification()  
      static MLPlanScikitLearnBuilder forClassificationWithUnlimitedLength()  
      static MLPlanScikitLearnBuilder forRegression()  
      static MLPlanScikitLearnBuilder forRUL()  
      AScikitLearnLearnerFactory getLearnerFactory()  
      MLPlanScikitLearnBuilder getSelf()  
      MLPlanScikitLearnBuilder withCandidateEvaluationTimeOut​(org.api4.java.algorithm.Timeout timeout)  
      MLPlanScikitLearnBuilder withProblemType​(ai.libs.mlplan.core.IProblemType<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>> problemType)  
      MLPlanScikitLearnBuilder withSeed​(long seed)  

      • Methods inherited from class ai.libs.mlplan.core.AMLPlanBuilder

        build, checkPreconditionsForInitialization, getAlgorithmConfig, getCandidateEvaluationTimeOut, getComponentParameterConfigurations, getComponents, getDataset, getHASCOFactory, getLearnerEvaluationFactoryForSearchPhase, getLearnerEvaluationFactoryForSelectionPhase, getLoggerName, getMetricForSearchPhase, getMetricForSelectionPhase, getNodeEvaluationTimeOut, getPipelineValidityCheckingNodeEvaluator, getPortionOfDataReservedForSelectionPhase, getPreferredComponents, getPreferredNodeEvaluators, getRequestedInterface, getSafeGuardFactory, getSearchEvaluatorFactory, getSearchSelectionDatasetSplitter, getSearchSpaceConfigFile, getSelectionEvaluatorFactory, getTimeOut, getTimeoutPrecautionOffsetInSeconds, setLoggerName, withAlgorithmConfig, withAlgorithmConfigFile, withDataset, withDatasetSplitterForSearchSelectionSplit, withLearnerFactory, withMCCVBasedCandidateEvaluationInSearchPhase, withMCCVBasedCandidateEvaluationInSelectionPhase, withNodeEvaluationTimeOut, withNumCpus, withPerformanceMeasure, withPerformanceMeasureForSearchPhase, withPerformanceMeasureForSelectionPhase, withPipelineValidityCheckingNodeEvaluator, withPortionOfDataReservedForSelection, withPreferredComponents, withPreferredComponentsFile, withPreferredNodeEvaluator, withRequestedInterface, withSafeGuardFactory, withSearchFactory, withSearchPhaseEvaluatorFactory, withSearchSpaceConfigFile, withSelectionPhaseEvaluatorFactory, withTimeOut, withTimeoutPrecautionOffsetInSeconds

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MLPlanScikitLearnBuilder

        protected MLPlanScikitLearnBuilder​(EMLPlanScikitLearnProblemType problemType)
                            throws java.io.IOException
        Creates a new ML-Plan Builder for scikit-learn.
        Throws:
        java.io.IOException - Thrown if configuration files cannot be read.

      • MLPlanScikitLearnBuilder

        public MLPlanScikitLearnBuilder​(EMLPlanScikitLearnProblemType problemType,
                                boolean skipSetupCheck)
                         throws java.io.IOException
        Creates a new ML-Plan Builder for scikit-learn.
        Parameters:
        skipSetupCheck - Flag whether to skip the system's setup check, which examines whether the operating system has python installed in the required version and all the required python modules are installed.
        Throws:
        java.io.IOException - Thrown if configuration files cannot be read.

    • Method Detail

      • forClassification

        public static MLPlanScikitLearnBuilder forClassification()
                                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • forClassificationWithUnlimitedLength

        public static MLPlanScikitLearnBuilder forClassificationWithUnlimitedLength()
                                                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • forRegression

        public static MLPlanScikitLearnBuilder forRegression()
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • withProblemType

        public MLPlanScikitLearnBuilder withProblemType​(ai.libs.mlplan.core.IProblemType<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>> problemType)
                                         throws java.io.IOException
        Overrides:
        withProblemType in class ai.libs.mlplan.core.AMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>
        Throws:
        java.io.IOException

      • withSeed

        public MLPlanScikitLearnBuilder withSeed​(long seed)
        Overrides:
        withSeed in class ai.libs.mlplan.core.AMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>

      • withCandidateEvaluationTimeOut

        public MLPlanScikitLearnBuilder withCandidateEvaluationTimeOut​(org.api4.java.algorithm.Timeout timeout)
        Overrides:
        withCandidateEvaluationTimeOut in class ai.libs.mlplan.core.AMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>

      • getLearnerFactory

        public AScikitLearnLearnerFactory getLearnerFactory()
        Specified by:
        getLearnerFactory in interface ai.libs.mlplan.core.IMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>
        Overrides:
        getLearnerFactory in class ai.libs.mlplan.core.AMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>

      • build

        public ai.libs.mlplan.core.MLPlan<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>> build()
        Overrides:
        build in class ai.libs.mlplan.core.AMLPlanBuilder<ai.libs.jaicore.ml.scikitwrapper.ScikitLearnWrapper<org.api4.java.ai.ml.core.evaluation.IPrediction,​org.api4.java.ai.ml.core.evaluation.IPredictionBatch>,​MLPlanScikitLearnBuilder>