The toolbox can be configured by means of an XML file.
Examples can be found in the
demo/ subdirectories of the SUMO installation directory.
The default configuration file is
If you do not know what a tag or XML is please see FAQ#What is XML? first.
Plans and Runs
The general structure of the toolbox is as follows:
- The top-level <Plan> type defines a surrogate modeling experiment, and an experiment may consist of multiple <Run> tags.
- Each <Run> tag can be configured separately.
For example, say you want to model some problem from electronics and you have at your disposal 3 algorithms for selecting data points. Now lets assume you want to compare the different algorithms on your problem and see which one gives you the best model with the least number of data samples. In this case your <Plan> tag would contain 3 <Run> tags and each <Run> tag would contain a different <SequentialDesign> tag. For example:
<Plan> ... <Run name="lola-run" repeat="1"> <SequentialDesign>lola</SequentialDesign> </Run> <Run name="density-run" repeat="1"> <SequentialDesign>density</SequentialDesign> </Run> <Run name="random-run" repeat="1"> <SequentialDesign>random</SequentialDesign> </Run> ... </Plan> ...
Thus, this concept of a plan and multiple runs allows you to setup different configurations beforehand and try them all in one go.
As you can see it is also possible to specify a '
repeat' attribute. Setting it to 5, for example, will ensure that that particular run is repeated 5 times. This is usually a good idea if there is a lot of randomness in the algorithms (as is usually the case).
<Option key="seedRandomState" value="random"/>
Declarations and Definitions
Each component in the toolbox has its own configuration section. Inside the <Run> tag you declare what components you would like to use. This declaration refers to the definition of each component, further down the file. So when you see line like:
This means we want to use the '
lola' sample selection algorithm, the word '
lola' is a unique identifier that refers to the <SequentialDesign> tag that has '
lola' as its "id" attribute. In this case your configuration file would have the following structure:
<Plan> <Run> <!-- Here we declare what components to use, for example, the gradient sample selection algorithm --> <SequentialDesign>lola</SequentialDesign> ... </Run> ... <Plan> ... <!-- The definition of the sample selector --> <SequentialDesign id="lola"> ... <!-- all the options for the gradient sample selection algorithm --> </SequentialDesign> ...
You just have to make sure there is a matching definition lower down the file for the id you have filled in.
Running a configuration
See the Running page for how to run the toolbox with a different example or with a your own configuration file.
We are well aware that documentation is not always complete and possibly even out of date in some cases. We try to document everything as best we can but much is limited by available time and manpower. We are are a university research group after all. The most up to date documentation can always be found (if not here) in the default.xml configuration file and, of course, in the source files. If something is unclear please dont hesitate to ask.
The following components can be configured separately:
- Simulator tag
- Initial Designs
- Data Sources
- Sequential designs
- Model Builders
Some general guidelines on how to configure the toolbox for different situations can be found on this page.