weka.datagenerators.classifiers.classification

Class BayesNet

java.lang.Object

weka.datagenerators.DataGenerator

weka.datagenerators.ClassificationGenerator

weka.datagenerators.classifiers.classification.BayesNet

All Implemented Interfaces:

java.io.Serializable, OptionHandler, Randomizable, RevisionHandler

public class BayesNet
extends ClassificationGenerator

Generates random instances based on a Bayes network.

Valid options are:

 -h
  Prints this help.

 -o <file>
  The name of the output file, otherwise the generated data is
  printed to stdout.

 -r <name>
  The name of the relation.

 -d
  Whether to print debug informations.

 -S
  The seed for random function (default 1)

 -n <num>
  The number of examples to generate (default 100)

 -A <num>
  The number of arcs to use. (default 20)

 -N <num>
  The number of attributes to generate. (default 10)

 -C <num>
  The cardinality of the attributes and the class. (default 2)

See Also:

BayesNetGenerator, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BayesNetGenerator	m_Generator the bayesian net generator, that produces the actual data

Fields inherited from class weka.datagenerators.ClassificationGenerator

m_NumExamples

Fields inherited from class weka.datagenerators.DataGenerator

m_CreatingRelationName, m_DatasetFormat, m_Debug, m_DefaultOutput, m_NumExamplesAct, m_OptionBlacklist, m_Output, m_Random, m_RelationName, m_Seed

Constructor Summary

Constructors

Constructor and Description
BayesNet() initializes the generator

Method Summary

Modifier and Type	Method and Description
java.lang.String	cardinalityTipText() Returns the tip text for this property
protected int	defaultCardinality() returns the default cardinality
protected int	defaultNumArcs() returns the default number of arcs
protected int	defaultNumAttributes() returns the default number of attributes
Instances	defineDataFormat() Initializes the format for the dataset produced.
Instance	generateExample() Generates one example of the dataset.
Instances	generateExamples() Generates all examples of the dataset.
java.lang.String	generateFinished() Generates a comment string that documentats the data generator.
java.lang.String	generateStart() Generates a comment string that documentates the data generator.
int	getCardinality() Gets the cardinality of the attributes (incl class attribute)
protected BayesNetGenerator	getGenerator() returns the actual datagenerator
int	getNumArcs() Gets the number of arcs for the bayesian net
int	getNumAttributes() Gets the number of attributes that should be produced.
int	getNumExamples() Gets the number of examples, given by option.
java.lang.String[]	getOptions() Gets the current settings of the datagenerator.
java.lang.String	getRevision() Returns the revision string.
int	getSeed() Gets the random number seed.
boolean	getSingleModeFlag() Return if single mode is set for the given data generator mode depends on option setting and or generator type.
java.lang.String	globalInfo() Returns a string describing this data generator.
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method for executing this class.
java.lang.String	numArcsTipText() Returns the tip text for this property
java.lang.String	numAttributesTipText() Returns the tip text for this property
void	setCardinality(int value) Sets the cardinality of the attributes (incl class attribute)
protected void	setGeneratorOption(BayesNetGenerator generator, java.lang.String option, java.lang.String value) sets a specific option/value of the generator (option must be w/o then '-')
protected void	setGeneratorOption(java.lang.String option, java.lang.String value) sets a specific option/value of the generator (option must be w/o then '-')
protected void	setGeneratorOptions(BayesNetGenerator generator, java.util.Vector<java.lang.String> options) sets the given options of the BayesNetGenerator
protected void	setGeneratorOptions(java.util.Vector<java.lang.String> options) sets the given options of the BayesNetGenerator
void	setNumArcs(int value) Sets the number of arcs for the bayesian net
void	setNumAttributes(int numAttributes) Sets the number of attributes the dataset should have.
void	setNumExamples(int numExamples) Sets the number of examples, given by option.
void	setOptions(java.lang.String[] options) Parses a list of options for this object.
void	setSeed(int newSeed) Sets the random number seed.

Methods inherited from class weka.datagenerators.ClassificationGenerator

defaultNumExamples, numExamplesTipText

Methods inherited from class weka.datagenerators.DataGenerator

addToBlacklist, clearBlacklist, debugTipText, defaultNumExamplesAct, defaultOutput, defaultRelationName, defaultSeed, enumToVector, formatTipText, getDatasetFormat, getDebug, getEpilogue, getNumExamplesAct, getOutput, getPrologue, getRandom, getRelationName, getRelationNameToUse, isOnBlacklist, makeData, makeOptionString, numExamplesActTipText, outputTipText, randomTipText, relationNameTipText, removeBlacklist, runDataGenerator, seedTipText, setDatasetFormat, setDebug, setNumExamplesAct, setOutput, setRandom, setRelationName, toStringFormat

Methods inherited from class java.lang.Object

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

Field Detail

m_Generator

protected BayesNetGenerator m_Generator

the bayesian net generator, that produces the actual data

Constructor Detail

BayesNet

public BayesNet()

initializes the generator

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing this data generator.

Returns:

a description of the data generator suitable for displaying in the explorer/experimenter gui

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class ClassificationGenerator

Returns:

an enumeration of all the available options

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a list of options for this object.

Valid options are:

 -h
  Prints this help.

 -o <file>
  The name of the output file, otherwise the generated data is
  printed to stdout.

 -r <name>
  The name of the relation.

 -d
  Whether to print debug informations.

 -S
  The seed for random function (default 1)

 -n <num>
  The number of examples to generate (default 100)

 -A <num>
  The number of arcs to use. (default 20)

 -N <num>
  The number of attributes to generate. (default 10)

 -C <num>
  The cardinality of the attributes and the class. (default 2)

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class ClassificationGenerator

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the datagenerator.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class ClassificationGenerator

