Package ai.libs.jaicore.experiments

Class ExperimenterFrontend

java.lang.Object

ai.libs.jaicore.experiments.ExperimenterFrontend

All Implemented Interfaces:

org.api4.java.common.control.ILoggingCustomizable

public class ExperimenterFrontend
extends java.lang.Object
implements org.api4.java.common.control.ILoggingCustomizable

Constructor Summary

Constructors

Constructor	Description
ExperimenterFrontend()

Method Summary

Modifier and Type	Method	Description
void	addPreRunHook(java.util.function.Consumer<org.api4.java.algorithm.IAlgorithm<?,?>> hook)
ExperimenterFrontend	clearDatabase()
void	conductExperiment(int id)
java.lang.String	getExecutorInfo()
java.lang.String	getLoggerName()
boolean	mightHaveMoreExperiments()
void	randomlyConductExperiments()
ExperimenterFrontend	randomlyConductExperiments(int limit)
ExperimenterFrontend	randomlyConductExperiments(org.api4.java.algorithm.Timeout to, int maxExperimentRuntime)
void	sequentiallyConductExperiments()
void	setLoggerName(java.lang.String name)
void	simulateExperiment(int id, IExperimentRunController<?> controller)
<O> O	simulateExperiment(Experiment experiment, IExperimentRunController<O> controller)
ExperimenterFrontend	synchronizeDatabase()
ExperimenterFrontend	withController(IExperimentRunController<?> controller)
ExperimenterFrontend	withDatabaseConfig(ai.libs.jaicore.db.IDatabaseConfig databaseConfig)
ExperimenterFrontend	withDatabaseConfig(ai.libs.jaicore.db.sql.IRestDatabaseConfig databaseConfig)
ExperimenterFrontend	withDatabaseConfig(java.io.File... databaseConfigFiles)
ExperimenterFrontend	withDatabaseConfig(java.lang.String databaseConfigFileName)
<B extends IExperimentBuilder,I,A extends org.api4.java.algorithm.IAlgorithm<? extends I,?>> ExperimenterFrontend	withDomain(AExperimentDomain<B,I,A> domain)
ExperimenterFrontend	withEvaluator(IExperimentSetEvaluator evaluator)
ExperimenterFrontend	withExecutorInfo(java.lang.String executorInfo)
ExperimenterFrontend	withExperimentsConfig(IExperimentSetConfig config)
ExperimenterFrontend	withExperimentsConfig(java.io.File configFile)
ExperimenterFrontend	withExperimentSpecificTimeout(java.util.function.Function<Experiment,org.api4.java.algorithm.Timeout> timeoutFunction)
ExperimenterFrontend	withLoggerNameForAlgorithm(java.lang.String loggerName)
ExperimenterFrontend	withRestDatabaseConfig(java.io.File... databaseConfigFiles)
ExperimenterFrontend	withTimeout(org.api4.java.algorithm.Timeout to)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimenterFrontend

public ExperimenterFrontend()

Method Detail

withLoggerNameForAlgorithm

public ExperimenterFrontend withLoggerNameForAlgorithm(java.lang.String loggerName)

withDatabaseConfig

public ExperimenterFrontend withDatabaseConfig(java.lang.String databaseConfigFileName)

withDatabaseConfig

public ExperimenterFrontend withDatabaseConfig(java.io.File... databaseConfigFiles)

withRestDatabaseConfig

public ExperimenterFrontend withRestDatabaseConfig(java.io.File... databaseConfigFiles)

withDatabaseConfig

public ExperimenterFrontend withDatabaseConfig(ai.libs.jaicore.db.sql.IRestDatabaseConfig databaseConfig)

withDatabaseConfig

public ExperimenterFrontend withDatabaseConfig(ai.libs.jaicore.db.IDatabaseConfig databaseConfig)

withExperimentsConfig

public ExperimenterFrontend withExperimentsConfig(java.io.File configFile)

withExperimentsConfig

public ExperimenterFrontend withExperimentsConfig(IExperimentSetConfig config)

withTimeout

public ExperimenterFrontend withTimeout(org.api4.java.algorithm.Timeout to)

withExperimentSpecificTimeout

