pygsti.objects.GateSet.bulk_hprobs

GateSet.bulk_hprobs(evalTree, returnPr=False, returnDeriv=False, clipTo=None, check=False, comm=None, wrtBlockSize=None)

Construct a dictionary containing the bulk-probability- Hessians for every spam label (each possible initialization & measurement pair) for each gate sequence given by evalTree.

Parameters:
  • evalTree (EvalTree) – given by a prior call to bulk_evaltree. Specifies the gate strings to compute the bulk operation on.
  • returnPr (bool, optional) – when set to True, additionally return the probabilities.
  • returnDeriv (bool, optional) – when set to True, additionally return the probability derivatives.
  • clipTo (2-tuple, optional) – (min,max) to clip returned probability to if not None. Only relevant when returnPr == True.
  • check (boolean, optional) – If True, perform extra checks within code to verify correctness, generating warnings when checks fail. Used for testing, and runs much slower when True.
  • comm (mpi4py.MPI.Comm, optional) – When not None, an MPI communicator for distributing the computation across multiple processors.
  • wrtBlockSize (int, optional) – The maximum number of 2nd derivative columns to compute products for simultaneously. None means compute all columns at once. The minimum of wrtBlockSize and the size that makes maximal use of available processors is used as the final block size. Use this argument to reduce amount of intermediate memory required.
Returns:

hprobs – A dictionary such that hprobs[SL] = bulk_hpr(SL,evalTree,returnPr,returnDeriv,clipTo,check) for each spam label (string) SL.

Return type:

dictionary