ai.libs.mlplan.core

Class MLPlanBuilder

java.lang.Object

ai.libs.mlplan.core.MLPlanBuilder

public class MLPlanBuilder
extends java.lang.Object

The MLPlanBuilder helps to easily configure and initialize ML-Plan with specific parameter settings. For convenient use, the MLPlanBuilder also offers methods for initializing ML-Plan with default configuration to use ML-Plan for single label classification in combination with WEKA or scikit-learn or for multi-label classification in combination with MEKA and consequently with WEKA (for baselearners of multi-label reduction strategies).

Constructor Summary

Constructors

Constructor and Description
MLPlanBuilder()
MLPlanBuilder(java.io.File searchSpaceConfigFile, java.io.File algorithmConfigFile, ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure performanceMeasure)
MLPlanBuilder(java.io.File searchSpaceConfigFile, java.io.File algorithmConfigFile, ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure performanceMeasure, PerformanceDBAdapter dbAdapter)

Method Summary

Modifier and Type	Method and Description
MLPlanClassifierConfig	getAlgorithmConfig()
PipelineEvaluator	getClassifierEvaluationInSearchPhase(weka.core.Instances data, int seed, int fullDatasetSize)
PipelineEvaluator	getClassifierEvaluationInSelectionPhase(weka.core.Instances data, int seed)
IClassifierFactory	getClassifierFactory()
java.util.Collection<ai.libs.hasco.model.Component>	getComponents()
PerformanceDBAdapter	getDBAdapter()
ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.IClassifierEvaluatorFactory	getFactoryForPipelineEvaluationInSearchPhase()
ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.IClassifierEvaluatorFactory	getFactoryForPipelineEvaluationInSelectionPhase()
ai.libs.hasco.core.HASCOFactory	getHASCOFactory()
ai.libs.jaicore.ml.evaluation.evaluators.weka.splitevaluation.ISplitBasedClassifierEvaluator<java.lang.Double>	getMultiLabelEvaluationMeasurementBridge(ai.libs.jaicore.ml.core.evaluation.measure.IMeasure<double[],java.lang.Double> measure)
ai.libs.jaicore.ml.core.evaluation.measure.multilabel.EMultilabelPerformanceMeasure	getMultiLabelPerformanceMeasure()
java.lang.String	getRequestedInterface()
ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter	getSearchPhaseDatasetSplitter()
ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter	getSearchSelectionDatasetSplitter()
java.io.File	getSearchSpaceConfigFile()
ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter	getSelectionPhaseDatasetSplitter()
ai.libs.jaicore.ml.evaluation.evaluators.weka.splitevaluation.ISplitBasedClassifierEvaluator<java.lang.Double>	getSingleLabelEvaluationMeasurementBridge(ai.libs.jaicore.ml.core.evaluation.measure.IMeasure<java.lang.Double,java.lang.Double> measure)
ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure	getSingleLabelPerformanceMeasure()
boolean	getUseCache()
void	prepareNodeEvaluatorInFactoryWithData(weka.core.Instances data)
java.lang.String	toString()
MLPlanBuilder	withAlgorithmConfig(MLPlanClassifierConfig config)
MLPlanBuilder	withAlgorithmConfigFile(java.io.File algorithmConfigFile) Loads the MLPlanClassifierConfig with default values and replaces all properties according to the properties defined in the given config file.
MLPlanBuilder	withAutoSKLearnConfig() Configures the MLPlanBuilder to deal with the AutoSKLearn search space configuration.
MLPlanBuilder	withAutoWEKAConfiguration()
void	withClassifierFactory(IClassifierFactory classifierFactory) Set the classifier factory that translates CompositionInstance objects to classifiers that can be evaluated.
MLPlanBuilder	withDatasetSplitterForSearchSelectionSplit(ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter datasetSplitter)
void	withLearningCurveExtrapolationEvaluation(int[] anchorpoints, ai.libs.jaicore.ml.core.dataset.sampling.inmemory.factories.interfaces.ISamplingAlgorithmFactory<ai.libs.jaicore.ml.core.dataset.IInstance,? extends ai.libs.jaicore.ml.core.dataset.sampling.inmemory.ASamplingAlgorithm<ai.libs.jaicore.ml.core.dataset.IInstance>> subsamplingAlgorithmFactory, double trainSplitForAnchorpointsMeasurement, ai.libs.jaicore.ml.learningcurve.extrapolation.LearningCurveExtrapolationMethod extrapolationMethod)
MLPlanBuilder	withMekaDefaultConfiguration()
MLPlanBuilder	withMultiLabelClassificationMeasure(ai.libs.jaicore.ml.core.evaluation.measure.multilabel.EMultilabelPerformanceMeasure measure)
MLPlanBuilder	withPreferredComponentsFile(java.io.File preferredComponentsFile)
MLPlanBuilder	withPreferredNodeEvaluator(jaicore.search.algorithms.standard.bestfirst.nodeevaluation.INodeEvaluator<ai.libs.jaicore.planning.hierarchical.algorithms.forwarddecomposition.graphgenerators.tfd.TFDNode,java.lang.Double> preferredNodeEvaluator) This ADDs a new preferred node evaluator; requires that the search will be a best-first search.
MLPlanBuilder	withRandomCompletionBasedBestFirstSearch()
MLPlanBuilder	withRequestedInterface(java.lang.String requestedInterface)
MLPlanBuilder	withSearchFactory(jaicore.search.core.interfaces.IOptimalPathInORGraphSearchFactory searchFactory, ai.libs.jaicore.basic.algorithm.reduction.AlgorithmicProblemReduction transformer)
MLPlanBuilder	withSearchPhaseDatasetSplitter(ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter datasetSplitter)
MLPlanBuilder	withSearchSpaceConfigFile(java.io.File searchSpaceConfig)
MLPlanBuilder	withSelectionPhaseDatasetSplitter(ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter datasetSplitter)
MLPlanBuilder	withSingleLabelClassificationMeasure(ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure measure)
MLPlanBuilder	withSplitBasedClassifierEvaluator(ai.libs.jaicore.ml.evaluation.evaluators.weka.splitevaluation.ISplitBasedClassifierEvaluator<java.lang.Double> evaluator)
MLPlanBuilder	withTimeoutForNodeEvaluation(ai.libs.jaicore.basic.TimeOut timeout)
MLPlanBuilder	withTimeoutForSingleSolutionEvaluation(ai.libs.jaicore.basic.TimeOut timeout)
MLPlanBuilder	withTinyTestConfiguration()
MLPlanBuilder	withTpotConfig()

