pygsti.report.Results.set_additional_info

Results.set_additional_info(minProbClip=1e-06, minProbClipForWeighting=0.0001, probClipInterval=(-1000000.0, 1000000.0), radius=0.0001, weightsDict=None, defaultDirectory=None, defaultBasename=None)

Set advanced parameters for producing derived outputs. Usually the default values are fine (which is why setting these inputs is separated into a separate function).

Parameters:
  • minProbClip (float, optional) – The minimum probability treated normally in the evaluation of the log-likelihood. A penalty function replaces the true log-likelihood for probabilities that lie below this threshold so that the log-likelihood never becomes undefined (which improves optimizer performance).
  • minProbClipForWeighting (float, optional) – Sets the minimum and maximum probability p allowed in the chi^2 weights: N/(p*(1-p)) by clipping probability p values to lie within the interval [ minProbClipForWeighting, 1-minProbClipForWeighting ].
  • probClipInterval (2-tuple or None, optional) – (min,max) values used to clip the probabilities predicted by gatesets during the least squares search for an optimal gateset (if not None).
  • radius (float, optional) – Specifies the severity of rounding used to “patch” the zero-frequency terms of the log-likelihood.
  • weightsDict (dict, optional) – A dictionary with keys == gate strings and values == multiplicative scaling factor for the corresponding gate string. The default is no weight scaling at all.
  • defaultDirectory (string, optional) – Path to the default directory for generated reports and presentations.
  • defaultBasename (string, optional) – Default basename for generated reports and presentations.
Returns:

Return type:

None