English
Languages
English
Japanese
Spanish

Primitive options (qiskit_ibm_runtime.options)

Options that can be passed to the primitives.

The Options class encapsulates all the options you can specify when invoking a primitive. It includes frequently used options, such as optimization_level and resilience_level as well as sub-categories, such as transpilation and execution. You can use auto-complete to easily find the options inside each sub-category, for example:

from qiskit_ibm_runtime.options import Options

options = Options()
options.transpilation.initial_layout = [0, 1, 2, 3]  # This an be done using auto-complete

You can also pass dictionaries to each sub-category, for example:

from qiskit_ibm_runtime.options import Options

options = Options(transpilation={"initial_layout": [0, 1, 2, 3]})

Classes

Options([optimization_level, ...])

Options for the primitives.

TranspilationOptions([skip_transpilation, ...])

Transpilation options.

ResilienceOptions([noise_amplifier, ...])

Resilience options.

ExecutionOptions([shots, init_qubits])

Execution options.

EnvironmentOptions([log_level, callback, ...])

Options related to the execution environment.

SimulatorOptions([noise_model, ...])

Simulator options.