EstimatorOptions

class EstimatorOptions(_VERSION=2, max_execution_time=Unset, environment=<factory>, simulator=<factory>, default_precision=Unset, default_shots=Unset, resilience_level=Unset, seed_estimator=Unset, dynamical_decoupling=<factory>, resilience=<factory>, execution=<factory>, twirling=<factory>, experimental=Unset)[source]

Bases: OptionsV2

Options for V2 Estimator.

Attributes

Parameters:
default_precision: UnsetType | float = Unset

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: UnsetType | int | None = Unset

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.

dynamical_decoupling: DynamicalDecouplingOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=DynamicalDecouplingOptions)

Suboptions for dynamical decoupling. See DynamicalDecouplingOptions for all available options.

environment: EnvironmentOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=EnvironmentOptions)
execution: ExecutionOptionsV2 | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=ExecutionOptionsV2)

Execution time options. See ExecutionOptionsV2 for all available options.

experimental: UnsetType | dict = Unset

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

max_execution_time: UnsetType | int = Unset
resilience: ResilienceOptionsV2 | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=ResilienceOptionsV2)

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

resilience_level: UnsetType | int = Unset

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 guide for more information about the error mitigation methods used at each level.

Default: 1.

seed_estimator: UnsetType | int = Unset

Seed used to control sampling.

Default: None.

simulator: SimulatorOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=SimulatorOptions)
twirling: TwirlingOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=TwirlingOptions)

Pauli twirling options. See TwirlingOptions for all available options.

Methods

update(**kwargs)[source]

Update the options.

Parameters:

kwargs (Any)

Return type:

None