Objective Functions (pysit.objective_functions)

Note

This section of the documentation is under construction. The source, however, is documented and you can access that via the Reference/API section.

Introduction

Objective functions are…

Getting Started

  • Importing objective functions
  • Instantiating objective functions
  • Calling individual components, looping over shots

Using objective_functions

More details

Keyword Options and Special Return Values

  • aux_info

Parallelism

  • How to ensure parallelism over shots

Extending objective_functions

Define the required interface:

  • evaluate
  • compute_gradient
  • apply_hessian

Parallelism

  • How to write your extensions so that they are parallel over shots

Reference/API

pysit.objective_functions Package

Classes

FrequencyLeastSquares(solver[, …])
HybridLeastSquares(solver[, …])
ObjectiveFunctionBase(solver[, …])
TemporalLeastSquares(solver[, …]) How to compute the parts of the objective you need to do optimization