iqm.iqm_client.models.HeraldingMode

class iqm.iqm_client.models.HeraldingMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Heralding mode for circuit execution.

Heralding is the practice of generating data about the state of qubits prior to execution of a circuit. This can be achieved by measuring the qubits immediately before executing each shot for a circuit.

Attributes

NONE	Do not do any heralding.
ZEROS	Perform a heralding measurement after qubit initialization, only retain shots with an all-zeros result.

Methods

_generate_next_value_(name, start, count, ...)	Generate the next value when not given.
_new_member_(**kwargs)	Create and return a new object.
_value_repr_()	Return repr(self).
__format__(format_spec)	Return a formatted version of the string as described by format_spec.
__new__(value)
__repr__()	Return repr(self).
__str__()	Return str(self).

NONE = 'none'

Do not do any heralding.

ZEROS = 'zeros'

Perform a heralding measurement after qubit initialization, only retain shots with an all-zeros result.

Note: in this mode, the number of shots returned after execution will be less or equal to the requested amount due to the post-selection based on heralding data.