pybop._evaluation

Classes

SciPyEvaluator	Evaluates a function (or callable object) for the SciPy optimisers
SequentialJaxEvaluator	Sequential evaluates a function (or callable object)

Module Contents

class pybop._evaluation.SciPyEvaluator(function, args=None)

Bases: pints.Evaluator

Evaluates a function (or callable object) for the SciPy optimisers for either a single or multiple positions.

Parameters:

• function (callable) – The function to evaluate. This function should accept an input and optionally additional arguments, returning either a single value or a tuple.

• args (sequence, optional) – A sequence containing extra arguments to be passed to the function. If specified, the function will be called as function(x, *args).

_evaluate(positions)

See evaluate().

class pybop._evaluation.SequentialJaxEvaluator(function, args=None)

Bases: pints.Evaluator

Sequential evaluates a function (or callable object) for either a single or multiple positions. This class is based off the PintsSequentialEvaluator class, with additions for PyBOP’s JAX cost classes.

Parameters:

• function (callable) – The function to evaluate. This function should accept an input and optionally additional arguments, returning either a single value or a tuple.

• args (sequence, optional) – A sequence containing extra arguments to be passed to the function. If specified, the function will be called as function(x, *args).

_evaluate(positions)

See evaluate().