Methods inherited from class java.lang.Object

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

Constructor Detail

MLPlanBuilder

public MLPlanBuilder()

MLPlanBuilder

public MLPlanBuilder(java.io.File searchSpaceConfigFile,
                     java.io.File algorithmConfigFile,
                     ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure performanceMeasure)

MLPlanBuilder

public MLPlanBuilder(java.io.File searchSpaceConfigFile,
                     java.io.File algorithmConfigFile,
                     ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure performanceMeasure,
                     PerformanceDBAdapter dbAdapter)

Method Detail

withClassifierFactory

public void withClassifierFactory(IClassifierFactory classifierFactory)

Set the classifier factory that translates CompositionInstance objects to classifiers that can be evaluated.

Parameters:

classifierFactory - The classifier factory to be used to translate CompositionInstance objects to classifiers.

withSearchSpaceConfigFile

public MLPlanBuilder withSearchSpaceConfigFile(java.io.File searchSpaceConfig)
                                        throws java.io.IOException

Throws:

java.io.IOException

withDatasetSplitterForSearchSelectionSplit

public MLPlanBuilder withDatasetSplitterForSearchSelectionSplit(ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter datasetSplitter)

withSearchPhaseDatasetSplitter

public MLPlanBuilder withSearchPhaseDatasetSplitter(ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter datasetSplitter)

withSelectionPhaseDatasetSplitter

public MLPlanBuilder withSelectionPhaseDatasetSplitter(ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter datasetSplitter)

withRequestedInterface

public MLPlanBuilder withRequestedInterface(java.lang.String requestedInterface)

