EstimatorOptions

class EstimatorOptions(*args, **kwargs)

Options for V2 Estimator.

Parameters

• default_precision – The default precision to use for any PUB or run() call that does not specify one. Each estimator pub can specify its own precision. If the run() method is given a precision, then that value is used for all PUBs in the run() call that do not specify their own. Default: 0.015625 (1 / sqrt(4096)).

• default_shots –

  The total number of shots to use per circuit per configuration.

  Note

  If set, this value overrides default_precision.

  A configuration is a combination of a specific parameter value binding set and a physical measurement basis. A physical measurement basis groups together some collection of qubit-wise commuting observables for some specific circuit/parameter value set to create a single measurement with basis rotations that is inserted into hardware executions.

  If twirling is enabled, the value of this option will be divided over circuit, randomizations, with a smaller number of shots per randomization. See the twirling options.

  Default: None.

• optimization_level –

  (DEPRECATED) How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times.

  • 0: no optimization
  • 1: light optimization

  Default: 0.

• resilience_level –

  How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times.

  • 0: No mitigation.
  • 1: Minimal mitigation costs. Mitigate error associated with readout errors.
  • 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias.

  Refer to the Configure error mitigation for Qiskit Runtime. for more information about the error mitigation methods used at each level.

  Default: 1.

• seed_estimator – Seed used to control sampling. Default: None.

• dynamical_decoupling – Suboptions for dynamical decoupling. See DynamicalDecouplingOptions for all available options.

• resilience – Advanced resilience options to fine tune the resilience strategy. See ResilienceOptionsV2 for all available options.

• execution – Execution time options. See ExecutionOptionsV2 for all available options.

• twirling – Pauli twirling options. See TwirlingOptions for all available options.

• experimental –

  Experimental options. These options are subject to change without notification, and stability is not guaranteed. Currently, the available options are:

  • Probabilistic Error Amplification (PEA). To enable PEA, set:

    estimator_options.experimental = {"resilience": {"zne": {"amplifier": "pea"}}}

    Since PEA is an amplification technique of ZNE, you will also need to enable ZNE by setting resilience.zne_mitigation = True. Other documented resilience.zne options can be used in conjunction to set extrapolators, amplification levels, etc. Experiments to learn a sparse Pauli noise model will be performed for every uniquely identified entangling layer (up to a specified cutoff) in the union of circuits across PUBs; see :class:~.LayerNoiseLearningOptions` for options. Add full-width barriers to specify layers unambiguously.

Attributes

default_precision

default_shots

dynamical_decoupling

environment

execution

experimental

max_execution_time

optimization_level

resilience

resilience_level

seed_estimator

simulator

twirling

Methods

update