Skip to contents

Encapsulates configurations such as optimization algorithm choice, and evaluation settings for parameter identification.

Super class

ospsuite.utils::Printable -> PIConfiguration

Active bindings

printEvaluationFeedback

Boolean. If TRUE, prints objective function value after each evaluation. Default is FALSE.

simulationRunOptions

Object of SimulationRunOptions for simulation runs. If NULL, default options are used.

objectiveFunctionOptions

Configures model fit evaluation settings, influencing error and fit metrics. For option details and impact on cost metrics, see ObjectiveFunctionSpecs and calculateCostMetrics. Defaults found in ObjectiveFunctionOptions.

algorithm

A string specifying the optimization algorithm to use. See Algorithms for a list of supported algorithms. Defaults to BOBYQA.

algorithmOptions

A list of named parameters for algorithm-specific settings. Refer to AlgorithmOptions for default settings per algorithm (e.g., AlgorithmOptions_XYZ where XYZ denotes the algorithm name). If NULL, the algorithm's default settings are applied.

Methods


Method new()

Initialize a new instance of the class.

Usage

Returns

A new PIConfiguration object.


Method print()

Prints a summary of the PIConfiguration.

Usage

PIConfiguration$print()


Method clone()

The objects of this class are cloneable with this method.

Usage

PIConfiguration$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.