pybop.optimisers.optimisation#

Classes#

Optimisation

A high-level class for optimisation using PyBOP or PINTS optimisers.

Module Contents#

class pybop.optimisers.optimisation.Optimisation(cost, optimiser=None, **optimiser_kwargs)[source]#

A high-level class for optimisation using PyBOP or PINTS optimisers.

This class provides an alternative API to the PyBOP.Optimiser() API, specifically allowing for single user-friendly interface for the optimisation process.The class can be used with either PyBOP or PINTS optimisers.

Parameters:

  • cost (pybop.BaseCost or pints.ErrorMeasure) – An objective function to be optimized, which can be either a pybop.Cost

  • optimiser (pybop.Optimiser or subclass of pybop.BaseOptimiser, optional) – An optimiser from either the PINTS or PyBOP framework to perform the optimization (default: None).

  • sigma0 (float or sequence, optional) – Initial step size or standard deviation for the optimiser (default: None).

  • verbose (bool, optional) – If True, the optimization progress is printed (default: False).

  • physical_viability (bool, optional) – If True, the feasibility of the optimised parameters is checked (default: True).

  • allow_infeasible_solutions (bool, optional) – If True, infeasible parameter values will be allowed in the optimisation (default: True).

All attributes from the pybop.optimiser() class
__getattr__(attr)[source]#
__setattr__(name: str, value) → None[source]#
run()[source]#
On this page