Primitive options (qiskit_ibm_runtime.options)

Options that can be passed to the Qiskit Runtime primitives.

V2 Primitives

SamplerV2 and EstimatorV2 each have their own options. You can use the options attribute to set the options. For example:

from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2

service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False)
estimator = EstimatorV2(mode=backend)
estimator.options.resilience_level = 1

You can also use the update() method to do bulk update. For example:

from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2

service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False)
estimator = EstimatorV2(mode=backend)
estimator.options.update(resilience_level=1)

Refer to SamplerOptions and EstimatorOptions for V2 Sampler and V2 Estimator options, respectively.

Note

If an option is not specified, the server default value is used. The default values are subject to change. Refer to this current module’s documentation for the latest defaults.

Classes

Base primitive options

EstimatorOptions	Options for V2 Estimator.
SamplerOptions	Options for V2 Sampler.
ExecutorOptions	Options for the executor.

Suboptions

NoiseLearnerOptions	Options for NoiseLearner.
NoiseLearnerV3Options	Options for NoiseLearnerV3.
DynamicalDecouplingOptions	Options for dynamical decoupling (DD).
ResilienceOptionsV2	Resilience options for V2 Estimator.
LayerNoiseLearningOptions	Options for learning layer noise.
MeasureNoiseLearningOptions	Options for measurement noise learning.
PecOptions	Probabalistic error cancellation mitigation options.
ZneOptions	Zero noise extrapolation mitigation options.
PostSelectionOptions	Options for post selecting results.
TwirlingOptions	Twirling options.
ExecutionOptionsV2	Execution options for V2 primitives.
SamplerExecutionOptionsV2	Extension of ExecutionOptionsV2 for the sampler primitive.
EnvironmentOptions	Options related to the execution environment.
SimulatorOptions	Simulator options.