Returns:

an array of strings suitable for passing to setOptions

See Also:

DataGenerator.removeBlacklist(String[])

setGeneratorOptions

protected void setGeneratorOptions(BayesNetGenerator generator,
                                   java.util.Vector<java.lang.String> options)

sets the given options of the BayesNetGenerator

Parameters:

generator - the generator to set the options for

options - the options to set

getGenerator

protected BayesNetGenerator getGenerator()

returns the actual datagenerator

Returns:

the actual datagenerator

setGeneratorOptions

protected void setGeneratorOptions(java.util.Vector<java.lang.String> options)

sets the given options of the BayesNetGenerator

Parameters:

options - the options to set

setGeneratorOption

protected void setGeneratorOption(BayesNetGenerator generator,
                                  java.lang.String option,
                                  java.lang.String value)

sets a specific option/value of the generator (option must be w/o then '-')

Parameters:

generator - the generator to set the option for

option - the option to set

value - the new value for the option

setGeneratorOption

protected void setGeneratorOption(java.lang.String option,
                                  java.lang.String value)

sets a specific option/value of the generator (option must be w/o then '-')

Parameters:

option - the option to set

value - the new value for the option

defaultNumAttributes

protected int defaultNumAttributes()

returns the default number of attributes

Returns:

the default number of attributes

setNumAttributes

public void setNumAttributes(int numAttributes)

Sets the number of attributes the dataset should have.

Parameters:

numAttributes - the new number of attributes

getNumAttributes

public int getNumAttributes()

Gets the number of attributes that should be produced.

Returns:

the number of attributes that should be produced

numAttributesTipText

public java.lang.String numAttributesTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

defaultCardinality

protected int defaultCardinality()

returns the default cardinality

Returns:

the default cardinality

setCardinality

public void setCardinality(int value)

Sets the cardinality of the attributes (incl class attribute)

Parameters:

value - the cardinality

getCardinality

public int getCardinality()

Gets the cardinality of the attributes (incl class attribute)

Returns:

the cardinality of the attributes

cardinalityTipText

public java.lang.String cardinalityTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

defaultNumArcs

protected int defaultNumArcs()

returns the default number of arcs

Returns:

the default number of arcs

setNumArcs

public void setNumArcs(int value)

Sets the number of arcs for the bayesian net

Parameters:

value - the number of arcs

getNumArcs

public int getNumArcs()

Gets the number of arcs for the bayesian net

Returns:

the number of arcs

numArcsTipText

public java.lang.String numArcsTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setNumExamples

public void setNumExamples(int numExamples)

Sets the number of examples, given by option.

Overrides:

setNumExamples in class ClassificationGenerator

Parameters:

numExamples - the new number of examples

getNumExamples

public int getNumExamples()

Gets the number of examples, given by option.

Overrides:

getNumExamples in class ClassificationGenerator

Returns:

the number of examples, given by option

getSeed

public int getSeed()

Gets the random number seed.

Specified by:

getSeed in interface Randomizable

Overrides:

getSeed in class DataGenerator

Returns:

the random number seed.

setSeed

public void setSeed(int newSeed)

Sets the random number seed.

Specified by:

setSeed in interface Randomizable

Overrides:

setSeed in class DataGenerator

Parameters:

newSeed - the new random number seed.

getSingleModeFlag

public boolean getSingleModeFlag()
                          throws java.lang.Exception

Return if single mode is set for the given data generator mode depends on option setting and or generator type.

Specified by:

getSingleModeFlag in class DataGenerator

Returns:

single mode flag

Throws:

java.lang.Exception - if mode is not set yet

defineDataFormat

public Instances defineDataFormat()
                           throws java.lang.Exception

Initializes the format for the dataset produced. Must be called before the generateExample or generateExamples methods are used. Re-initializes the random number generator with the given seed.

Overrides:

defineDataFormat in class DataGenerator

Returns:

the format for the dataset

Throws:

java.lang.Exception - if the generating of the format failed

See Also:

getSeed()

generateExample

public Instance generateExample()
                         throws java.lang.Exception

Generates one example of the dataset.

Specified by:

generateExample in class DataGenerator

Returns:

the generated example

Throws:

java.lang.Exception - if the format of the dataset is not yet defined

java.lang.Exception - if the generator only works with generateExamples which means in non single mode

generateExamples

public Instances generateExamples()
                           throws java.lang.Exception

Generates all examples of the dataset. Re-initializes the random number generator with the given seed, before generating instances.

Specified by:

generateExamples in class DataGenerator

Returns:

the generated dataset

Throws:

java.lang.Exception - if the format of the dataset is not yet defined

java.lang.Exception - if the generator only works with generateExample, which means in single mode

See Also:

getSeed()

generateStart

public java.lang.String generateStart()

Generates a comment string that documentates the data generator. By default this string is added at the beginning of the produced output as ARFF file type, next after the options.

Specified by:

generateStart in class DataGenerator

Returns:

string contains info about the generated rules

generateFinished

public java.lang.String generateFinished()
                                  throws java.lang.Exception

Generates a comment string that documentats the data generator. By default this string is added at the end of theproduces output as ARFF file type.

Specified by:

generateFinished in class DataGenerator

Returns:

string contains info about the generated rules

Throws:

java.lang.Exception - if the generating of the documentaion fails

getRevision

public java.lang.String getRevision()

Returns the revision string.

Returns:

the revision

main

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

Main method for executing this class.

Parameters:

args - should contain arguments for the data producer: