Preset step

A preset step performs a single experiment with a specific configuration. The purpose of this step is to help you quickly understand how good is a particular configuration.

A preset step offers two options when selecting the configuration of the experiment to be executed:

• Use a configuration taken from an experiment of a study (can be the same study)

• Use a custom configuration

The preset step has the following structure:

Field	Type	Value restrictions	Is required	Default value	Description
type	string	preset	yes		The type of the step, in this case, preset
name	string		yes		The name of the step
runOnFailure	boolean	true false	no	false	The execution policy of the step: false prevents the step from running in case the previous step failed true allows the step to run even if the previous step failed
from	array of objects	Each object should have the structure described below	no		The study and the experiment from which to take the configuration of the experiment The from and experiments fields are defined as an array, but it can only contain one element This can be set only if values is not set
values	object	The keys should match existing parameters	no		The configuration with which execute the experiment This can be set only if from is not set
doNotRenderParameters	string	this cannot be used when using a from option since no experiment is actually executed	no		Parameters not to be rendered. - see Parameter rending
renderParameters	string	this cannot be used when using a from option since no experiment is actually executed	no		Parameters to be rendered. - see Parameter rending

where the from field should have the following structure:

study: "study_preset_1"
experiments: [1]

with

• study contains the name or ID of the study from which to take the configuration. In the case this is omitted, the same study of the step is considered for experiments from which taking configurations

• experiments contains the number of the experiment from which to take the configuration

Examples

Custom configuration

You can provide a custom configuration by setting values:

name: "my_preset"   # name of the step
type: "preset"      # type of the step (preset)
values:
  jvm1.maxHeapSize: 1024 # parameter maxHeapSize of jvm1 is set to 1024
  jvm2.maxHeapSize: 2048 # parameter maxHeapSize of jvm2 is set to 2048

Configuration from another study

You can select a configuration taken from another study by setting from:

name: "my_preset"  # name of the step
type: "preset"     # type of the step (preset)
from:
  - study: "preset_study_1" # name or ID of the study from which to take the configuration
    experiments: [1] # the number of the experiment from which to take the configuration

Configuration from the same study

You can select a configuration taken from the same study by setting from but by omitting the study field:

name: "my_preset"    # name of the step
type: "preset"       # type of the step (preset)
from:
  - experiments: [1] # the step will take the configuration of the experiment #1 of the same study of the step

Notice: the from and experiments fields are defined as a list, but can only contain one element.