piglot.bin package

Submodules

piglot.bin.piglot module

Driver script for piglot.

main(config_path: str | None = None)[source]: Entry point for piglot.

parse_args()[source]

Parse command line arguments of the script.

Returns

argparse.Namespace: Parsed arguments

piglot.bin.piglot_plot module

Driving script for piglot’s plotting utilities.

cumulative_regret(values: ndarray, x_grid: ndarray) → ndarray[source]

Compute the cumulative regret of a given function

Parameters

valuesnp.ndarray: Function values
x_gridnp.ndarray: Grid of x values

Returns

np.ndarray: Cumulative regret

main(passed_args: List[str] | None = None)[source]: Entry point for this script.

make_surrogate(args)[source]

Driver for training a surrogate model for the available data.

Parameters

argsdict: Passed arguments.

pick_from_best(values: ndarray, variable: ndarray) → ndarray[source]

Return the associated variable value associated with the current best objective

Parameters

valuesnp.ndarray: Objective values
variablenp.ndarray: Variable to output

Returns

np.ndarray: Current best of the variable

plot_animation(args)[source]

Driver for animating the response history.

Parameters

argsdict: Passed arguments.

plot_best(args)[source]

Driver for plotting the best function call so far.

Parameters

argsdict: Passed arguments.

plot_case(args)[source]

Driver for single-case plotting.

Parameters

argsdict: Passed arguments.

plot_current(args)[source]

Driver for plotting the currently running case.

Parameters

argsdict: Passed arguments.

plot_gp(args)[source]

Driver for plotting a Gaussian process regression for the available data.

Parameters

argsdict: Passed arguments.

plot_history(args)[source]

Driver for plotting the history of a case.

Parameters

argsdict: Passed arguments.

plot_parameters(args)[source]

Driver for plotting the history of the parameters.

Parameters

argsdict: Passed arguments.

plot_pareto(args)[source]

Driver for plotting the Pareto front for a given multi-objective optimisation problem.

Parameters

argsdict: Passed arguments.

plot_regret(args)[source]

Driver for plotting the cumulative regret of a case.

Parameters

argsdict: Passed arguments.

Module contents

Module with the piglot and piglot-plot scripts.