Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add runtime options table #1188

Merged
merged 6 commits into from
Apr 29, 2024
Merged

Add runtime options table #1188

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d67b0ff
Add options table
beckykd Apr 16, 2024
c1277d1
add ticks around code examples
beckykd Apr 16, 2024
b38e523
review comments
beckykd Apr 16, 2024
012f266
Merge branch 'main' of https://github.com/Qiskit/documentation into o…
beckykd Apr 29, 2024
8561631
link to table
beckykd Apr 29, 2024
369f9a9
Merge branch 'main' of https://github.com/Qiskit/documentation into o…
beckykd Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/run/advanced-runtime-options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,16 @@ estimator = Estimator(session=backend, options=options)
</TabItem>
</Tabs>


## Options classes

| Category | Description | Example |
|:-------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------:|:------------------------------------------------------|
| [Resilience](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | Advanced options for configuring error mitigation methods such as measurement error mitigation, ZNE, and PEC. Estimator only. | `estimator.options.resilience.measure_mitigation = True` |
| [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | Options for dynamical decoupling. | `estimator.options.dynamical_decoupling.enable = True` |
| [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | Execution options for V2 primitives, including whether to initialize qubits and the repetition delay. | `estimator.options.execution.init_qubits = False` |
beckykd marked this conversation as resolved.
Show resolved Hide resolved
| [Twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | Twirling options, such as whether to apply two-qubit gate twirling and the number of shots to run for each random sample. | `estimator.options.twirling.enable_gates = True` |
| [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | Execution environment options including the logging level to set, a callback function to invoke, and job tags to add. | `estimator.options.environment.log_level = 'ERROR'` |
beckykd marked this conversation as resolved.
Show resolved Hide resolved
| [Simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | Simulator options, such as the basis gates, simulator seed, and coupling map. Applies to local testing mode only. | `estimator.options.simulator.seed_simulator = 42` |

## Next steps

Expand Down
Loading