openfermioncirq.optimization.ScipyOptimizationAlgorithm

class openfermioncirq.optimization.ScipyOptimizationAlgorithm(options: Optional[Dict] = None, kwargs: Optional[Dict] = None, uses_bounds: bool = True)[source]

An optimization algorithm from the scipy.optimize module.

__init__(options: Optional[Dict] = None, kwargs: Optional[Dict] = None, uses_bounds: bool = True) → None[source]
Parameters:
  • options – The options dictionary passed to scipy.optimize.minimize.
  • kwargs – Other keyword arguments passed to scipy.optimize.minimize. This should NOT include the bounds or options keyword arguments.
  • uses_bounds – Whether the algorithm uses bounds on the input variables. Set this to False to prevent scipy.optimize.minimize from raising a warning if the chosen method does not use bounds.

Methods

__init__(options, kwargs, uses_bounds)
param options:The options dictionary passed to scipy.optimize.minimize.
default_options() Default options for the algorithm.
optimize(black_box, initial_guess, …) Perform the optimization and return the result.

Attributes

name A name for the optimization algorithm.