main main

Table of Contents

KEEL Reference Manual
  1. - Basic KEEL developement guidelines
  2. - Method Description files
  3. - Method Configuration files
  4. - Data files
  5. - Output files
  6. - Use Case files
  7. - API Dataset

Method Description files

Every method in KEEL (e.g., a preprocess method, a test...) has assigned a XML file which describes its main characteristics. This file will be employed by the KEEL GUI to allow the user to select the values of the parameters of any execution of the method.

The KEEL Method Description files are located under the ../dist/algorithm directory, inside of the folder where its associated .JAR file is generated (e.g., ../dist/algorithm/methods). Each Method Description file is an XML composed by a unique root node, <algorithm\_specification>. This node is divided into two parts:

Algorithm specification
  • Header: Basic information about the method.
  • Parameters: A list of parameters of the method.
main

Header

The header is composed by four nodes:

Header
Name
The name of the method.
Parameters
The number of parameters of the methods (must be 0 or highger). Seed values employed to initialize random number generators are not counted here.
Seed
Defines if the method will need a seed to initialize a random number generator. Valid values are 1, if a seed is needed, or 0, if not.
nOutput
The number of additional output files which will be generated by the method.
main

Parameters

The parameters of the method are listed consecutively. A <parameter> node is employed to describe each one. Each <parameter> is composed by the following nodes:

Method parameters
Name
The name of the parameter.
      integer: An integer value. Can be positive, 0, or negative.
      real: A real value. The dot "." is employed as decimal separator.
      text: A string of text.
      list: A predefined list of text options.

When employing text parameters, no checking operations are done by the KEEL GUI. Thus, the use of list parameters is recommended when a fixed number of text options are defined, so the method does not have to check the parameters by itself.

Domain
The domain of the parameter. For list parameters is mandatory. For text parameters cannot be defined. For integer and real parameters is optional (if it is not defined, the KEEL GUI will not check its value).
      lowerB: The lower value of the parameter (valid only in integer and real parameters.
      upperB: The highest value of the parameter (valid only in integer and real parameters).
      item: A text value for the parameter (it can be employed only in list parameters).
Default
Default value of the parameter.
main

Example of use

This is a valid example of a Method Description file:

Example
main


 
 Copyright 2004-2015, KEEL (Knowledge Extraction based on Evolutionary Learning)
About the Webmaster Team
Valid XHTML 1.1   Valid CSS!