meka.experiment

Interface Experiment

All Superinterfaces:

LogSupporter, weka.core.OptionHandler, Serializable

All Known Implementing Classes:

DefaultExperiment

public interface Experiment
extends weka.core.OptionHandler, Serializable, LogSupporter

Interface for experiments.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method and Description
void	addExecutionStageListener(ExecutionStageListener l) Adds the execution stage listener.
void	addIterationNotificationListener(IterationNotificationListener l) Adds the iteration listener.
void	addStatisticsNotificationListener(StatisticsNotificationListener l) Adds the statistics listener.
String	classifiersTipText() Describes this property.
String	datasetProviderTipText() Describes this property.
String	evaluatorTipText() Describes this property.
String	finish() Finishes the experiment.
MultiLabelClassifier[]	getClassifiers() Returns the classifiers to be evaluated.
DatasetProvider	getDatasetProvider() Returns the dataset provider in use.
Evaluator	getEvaluator() Returns the evaluator in use.
String	getNotes() Returns the notes.
List<EvaluationStatistics>	getStatistics() Returns the current statistics.
EvaluationStatisticsHandler	getStatisticsHandler() Returns the statistics handler.
String	initialize() Initializes the experiment.
boolean	isInitializing() Returns whether the experiment is initializing.
boolean	isRunning() Returns whether the experiment is running.
boolean	isStopping() Returns whether the experiment is stopping.
void	removeExecutionStageListener(ExecutionStageListener l) Removes the execution stage listener.
void	removeIterationNotificationListener(IterationNotificationListener l) Removes the iteration listener.
void	removeStatisticsNotificationListener(StatisticsNotificationListener l) Removes the statistics listener.
String	run() Runs the experiment.
void	setClassifiers(MultiLabelClassifier[] value) Sets the classifiers to be evaluated.
void	setDatasetProvider(DatasetProvider value) Sets the dataset provider to use.
void	setEvaluator(Evaluator value) Sets the evaluator to use.
void	setNotes(String value) Sets the notes.
void	setStatisticsHandler(EvaluationStatisticsHandler value) Sets the statistics handler.
String	statisticsHandlerTipText() Describes this property.
void	stop() Stops the experiment if still running.

Methods inherited from interface weka.core.OptionHandler

getOptions, listOptions, setOptions

Methods inherited from interface meka.events.LogSupporter

addLogListener, log, removeLogListener

Method Detail

setNotes

void setNotes(String value)

Sets the notes.

Parameters:

value - the notes

getNotes

String getNotes()

Returns the notes.

Returns:

the notes

setClassifiers

void setClassifiers(MultiLabelClassifier[] value)

Sets the classifiers to be evaluated.

Parameters:

value - the classifiers

getClassifiers

MultiLabelClassifier[] getClassifiers()

Returns the classifiers to be evaluated.

Returns:

the classifiers

classifiersTipText

String classifiersTipText()

Describes this property.

Returns:

the description

setDatasetProvider

void setDatasetProvider(DatasetProvider value)

Sets the dataset provider to use.

Parameters:

value - the provider

getDatasetProvider

DatasetProvider getDatasetProvider()

Returns the dataset provider in use.

Returns:

the provider

datasetProviderTipText

String datasetProviderTipText()

Describes this property.

Returns:

the description

setEvaluator

void setEvaluator(Evaluator value)

Sets the evaluator to use.

Parameters:

value - the evaluator

getEvaluator

Evaluator getEvaluator()

Returns the evaluator in use.

Returns:

the evaluator

evaluatorTipText

String evaluatorTipText()

Describes this property.

Returns:

the description

setStatisticsHandler

void setStatisticsHandler(EvaluationStatisticsHandler value)

Sets the statistics handler.

Parameters:

value - the handler

getStatisticsHandler

EvaluationStatisticsHandler getStatisticsHandler()

Returns the statistics handler.

Returns:

the handler

statisticsHandlerTipText

String statisticsHandlerTipText()

Describes this property.

Returns:

the description

addExecutionStageListener

void addExecutionStageListener(ExecutionStageListener l)

Adds the execution stage listener.

Parameters:

l - the listener to add

removeExecutionStageListener

void removeExecutionStageListener(ExecutionStageListener l)

Removes the execution stage listener.

Parameters:

l - the listener to remove

addIterationNotificationListener

void addIterationNotificationListener(IterationNotificationListener l)

Adds the iteration listener.

Parameters:

l - the listener to add

removeIterationNotificationListener

void removeIterationNotificationListener(IterationNotificationListener l)

Removes the iteration listener.

Parameters:

l - the listener to remove

addStatisticsNotificationListener

void addStatisticsNotificationListener(StatisticsNotificationListener l)

Adds the statistics listener.

Parameters:

l - the listener to add

removeStatisticsNotificationListener

void removeStatisticsNotificationListener(StatisticsNotificationListener l)

Removes the statistics listener.

Parameters:

l - the listener to remove

initialize

String initialize()

Initializes the experiment.

Returns:

null if successfully initialized, otherwise error message

isInitializing

boolean isInitializing()

Returns whether the experiment is initializing.

Returns:

true if initializing

run

String run()

Runs the experiment.

Returns:

null if successfully run, otherwise error message

isRunning

boolean isRunning()

Returns whether the experiment is running.

Returns:

true if running

stop

void stop()

Stops the experiment if still running.

isStopping

boolean isStopping()

Returns whether the experiment is stopping.

Returns:

true if stopping

finish

String finish()

Finishes the experiment.

Returns:

null if successfully finished, otherwise error message

getStatistics

List<EvaluationStatistics> getStatistics()

Returns the current statistics.

Returns:

the statistics, if any