public ExperimenterFrontend withExperimentSpecificTimeout(java.util.function.Function<Experiment,org.api4.java.algorithm.Timeout> timeoutFunction)

clearDatabase

public ExperimenterFrontend clearDatabase()
                                   throws ExperimentDBInteractionFailedException

Throws:

ExperimentDBInteractionFailedException

withEvaluator

public ExperimenterFrontend withEvaluator(IExperimentSetEvaluator evaluator)

withExecutorInfo

public ExperimenterFrontend withExecutorInfo(java.lang.String executorInfo)

getExecutorInfo

public java.lang.String getExecutorInfo()

withDomain

public <B extends IExperimentBuilder,I,A extends org.api4.java.algorithm.IAlgorithm<? extends I,?>> ExperimenterFrontend withDomain(AExperimentDomain<B,I,A> domain)

withController

public ExperimenterFrontend withController(IExperimentRunController<?> controller)

synchronizeDatabase

public ExperimenterFrontend synchronizeDatabase()
                                         throws ExperimentDBInteractionFailedException,
                                                org.api4.java.algorithm.exceptions.AlgorithmTimeoutedException,
                                                IllegalExperimentSetupException,
                                                ExperimentAlreadyExistsInDatabaseException,
                                                java.lang.InterruptedException,
                                                org.api4.java.algorithm.exceptions.AlgorithmExecutionCanceledException

Throws:

ExperimentDBInteractionFailedException

org.api4.java.algorithm.exceptions.AlgorithmTimeoutedException

IllegalExperimentSetupException

ExperimentAlreadyExistsInDatabaseException

java.lang.InterruptedException

org.api4.java.algorithm.exceptions.AlgorithmExecutionCanceledException

conductExperiment

public void conductExperiment(int id)
                       throws ExperimentDBInteractionFailedException,
                              java.lang.InterruptedException

Throws:

ExperimentDBInteractionFailedException

java.lang.InterruptedException

randomlyConductExperiments

public void randomlyConductExperiments()
                                throws ExperimentDBInteractionFailedException,
                                       java.lang.InterruptedException

Throws:

ExperimentDBInteractionFailedException

java.lang.InterruptedException

sequentiallyConductExperiments

public void sequentiallyConductExperiments()
                                    throws ExperimentDBInteractionFailedException,
                                           java.lang.InterruptedException

Throws:

ExperimentDBInteractionFailedException

java.lang.InterruptedException

randomlyConductExperiments

public ExperimenterFrontend randomlyConductExperiments(int limit)
                                                throws ExperimentDBInteractionFailedException,
                                                       java.lang.InterruptedException

Throws:

ExperimentDBInteractionFailedException

java.lang.InterruptedException

randomlyConductExperiments

public ExperimenterFrontend randomlyConductExperiments(org.api4.java.algorithm.Timeout to,
                                                       int maxExperimentRuntime)
                                                throws ExperimentDBInteractionFailedException,
                                                       java.lang.InterruptedException

Throws:

ExperimentDBInteractionFailedException

java.lang.InterruptedException

mightHaveMoreExperiments

public boolean mightHaveMoreExperiments()
                                 throws ExperimentDBInteractionFailedException

Throws:

ExperimentDBInteractionFailedException

simulateExperiment

public <O> O simulateExperiment(Experiment experiment,
                                IExperimentRunController<O> controller)
                         throws ExperimentEvaluationFailedException,
                                java.lang.InterruptedException,
                                ExperimentFailurePredictionException

Throws:

ExperimentEvaluationFailedException

java.lang.InterruptedException

ExperimentFailurePredictionException

simulateExperiment

public void simulateExperiment(int id,
                               IExperimentRunController<?> controller)
                        throws ExperimentEvaluationFailedException,
                               java.lang.InterruptedException,
                               ExperimentFailurePredictionException,
                               ExperimentDBInteractionFailedException

Throws:

ExperimentEvaluationFailedException

java.lang.InterruptedException

ExperimentFailurePredictionException

ExperimentDBInteractionFailedException

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

addPreRunHook

public void addPreRunHook(java.util.function.Consumer<org.api4.java.algorithm.IAlgorithm<?,?>> hook)