Difference between revisions of "Toolbox configuration"
| Line 2: | Line 2: | ||
== Structure == | == Structure == | ||
| + | |||
| + | === 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 <SampleSelector> tag. | ||
| + | |||
| + | Thus, this concept of a plan and multiple runs allows you to setup different configurations beforehand and try them one in one go. | ||
| + | |||
| + | === 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: | ||
| + | |||
| + | <pre><nowiki> | ||
| + | <SampleSelector>gradient</SampleSelector> | ||
| + | </nowiki></pre> | ||
| + | |||
| + | This means we want to use the ''gradient'' sample selection algorithm, the word ''gradient'' is a unique identifier that refers to the <SampleSelector> tag that has ''gradient'' as its "id" attribute. In this case your configuration file would have the following structure: | ||
| + | |||
| + | <pre><nowiki> | ||
| + | <Plan> | ||
| + | <Run> | ||
| + | <!-- Here we declare what components to use, for example, the gradient sample selection algorithm --> | ||
| + | <SampleSelector>gradient</SampleSelector> | ||
| + | ... | ||
| + | </Run> | ||
| + | ... | ||
| + | <Plan> | ||
| + | ... | ||
| + | |||
| + | <!-- The definition of the sample selector --> | ||
| + | <SampleSelector id="gradient"> | ||
| + | ... | ||
| + | <!-- all the options for the gradient sample selection algorithm --> | ||
| + | </SampleSelector> | ||
| + | ... | ||
| + | </nowiki></pre> | ||
| + | |||
| + | If you would like to use a different algorithm (e.g., ''grid'' for the Grid sample selector), you simply fill in a different id in the the <SampleSelector> tag in the <Run> tag: | ||
| + | |||
| + | <pre><nowiki> | ||
| + | <SampleSelector>grid</SampleSelector> | ||
| + | </nowiki></pre> | ||
| + | |||
| + | You just have to make sure there is a matching definition lower down the file for the id you have filled in. | ||
| + | All the other components work in exactly the same way. | ||
== Merging == | == Merging == | ||
Revision as of 20:15, 19 May 2007
The toolbox can be configured by means of an XML file. Examples can be found in the 'config' directory. The default configuration file is 'config/default.xml'.
Structure
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 <SampleSelector> tag.
Thus, this concept of a plan and multiple runs allows you to setup different configurations beforehand and try them one in one go.
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:
<SampleSelector>gradient</SampleSelector>
This means we want to use the gradient sample selection algorithm, the word gradient is a unique identifier that refers to the <SampleSelector> tag that has gradient 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 -->
<SampleSelector>gradient</SampleSelector>
...
</Run>
...
<Plan>
...
<!-- The definition of the sample selector -->
<SampleSelector id="gradient">
...
<!-- all the options for the gradient sample selection algorithm -->
</SampleSelector>
...
If you would like to use a different algorithm (e.g., grid for the Grid sample selector), you simply fill in a different id in the the <SampleSelector> tag in the <Run> tag:
<SampleSelector>grid</SampleSelector>
You just have to make sure there is a matching definition lower down the file for the id you have filled in. All the other components work in exactly the same way.
Merging
You can merge your own custom configuration with the 'merge' option. Options or tags that are missing in this custom file will then be filled up with the values from the default configuration.
go('customConfig.xml',[],[],'-merge');
See the Running page for more information about running the toolbox.
Components
The following components can be configured separately:
