Primitive options models

qiskit_ibm_runtime.options_models

Options that can be passed to Executor, NoiseLearnerV3 and client-side primitives (SamplerV2 and (EstimatorV2).

Classes

Primitive options

Column 1	Column 2
`ExecutorOptions`	Options for the executor.
`EstimatorOptions`	Options for the client-side Estimator.
`NoiseLearnerV3Options`	Options for `NoiseLearnerV3`.
`SamplerOptions`	Options for the client-side Sampler.

Suboptions

Column 1	Column 2
`BitFlipChecksOptions`	Options to apply bit-flip checks to the results of noise learning circuits.
`DynamicalDecouplingOptions`	Options for dynamical decoupling (DD).
`EnvironmentOptions`	Options related to the execution environment.
`ExecutionOptions`	Low-level execution options.
`MeasureNoiseLearningOptions`	Options for measurement noise learning.
`PecOptions`	Probabalistic error cancellation mitigation options.
`PostCircuitBitFlipChecksOptions`	Options to apply post-circuit bit-flip checks to the results of noise learning circuits.
`PostSelectionOptions`	Options for post selecting results.
`PreCircuitBitFlipChecksOptions`	Options to apply pre-circuit bit-flip checks to the results of noise learning circuits.
`ResilienceOptions`	Resilience options for V2 Estimator.
`SamplerExecutionOptions`	Execution options for the sampler primitive.
`SimulatorOptions`	Simulator options.
`TwirlingOptions`	Twirling options.
`ZneOptions`	Zero noise extrapolation mitigation options.

Was this page helpful?

Report a bug, typo, or request content on GitHub.