Installation Instructions

System Requirements

  • For the current version of genee, you will need a JRE version 1.5 or later
  • If you intend to build from source genee, you need to install Maven2

Installation

Download the binary distribution from http://orcus.sourceforge.net/genee and extract it into the directory you wish to install genee.

This will create the following directories:

  orcus-genee-0.1
       +-- bin  // contains launcher scripts
       |
       +-- lib  // contains genee jars plus necessary dependencies
       |
       +-- docs // contains project documentation and api docs

Change into orcus-genee-0.1/bin and execute genee.bat if you're running a Windows 2000/XP operating system or genee.sh if you're using a Unix-based operating system.

If you execute genee.[bat|sh] without any parameters, it will show you a list of valid parameters. The option list is included further down in this file.

For Unix based systems only:

  • After extracting the archive, make /bin/genee.sh executable by setting the appropriate permissions, e.g. chmod 755 /bin/genee.sh
  • Make sure that JAVA_HOME is set to the location of your JDK home dir. If you want to run genee from outside its /bin directory, make sure that you set GENEE_HOME.

Running genee

Examples

The following command performs a 3 fold cross-validation on a file called mushroom.arff located in /~. The maximum number of generations is specified to be 100 and the population size will be 50.

  genee -G 100 -P 50 -x 3 -t /~mushroom.arff

The following command performs a 5 fold cross-validation the same file. The maximum number of generations is specified to be 500, the population size will be 100 and the algorithm terminates if a Hypothesis is found, that classifies at least 0.8 of the total instances correctly. Note that the user Fitness will be calculated on the user provided class com.my.MyFitness.

  genee -G 500 -P 100 -C 0.8 -x 5 -F com.my.MyFitness -t /~mushroom.arff

Improving Performance

If you need to change the default Java VM settings, you can do this by setting the GENEE_VM_OPTS environment variable or directly add the parameters in genee.[bat|sh]. For example to increase the heap size, setting GENEE_VM_OPTS=- mx1024M (i.e. 1 GB) should help improve performance.

Building genee from source

In order to build genee from source, you need Maven2.

If Maven2 is installed on your system, you can either download the genee source distribution or checkout the genee module directly from CVS.

Once you have obtained (and extracted) the source, change into the genee root folder and execute

  mvn site assembly:assembly

This will compile all the sources, execute the test cases, create the entire project documentation and package everything into the binary assembly.

  mvn compile (compiles all the sources)
  mvn package (creates the genee jar file)
  mvn eclipse:eclipse (creates project files for Eclipse IDE)
  mvn idea:idea (creates project files for Idea IDE)

Logging

genee uses commons-logging and log4j as the logging infrastructure. To change the logging settings, modify the log4j.properties in orcus-genee- 0.1.jar or add you own log4j.properties file to the classpath.