withAutoSKLearnConfig

public MLPlanBuilder withAutoSKLearnConfig()
                                    throws java.io.IOException

Configures the MLPlanBuilder to deal with the AutoSKLearn search space configuration.

Returns:

Returns the current MLPlanBuilder object with the AutoSKLearn search space configuration.

Throws:

java.io.IOException - Throws an IOException if the search space config file could not be loaded.

withTpotConfig

public MLPlanBuilder withTpotConfig()
                             throws java.io.IOException

Throws:

java.io.IOException

withAutoWEKAConfiguration

public MLPlanBuilder withAutoWEKAConfiguration()
                                        throws java.io.IOException

Throws:

java.io.IOException

withTinyTestConfiguration

public MLPlanBuilder withTinyTestConfiguration()
                                        throws java.io.IOException

Throws:

java.io.IOException

withMekaDefaultConfiguration

public MLPlanBuilder withMekaDefaultConfiguration()
                                           throws java.io.IOException

Throws:

java.io.IOException

withPreferredComponentsFile

public MLPlanBuilder withPreferredComponentsFile(java.io.File preferredComponentsFile)
                                          throws java.io.IOException

Throws:

java.io.IOException

withAlgorithmConfigFile

public MLPlanBuilder withAlgorithmConfigFile(java.io.File algorithmConfigFile)

Loads the MLPlanClassifierConfig with default values and replaces all properties according to the properties defined in the given config file.

Parameters:

algorithmConfigFile - The file specifying the property values to replace the default configuration.

Returns:

The MLPlanBuilder object.

Throws:

java.io.IOException - An IOException is thrown if there are issues reading the config file.

withAlgorithmConfig

public MLPlanBuilder withAlgorithmConfig(MLPlanClassifierConfig config)

withSingleLabelClassificationMeasure

public MLPlanBuilder withSingleLabelClassificationMeasure(ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure measure)

withMultiLabelClassificationMeasure

public MLPlanBuilder withMultiLabelClassificationMeasure(ai.libs.jaicore.ml.core.evaluation.measure.multilabel.EMultilabelPerformanceMeasure measure)

withPreferredNodeEvaluator

public MLPlanBuilder withPreferredNodeEvaluator(jaicore.search.algorithms.standard.bestfirst.nodeevaluation.INodeEvaluator<ai.libs.jaicore.planning.hierarchical.algorithms.forwarddecomposition.graphgenerators.tfd.TFDNode,java.lang.Double> preferredNodeEvaluator)

This ADDs a new preferred node evaluator; requires that the search will be a best-first search. It is possible to specify several preferred node evaluators, which will be ordered by the order in which they are specified. The latest given evaluator is the most preferred one.

Parameters:

preferredNodeEvaluator -

Returns:

withSplitBasedClassifierEvaluator

public MLPlanBuilder withSplitBasedClassifierEvaluator(ai.libs.jaicore.ml.evaluation.evaluators.weka.splitevaluation.ISplitBasedClassifierEvaluator<java.lang.Double> evaluator)

withSearchFactory

public MLPlanBuilder withSearchFactory(jaicore.search.core.interfaces.IOptimalPathInORGraphSearchFactory searchFactory,
                                       ai.libs.jaicore.basic.algorithm.reduction.AlgorithmicProblemReduction transformer)

withRandomCompletionBasedBestFirstSearch

public MLPlanBuilder withRandomCompletionBasedBestFirstSearch()

withTimeoutForSingleSolutionEvaluation

public MLPlanBuilder withTimeoutForSingleSolutionEvaluation(ai.libs.jaicore.basic.TimeOut timeout)

withTimeoutForNodeEvaluation

public MLPlanBuilder withTimeoutForNodeEvaluation(ai.libs.jaicore.basic.TimeOut timeout)

prepareNodeEvaluatorInFactoryWithData

public void prepareNodeEvaluatorInFactoryWithData(weka.core.Instances data)

getSearchSelectionDatasetSplitter

public ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter getSearchSelectionDatasetSplitter()

Returns:

The dataset splitter that is used for separating search and selection data.

getSearchPhaseDatasetSplitter

public ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter getSearchPhaseDatasetSplitter()

Returns:

The dataset splitter to be used in search phase for generating benchmark splits.

getSelectionPhaseDatasetSplitter

public ai.libs.jaicore.ml.weka.dataset.splitter.IDatasetSplitter getSelectionPhaseDatasetSplitter()

Returns:

The dataset splitter to be used in selection phase for generating benchmark splits.

getRequestedInterface

public java.lang.String getRequestedInterface()

Returns:

The interface that is requested to be provided by a solution candidate component instance.

withLearningCurveExtrapolationEvaluation

public void withLearningCurveExtrapolationEvaluation(int[] anchorpoints,
                                                     ai.libs.jaicore.ml.core.dataset.sampling.inmemory.factories.interfaces.ISamplingAlgorithmFactory<ai.libs.jaicore.ml.core.dataset.IInstance,? extends ai.libs.jaicore.ml.core.dataset.sampling.inmemory.ASamplingAlgorithm<ai.libs.jaicore.ml.core.dataset.IInstance>> subsamplingAlgorithmFactory,
                                                     double trainSplitForAnchorpointsMeasurement,
                                                     ai.libs.jaicore.ml.learningcurve.extrapolation.LearningCurveExtrapolationMethod extrapolationMethod)

getUseCache

public boolean getUseCache()

getDBAdapter

public PerformanceDBAdapter getDBAdapter()

getClassifierFactory

public IClassifierFactory getClassifierFactory()

getComponents

public java.util.Collection<ai.libs.hasco.model.Component> getComponents()

getSearchSpaceConfigFile

public java.io.File getSearchSpaceConfigFile()

getAlgorithmConfig

public MLPlanClassifierConfig getAlgorithmConfig()

getSingleLabelPerformanceMeasure

public ai.libs.jaicore.ml.core.evaluation.measure.singlelabel.EMultiClassPerformanceMeasure getSingleLabelPerformanceMeasure()

getMultiLabelPerformanceMeasure

public ai.libs.jaicore.ml.core.evaluation.measure.multilabel.EMultilabelPerformanceMeasure getMultiLabelPerformanceMeasure()

getSingleLabelEvaluationMeasurementBridge

public ai.libs.jaicore.ml.evaluation.evaluators.weka.splitevaluation.ISplitBasedClassifierEvaluator<java.lang.Double> getSingleLabelEvaluationMeasurementBridge(ai.libs.jaicore.ml.core.evaluation.measure.IMeasure<java.lang.Double,java.lang.Double> measure)

getMultiLabelEvaluationMeasurementBridge

public ai.libs.jaicore.ml.evaluation.evaluators.weka.splitevaluation.ISplitBasedClassifierEvaluator<java.lang.Double> getMultiLabelEvaluationMeasurementBridge(ai.libs.jaicore.ml.core.evaluation.measure.IMeasure<double[],java.lang.Double> measure)

getHASCOFactory

public ai.libs.hasco.core.HASCOFactory getHASCOFactory()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFactoryForPipelineEvaluationInSearchPhase

public ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.IClassifierEvaluatorFactory getFactoryForPipelineEvaluationInSearchPhase()

getFactoryForPipelineEvaluationInSelectionPhase

public ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.IClassifierEvaluatorFactory getFactoryForPipelineEvaluationInSelectionPhase()

getClassifierEvaluationInSearchPhase

public PipelineEvaluator getClassifierEvaluationInSearchPhase(weka.core.Instances data,
                                                              int seed,
                                                              int fullDatasetSize)
                                                       throws ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.ClassifierEvaluatorConstructionFailedException

Throws:

ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.ClassifierEvaluatorConstructionFailedException

getClassifierEvaluationInSelectionPhase

public PipelineEvaluator getClassifierEvaluationInSelectionPhase(weka.core.Instances data,
                                                                 int seed)
                                                          throws ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.ClassifierEvaluatorConstructionFailedException

Throws:

ai.libs.jaicore.ml.evaluation.evaluators.weka.factory.ClassifierEvaluatorConstructionFailedException