meka.experiment

Class MekaExperiment

java.lang.Object

weka.experiment.Experiment

meka.experiment.MekaExperiment

All Implemented Interfaces:

java.io.Serializable, weka.core.OptionHandler, weka.core.RevisionHandler

public class MekaExperiment
extends weka.experiment.Experiment

Holds all the necessary configuration information for a standard type experiment. This object is able to be serialized for storage on disk. Valid options are:

 -L <num>
  The lower run number to start the experiment from.
  (default 1)
 

 -U <num>
  The upper run number to end the experiment at (inclusive).
  (default 10)
 

 -T <arff file>
  The dataset to run the experiment on.
  (required, may be specified multiple times)
 

 -P <class name>
  The full class name of a ResultProducer (required).
  eg: weka.experiment.RandomSplitResultProducer
 

 -D <class name>
  The full class name of a ResultListener (required).
  eg: weka.experiment.CSVResultListener
 

 -N <string>
  A string containing any notes about the experiment.
  (default none)
 

 Options specific to result producer weka.experiment.RandomSplitResultProducer:
 

 -P <percent>
  The percentage of instances to use for training.
  (default 66)
 

 -D
 Save raw split evaluator output.
 

 -O <file/directory name/path>
  The filename where raw output will be stored.
  If a directory name is specified then then individual
  outputs will be gzipped, otherwise all output will be
  zipped to the named file. Use in conjuction with -D. (default splitEvalutorOut.zip)
 

 -W <class name>
  The full class name of a SplitEvaluator.
  eg: weka.experiment.ClassifierSplitEvaluator
 

 -R
  Set when data is not to be randomized and the data sets' size.
  Is not to be determined via probabilistic rounding.
 

 Options specific to split evaluator weka.experiment.ClassifierSplitEvaluator:
 

 -W <class name>
  The full class name of the classifier.
  eg: weka.classifiers.bayes.NaiveBayes
 

 -C <index>
  The index of the class for which IR statistics
  are to be output. (default 1)
 

 -I <index>
  The index of an attribute to output in the
  results. This attribute should identify an
  instance in order to know which instances are
  in the test set of a cross validation. if 0
  no output (default 0).
 

 -P
  Add target and prediction columns to the result
  for each fold.
 

 Options specific to classifier weka.classifiers.rules.ZeroR:
 

 -D
  If set, classifier is run in debug mode and
  may output additional info to the console
 

All options after -- will be passed to the result producer.

Version:

$Revision: 10376 $

Author:

Len Trigg (trigg@cs.waikato.ac.nz), FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class weka.experiment.Experiment

FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
MekaExperiment()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getRevision() Returns the revision string.
void	initialize() Prepares an experiment for running, initializing current iterator settings.
static void	main(java.lang.String[] args) Configures/Runs the Experiment from the command line.
void	nextIteration() Carries out the next iteration of the experiment.
static MekaExperiment	read(java.lang.String filename) Loads an experiment from a file.
static void	write(java.lang.String filename, MekaExperiment exp) Writes the experiment to disk.

Methods inherited from class weka.experiment.Experiment

advanceCounters, classFirst, getAdvanceDataSetFirst, getCurrentDatasetNumber, getCurrentPropertyNumber, getCurrentRunNumber, getDatasets, getNotes, getOptions, getPropertyArray, getPropertyArrayLength, getPropertyArrayValue, getPropertyPath, getResultListener, getResultProducer, getRunLower, getRunUpper, getUsePropertyIterator, hasMoreIterations, listOptions, postProcess, runExperiment, runExperiment, setAdvanceDataSetFirst, setDatasets, setNotes, setOptions, setPropertyArray, setPropertyPath, setResultListener, setResultProducer, setRunLower, setRunUpper, setUsePropertyIterator, toString, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MekaExperiment

public MekaExperiment()

Method Detail

initialize

public void initialize()
                throws java.lang.Exception

Prepares an experiment for running, initializing current iterator settings.

Overrides:

initialize in class weka.experiment.Experiment

Throws:

java.lang.Exception - if an error occurs

nextIteration

public void nextIteration()
                   throws java.lang.Exception

Carries out the next iteration of the experiment.

Overrides:

nextIteration in class weka.experiment.Experiment

Throws:

java.lang.Exception - if an error occurs

read

public static MekaExperiment read(java.lang.String filename)
                           throws java.lang.Exception

Loads an experiment from a file.

Parameters:

filename - the file to load the experiment from

Returns:

the experiment

Throws:

java.lang.Exception - if loading fails

write

public static void write(java.lang.String filename,
         MekaExperiment exp)
                  throws java.lang.Exception

Writes the experiment to disk.

Parameters:

filename - the file to write to

exp - the experiment to save

Throws:

java.lang.Exception - if writing fails

main

public static void main(java.lang.String[] args)

Configures/Runs the Experiment from the command line.

Parameters:

args - command line arguments to the Experiment.

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class weka.experiment.Experiment

Returns:

the revision