pygsti.baseobjs.advancedoptions

Utilities for defining advanced low-level parameterizations for various pyGSTi operations

Module Contents

Classes

AdvancedOptions	A base class that implements a dictionary with validated keys.
GSTAdvancedOptions	Advanced options for GST driver functions.

class pygsti.baseobjs.advancedoptions.AdvancedOptions(items=None)

Bases: dict

A base class that implements a dictionary with validated keys.

Such a dictionary may serve as an “advanced options” argument to a function, such that only valid advanced options (advanced arguments) are allowed. Using a normal dict in such circumstances results in unvalidated advanced arguments that can easily create bugs.

Parameters

itemsdict, optional

Items to store in this dict.

Attributes

valid_keystuple

the valid (allowed) keys.

Initialize self. See help(type(self)) for accurate signature.

valid_keys = '()'

update(d)

Updates this dictionary.

Parameters

ddict

key-value pairs to add to or update in this dictionary.

Returns

None

class pygsti.baseobjs.advancedoptions.GSTAdvancedOptions(items=None)

Bases: AdvancedOptions

Advanced options for GST driver functions.

Attributes

valid_keystuple

the valid (allowed) keys.

Initialize self. See help(type(self)) for accurate signature.

valid_keys = "('always_perform_mle', 'bad_fit_threshold', 'circuit_weights', 'contract_start_to_cptp',..."