Migrate options
All backend.run options are now available through the Qiskit Runtime primitives, but there are additional options available with the V2 primitives. See the API reference for the full list of available options. See End-to-end examples and Advanced Qiskit Runtime options for more information about specifying V2 primitives options.
| backend.run options | V2 Primitive options | Notes |
|---|---|---|
| job_name | N/A: Use job_tags instead. | ibmq-provider only |
| job_share_level | N/A: This is no longer supported. | ibmq-provider only |
| job_tags | options.environment.job_tags | |
| experiment_id | N/A: Use job_tags instead. | ibmq-provider only |
| header | You can attach metadata to circuits. The same metadata is returned in the result metadata, under “circuit_metadata”. | |
| shots | Any of the following: • run([(…, shots)]) • run(…, shots=) • options.default_shots | |
| memory | Use result.data.<classical_register_name>.get_counts() to get counts. Use result.data.<classical_register_name>.get_bitstrings() to get per-shot measurements. | |
| qubit_lo_freq | N/A: This option only applies to Schedule inputs, which was removed in 2022. | |
| meas_lo_freq | N/A: This option only applies to Schedule inputs, which was removed in 2022. | |
| schedule_los | N/A: This option only applies to Schedule inputs, which was removed in 2022. | |
| meas_level | options.execution.meas_type: • For meas_level=1 and meas_return="avg", use avg_kerneled • For meas_level=1 and meas_return="single", use kerneled • For meas_level=2, use classified • meas_level=0 is no longer supported by IBM backends. | |
| meas_return | options.execution.meas_type (See above.) | |
| memory_slots | N/A: This is automatically determined by the system. | ibmq-provider only |
| memory_slot_size | N/A: This is automatically determined by the system. | ibmq-provider only |
| rep_time | N/A: Use rep_delay instead. | |
| rep_delay | options.execution.rep_delay | |
| init_qubits | options.execution.init_qubits | |
| parameter_binds | Specify parameters in PUBs. | ibmq-provider only |
| use_measure_esp | N/A: This is no longer supported by IBM backends. | |
| live_data_enabled | N/A: This feature was removed in 2022. | ibmq-provider only |
| dynamic | N/A: No longer needed. SamplerV2 automatically detects dynamic circuits. | ibm-provider only |
| init_circuit | N/A: Use init_qubits instead. | |
| init_num_resets | N/A: Use init_qubits instead. | |
| noise_model | options.simulator.noise_model | |
| seed_simulator | options.simulator.seed_simulator |
Algorithm tuning
One of the advantages of the primitives is that they abstract away the circuit execution setup so that algorithm developers can focus on the pure algorithmic components. However, sometimes, to get the most out of an algorithm, you might want to tune certain primitive options. For details, see Advanced runtime options.
Was this page helpful?
Report a bug or request content on GitHub.