piglot.objective.Objective

class Objective

Bases: ABC

Abstract class for optimisation objectives

Methods

get_history	Get the objective history
plot_best	Plot the current best case
plot_case	Plot a given function call given the parameter hash
plot_current	Plot the currently running function call
prepare	Generic method to prepare output files before optimising the problem
read	Read the objective from a configuration dictionary.

abstract __call__(*args: Any, **kwds: Any) → ObjectiveResult

Objective computation for the outside world

get_history() → Dict[str, Dict[str, Any]]

Get the objective history

Returns

Dict[str, Dict[str, Any]]

Dictionary of objective history

plot_best() → List[Figure]

Plot the current best case

Returns

List[Figure]

List of figures with the plot

plot_case(case_hash: str, options: Dict[str, Any] | None = None) → List[Figure]

Plot a given function call given the parameter hash

Parameters

case_hashstr, optional

Parameter hash for the case to plot

optionsDict[str, Any], optional

Options to pass to the plotting function, by default None

Returns

List[Figure]

List of figures with the plot

plot_current() → List[DynamicPlotter]

Plot the currently running function call

Returns

List[DynamicPlotter]

List of instances of a updatable plots

abstract prepare() → None

Generic method to prepare output files before optimising the problem

abstract classmethod read(config: Dict[str, Any], parameters: ParameterSet, output_dir: str) → T

Read the objective from a configuration dictionary.

Parameters

configDict[str, Any]

Terms from the configuration dictionary.

parametersParameterSet

Set of parameters for this problem.

output_dirstr

Path to the output directory.

Returns

Objective

Objective function to optimise.