org.openimaj.experiment

Interface RunnableExperiment

All Known Implementing Classes:

CrossValidationBenchmark

public interface RunnableExperiment

Interface for classes implementing experiments that can be run with the ExperimentRunner. Implementors must write three methods corresponding to the lifecycle of an experiment: setting up the experiment, performing the experiment and concluding the experiment (i.e. writing the results, etc).

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
void	finish(ExperimentContext context) Finalise the experiment, possibly writing the results, cleaning up, etc.
void	perform() Perform the experiment
void	setup() Setup of the experiment

Method Detail

setup

void setup()

Setup of the experiment

perform

void perform()

Perform the experiment

finish

void finish(ExperimentContext context)

Finalise the experiment, possibly writing the results, cleaning up, etc. The context gathered by the ExperimentRunner is provided so that RunnableExperiment implementations can access information for generating their reports.

Note that at the point the context is provided, it is not "locked" and is still recording. The ExperimentRunner returns a completed locked context after the experiment has been completely run.

Parameters:

context - the context provided by the ExperimentRunner