set_param

Class method.

do_mpc.sampling.samplingplanner.SamplingPlanner.set_param(self, **kwargs)

Set the parameters of the SamplingPlanner class. Parameters must be passed as pairs of valid keywords and respective argument. For example:

sp.set_param(overwrite = True)

It is also possible and convenient to pass a dictionary with multiple parameters simultaneously as shown in the following example:

setup_dict = {
    'overwrite': True,
    'save_format': pickle,
}
sp.set_param(**setup_dict)

This makes use of thy python “unpack” operator. See more details here.

Note

set_param() can be called multiple times. Previously passed arguments are overwritten by successive calls.

The following parameters are available:

Parameters:
  • overwrite (bool) – Overwrites existing samplingplan under the same name, if set to True.
  • id_precision (string) – Padding for IDs of created samples. Defaults to 3. This means sample 20 will be denoted as 020.

This page is auto-generated. Page source is not available on Github.