From 46724a679bf4a5883c4772583a8a95f85d66d649 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Wed, 22 Jan 2025 16:07:44 -0600 Subject: [PATCH 01/17] remove unnecessary links --- docs/guides/runtime-options-overview.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 6a3b1e8dd0..3a01b507b4 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -81,20 +81,20 @@ Scroll to see the full table. | | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | | [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | | [resilience](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | -| | [layer_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions) | | `True`/`False` | `True` | | +| | layer_noise_learning | | `True`/`False` | `True` | | | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | | | | shots_per_randomization | integer >= 1 | `128` | | | | | num_randomizations | integer >= 1 | `32` | | | | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | -| | [layer_noise_model](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#layer_noise_model) | | `NoiseLearnerResult`/`Sequence[LayerError]` | `None` | | +| | layer_noise_model | | `NoiseLearnerResult`/`Sequence[LayerError]` | `None` | | | | measure_mitigation | | `True`/`False` | `True` | | -| | [measure_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions) | num_randomizations | integer >= 1 | `32` | | +| | measure_noise_learning | num_randomizations | integer >= 1 | `32` | | | | | shots_per_randomization | integer | 'auto' | | | | pec_mitigation | | `True`/`False` | `False` | | -| | [pec](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions) | max_overhead | `None`/ integer >1 | `100` | | +| | pec | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | | | zne_mitigation | | `True`/`False` | `False` | | -| | [zne](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions) | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | +| | zne | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | | | | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | | | | extrapolated_noise_factors | list of floats | `[0, *noise_factors]`| | | | | extrapolator | one or more of `exponential`
`linear`
`double_exponential`
`polynomial_degree_(1 <= k <= 7)`
`fallback` | (`exponential`, `linear`) | | From 217e1c6ea4442febc739e556d8fb656346e65318 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Wed, 22 Jan 2025 16:13:12 -0600 Subject: [PATCH 02/17] alphabetize table --- docs/guides/runtime-options-overview.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 3a01b507b4..c44e36e944 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -67,14 +67,14 @@ Scroll to see the full table. | [default_precision](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | | [dynamical_decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | | dynamical_decoupling | | | enable | | `True`/`False` | `False` | | -| | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | | | extra_slack_distribution | | `middle`/`edges` | `middle` | | | | scheduling_method | | `asap`/`alap` | `alap` | | +| | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | | | skip_reset_qubits | | `True`/`False` | `False` | | | [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | environment | -| | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | | | callback | |Callable function that receives Job ID and Job result. |`None` | | | | job_tags | |List of tags |`None` | | +| | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | | | private | |`True`/`False` |`False` | | | [execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | execution | | | init_qubits | | `True`/`False` | `True` | | @@ -82,10 +82,10 @@ Scroll to see the full table. | [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | | [resilience](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | | | layer_noise_learning | | `True`/`False` | `True` | | +| | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | -| | | shots_per_randomization | integer >= 1 | `128` | | | | | num_randomizations | integer >= 1 | `32` | | -| | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | +| | | shots_per_randomization | integer >= 1 | `128` | | | | layer_noise_model | | `NoiseLearnerResult`/`Sequence[LayerError]` | `None` | | | | measure_mitigation | | `True`/`False` | `True` | | | | measure_noise_learning | num_randomizations | integer >= 1 | `32` | | @@ -94,17 +94,17 @@ Scroll to see the full table. | | pec | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | | | zne_mitigation | | `True`/`False` | `False` | | -| | zne | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | -| | | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | +| | zne | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | | | | extrapolated_noise_factors | list of floats | `[0, *noise_factors]`| | | | | extrapolator | one or more of `exponential`
`linear`
`double_exponential`
`polynomial_degree_(1 <= k <= 7)`
`fallback` | (`exponential`, `linear`) | | +| | | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | | [resilience_level](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | `0`/`1`/`2` | `1` | resilience_level | | [seed_estimator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | integer | `None` | seed_estimator | | [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | simulator | +| | basis_gates | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | +| | coupling_map | | List of directed two-qubit interactions | full connectivity | | | | noise_model | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | | | | seed_simulator | | integer | `None` | | -| | coupling_map | | List of directed two-qubit interactions | full connectivity | | -| | basis_gates | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | | [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | twirling | | | enable_gates | | `True`/`False` | `False` | | | | enable_measure | | `True`/`False` | `True` | | From c919a37cf40628ea16631ddc7cfc321e053d5e1f Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Wed, 22 Jan 2025 16:31:20 -0600 Subject: [PATCH 03/17] alphabetize lists --- docs/guides/runtime-options-overview.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index c44e36e944..58c95fc64d 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -32,20 +32,19 @@ Options can be defined before a primitive is constructed and passed to the primi - - [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. - [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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. - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. + - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - [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. + - [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. - [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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. - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. + - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - [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. + - [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. From e0f38c2dc54799259d5b075bdf1a4f97f161d1e1 Mon Sep 17 00:00:00 2001 From: abbycross Date: Thu, 23 Jan 2025 09:14:01 -0500 Subject: [PATCH 04/17] didn't manage to save this change on my prev PR! --- docs/guides/runtime-options-overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 58c95fc64d..ce8940ac00 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -60,7 +60,7 @@ Scroll to see the full table. -| Option | Sub-option | Sub-sub-option | Choices | Default | Options | +| Option | Sub-option | Sub-sub-option | Choices | Default | Option | |----------------------|--------------------------|-------------------------|-------------------------------------------------------------------------------------------|---------------------------|----------------------| | [default_shots](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer in the range[0, `backend.max_shots`]| None | default_shots | | [default_precision](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | From 0e00b7a98d77e04cced412065cd617042c0e5706 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Thu, 23 Jan 2025 13:27:15 -0600 Subject: [PATCH 05/17] corrections --- docs/guides/runtime-options-overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index ce8940ac00..7897892f9b 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -80,7 +80,7 @@ Scroll to see the full table. | | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | | [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | | [resilience](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | -| | layer_noise_learning | | `True`/`False` | `True` | | +| | layer_noise_learning | | | | | | | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | | | | num_randomizations | integer >= 1 | `32` | | From 4c9357a1c3e39e27a186406d8f06f4cc16209dd3 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Mon, 27 Jan 2025 11:32:09 -0600 Subject: [PATCH 06/17] add links --- docs/guides/runtime-options-overview.mdx | 98 ++++++++++++------------ 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 7897892f9b..ba9bfbda63 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -65,51 +65,51 @@ Scroll to see the full table. | [default_shots](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer in the range[0, `backend.max_shots`]| None | default_shots | | [default_precision](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | | [dynamical_decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | | dynamical_decoupling | -| | enable | | `True`/`False` | `False` | | -| | extra_slack_distribution | | `middle`/`edges` | `middle` | | -| | scheduling_method | | `asap`/`alap` | `alap` | | -| | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | -| | skip_reset_qubits | | `True`/`False` | `False` | | +| | [enable](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#enable) | | `True`/`False` | `False` | | +| | [extra_slack_distribution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#extra_slack_distribution) | | `middle`/`edges` | `middle` | | +| | [scheduling_method](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#scheduling_method) | | `asap`/`alap` | `alap` | | +| | [sequence_type](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#sequence_type) | | `XX`/`XpXm`/`XY4` | `XX` | | +| | [skip_reset_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#skip_reset_qubits) | | `True`/`False` | `False` | | | [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | environment | -| | callback | |Callable function that receives Job ID and Job result. |`None` | | -| | job_tags | |List of tags |`None` | | -| | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | -| | private | |`True`/`False` |`False` | | +| | [callback](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#callback) | |Callable function that receives Job ID and Job result. |`None` | | +| | [job_tags](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#job_tags) | |List of tags |`None` | | +| | [log_level](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#log_level) | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | +| | [private](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#private) | |`True`/`False` |`False` | | | [execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | execution | -| | init_qubits | | `True`/`False` | `True` | | -| | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | +| | [init_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2#init_qubits) | | `True`/`False` | `True` | | +| | [rep_delay](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2#rep_delay) | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | | [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | | [resilience](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | -| | layer_noise_learning | | | | | +| | [layer_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#layer_noise_learning) | | | | | | | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | | | | num_randomizations | integer >= 1 | `32` | | | | | shots_per_randomization | integer >= 1 | `128` | | -| | layer_noise_model | | `NoiseLearnerResult`/`Sequence[LayerError]` | `None` | | -| | measure_mitigation | | `True`/`False` | `True` | | -| | measure_noise_learning | num_randomizations | integer >= 1 | `32` | | +| | [layer_noise_model](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#layer_noise_model) | | `NoiseLearnerResult`/`Sequence[LayerError]` | `None` | | +| | [measure_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#measure_mitigation) | | `True`/`False` | `True` | | +| | [measure_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions) | num_randomizations | integer >= 1 | `32` | | | | | shots_per_randomization | integer | 'auto' | | -| | pec_mitigation | | `True`/`False` | `False` | | -| | pec | max_overhead | `None`/ integer >1 | `100` | | +| | [pec_mitigation]{/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#pec_mitigation} | | `True`/`False` | `False` | | +| | [pec](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions) | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | -| | zne_mitigation | | `True`/`False` | `False` | | -| | zne | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | +| | [zne_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#zne_mitigation) | `True`/`False` | `False` | | +| | [zne](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions) | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | | | | extrapolated_noise_factors | list of floats | `[0, *noise_factors]`| | | | | extrapolator | one or more of `exponential`
`linear`
`double_exponential`
`polynomial_degree_(1 <= k <= 7)`
`fallback` | (`exponential`, `linear`) | | | | | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | | [resilience_level](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | `0`/`1`/`2` | `1` | resilience_level | | [seed_estimator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | integer | `None` | seed_estimator | | [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | simulator | -| | basis_gates | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | -| | coupling_map | | List of directed two-qubit interactions | full connectivity | | -| | noise_model | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | | -| | seed_simulator | | integer | `None` | | +| | [basis_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#basis_gates)| | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | +| | [coupling_map](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#coupling_map) | | List of directed two-qubit interactions | full connectivity | | +| | [noise_model](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#noise_model) | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | | +| | [seed_simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#seed_simulator) | | integer | `None` | | | [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | twirling | -| | enable_gates | | `True`/`False` | `False` | | -| | enable_measure | | `True`/`False` | `True` | | -| | num_randomizations | | `auto`/ integer >= 1 | `auto` | | -| | shots_per_randomization | | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | -| | strategy | | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | +| | [enable_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_gates) | | `True`/`False` | `False` | | +| | [enable_measure](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_measure) | | `True`/`False` | `True` | | +| | [num_randomizations](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#num_randomizations) | | `auto`/ integer >= 1 | `auto` | | +| | [shots_per_randomization](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#shots_per_randomization) | | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | +| | [strategy](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#strategy) | | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | | experimental | | | | | | | | execution_path | | `gen3-turbo` *([see note](#experimental-option-note))* | None | | @@ -119,32 +119,32 @@ Scroll to see the full table. |----------------------|--------------------------|-------------------------|-------------------------------------------------------------------------------------------|---------------------------|-------------------------| | [default_shots](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | | Integer in the range[0, `backend.max_shots`] | `4096` | default_shots | | [dynamical_decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | | dynamical_decoupling | -| | enable | | `True`/`False` | `False` | | -| | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | -| | extra_slack_distribution | | `middle`/`edges` | `middle` | | -| | scheduling_method | | `asap`/`alap` | `alap` | | -| | skip_reset_qubits | | `True`/`False` | `False` | | +| | [enable](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#enable) | | `True`/`False` | `False` | | +| | [sequence_type](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#sequence_type) | | `XX`/`XpXm`/`XY4` | `XX` | | +| | [extra_slack_distribution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#extra_slack_distribution) | | `middle`/`edges` | `middle` | | +| | [scheduling_method](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#scheduling_method) | | `asap`/`alap` | `alap` | | +| | [skip_reset_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#skip_reset_qubits) | | `True`/`False` | `False` | | | [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | | -| | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | environment | -| | callback | |Callable function that receives Job ID and Job result. |`None` | | -| | job_tags | |List of tags |`None` | | -| | private | |`True`/`False` |`False` | | +| | [log_level](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#log_level) | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | environment | +| | [callback](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#callback) | |Callable function that receives Job ID and Job result. |`None` | | +| | [job_tags](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#job_tags) | |List of tags |`None` | | +| | [private](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#private) | |`True`/`False` |`False` | | | [execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | | -| | init_qubits | | `True`/`False` | `True` | execution | -| | meas_type | | `classified`/`kerneled`/`avg_kerneled` | `classified`| | -| | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | +| | [init_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2#init_qubits) | | `True`/`False` | `True` | execution | +| | [meas_type](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2#meas_type) | | `classified`/`kerneled`/`avg_kerneled` | `classified`| | +| | [rep_delay](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2#rep_delay) | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | | [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | | | [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | max_execution_time | -| | noise_model | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | simulator | -| | seed_simulator | | integer | `None` | | -| | coupling_map | | List of directed two-qubit interactions | full connectivity | | -| | basis_gates | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | +| | [noise_model](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#noise_model) | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | simulator | +| | [seed_simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#seed_simulator) | | integer | `None` | | +| | [coupling_map](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#coupling_map) | | List of directed two-qubit interactions | full connectivity | | +| | [basis_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#basis_gates) | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | | [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | | -| | enable_gates | | `True`/`False` | `False` | twirling | -| | enable_measure | | `True`/`False` | `True` | | -| | num_randomizations | | `auto`/ integer >= 1 | `auto` | | -| | shots_per_randomization | | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | -| | strategy | | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | +| | [enable_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_gates) | | `True`/`False` | `False` | twirling | +| | [enable_measure](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_measure) | | `True`/`False` | `True` | | +| | [num_randomizations](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#num_randomizations) | | `auto`/ integer >= 1 | `auto` | | +| | [shots_per_randomization](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#shots_per_randomization) | | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | +| | [strategy](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#strategy) | | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | | experimental | | | | | | | | execution_path | | `gen3-turbo` *([see note](#experimental-option-note))* | None | | From 6b4f082df4ab91dcdbde859ae6baee2fe24fefe7 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Mon, 27 Jan 2025 13:45:08 -0600 Subject: [PATCH 07/17] remove braces --- docs/guides/runtime-options-overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index ba9bfbda63..fa3b0d6983 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -89,7 +89,7 @@ Scroll to see the full table. | | [measure_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#measure_mitigation) | | `True`/`False` | `True` | | | | [measure_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions) | num_randomizations | integer >= 1 | `32` | | | | | shots_per_randomization | integer | 'auto' | | -| | [pec_mitigation]{/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#pec_mitigation} | | `True`/`False` | `False` | | +| | [pec_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#pec_mitigation) | | `True`/`False` | `False` | | | | [pec](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions) | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | | | [zne_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#zne_mitigation) | `True`/`False` | `False` | | From 3303f06c186b559c5cb5c8bbcef99b91500246cb Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Tue, 28 Jan 2025 17:11:32 -0600 Subject: [PATCH 08/17] return resilience to its rightful home --- docs/guides/runtime-options-overview.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index fa3b0d6983..dd4e179517 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -35,6 +35,7 @@ Options can be defined before a primitive is constructed and passed to the primi - [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. + - [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. - [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. - [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. From a98220427d1b648d13632ad1867e38e97c33b136 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Wed, 29 Jan 2025 13:10:04 -0600 Subject: [PATCH 09/17] some more cleanup --- docs/guides/runtime-options-overview.mdx | 117 +++++++++++------------ 1 file changed, 58 insertions(+), 59 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index dd4e179517..7dfd7e24c3 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -36,7 +36,7 @@ Options can be defined before a primitive is constructed and passed to the primi - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - [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. - - [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. + - [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](https://docs.quantum.ibm.com/guides/local-testing-mode) only. - [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. @@ -44,7 +44,7 @@ Options can be defined before a primitive is constructed and passed to the primi - [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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. + - [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](https://docs.quantum.ibm.com/guides/local-testing-mode) only. - [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. @@ -66,19 +66,19 @@ Scroll to see the full table. | [default_shots](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer in the range[0, `backend.max_shots`]| None | default_shots | | [default_precision](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | | [dynamical_decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | | dynamical_decoupling | -| | [enable](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#enable) | | `True`/`False` | `False` | | -| | [extra_slack_distribution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#extra_slack_distribution) | | `middle`/`edges` | `middle` | | -| | [scheduling_method](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#scheduling_method) | | `asap`/`alap` | `alap` | | -| | [sequence_type](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#sequence_type) | | `XX`/`XpXm`/`XY4` | `XX` | | -| | [skip_reset_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#skip_reset_qubits) | | `True`/`False` | `False` | | +| | enable | | `True`/`False` | `False` | | +| | extra_slack_distribution | | `middle`/`edges` | `middle` | | +| | scheduling_method | | `asap`/`alap` | `alap` | | +| | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | +| | skip_reset_qubits | | `True`/`False` | `False` | | | [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | environment | -| | [callback](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#callback) | |Callable function that receives Job ID and Job result. |`None` | | -| | [job_tags](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#job_tags) | |List of tags |`None` | | -| | [log_level](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#log_level) | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | -| | [private](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#private) | |`True`/`False` |`False` | | +| | callback | |Callable function that receives Job ID and Job result. |`None` | | +| | job_tags | |List of tags |`None` | | +| | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | +| | private | |`True`/`False` |`False` | | | [execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | execution | -| | [init_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2#init_qubits) | | `True`/`False` | `True` | | -| | [rep_delay](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2#rep_delay) | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | +| | init_qubits | | `True`/`False` | `True` | | +| | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | | [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | | [resilience](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | | | [layer_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#layer_noise_learning) | | | | | @@ -86,14 +86,14 @@ Scroll to see the full table. | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | | | | num_randomizations | integer >= 1 | `32` | | | | | shots_per_randomization | integer >= 1 | `128` | | -| | [layer_noise_model](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#layer_noise_model) | | `NoiseLearnerResult`/`Sequence[LayerError]` | `None` | | -| | [measure_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#measure_mitigation) | | `True`/`False` | `True` | | +| | layer_noise_model | | `NoiseLearnerResult`/`Sequence[LayerError]` | `None` | | +| | measure_mitigation | | `True`/`False` | `True` | | | | [measure_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions) | num_randomizations | integer >= 1 | `32` | | | | | shots_per_randomization | integer | 'auto' | | -| | [pec_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#pec_mitigation) | | `True`/`False` | `False` | | +| | pec_mitigation | | `True`/`False` | `False` | | | | [pec](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions) | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | -| | [zne_mitigation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#zne_mitigation) | `True`/`False` | `False` | | +| | zne_mitigation | `True`/`False` | `False` | | | | [zne](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions) | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | | | | extrapolated_noise_factors | list of floats | `[0, *noise_factors]`| | | | | extrapolator | one or more of `exponential`
`linear`
`double_exponential`
`polynomial_degree_(1 <= k <= 7)`
`fallback` | (`exponential`, `linear`) | | @@ -101,54 +101,53 @@ Scroll to see the full table. | [resilience_level](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | `0`/`1`/`2` | `1` | resilience_level | | [seed_estimator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | integer | `None` | seed_estimator | | [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | simulator | -| | [basis_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#basis_gates)| | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | -| | [coupling_map](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#coupling_map) | | List of directed two-qubit interactions | full connectivity | | -| | [noise_model](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#noise_model) | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | | -| | [seed_simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#seed_simulator) | | integer | `None` | | +| | basis_gates | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | +| | coupling_map | | List of directed two-qubit interactions | full connectivity | | +| | noise_model | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | | +| | seed_simulator | | integer | `None` | | | [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | twirling | -| | [enable_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_gates) | | `True`/`False` | `False` | | -| | [enable_measure](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_measure) | | `True`/`False` | `True` | | -| | [num_randomizations](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#num_randomizations) | | `auto`/ integer >= 1 | `auto` | | -| | [shots_per_randomization](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#shots_per_randomization) | | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | -| | [strategy](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#strategy) | | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | +| | enable_gates | | `True`/`False` | `False` | | +| | enable_measure | | `True`/`False` | `True` | | +| | num_randomizations | | `auto`/ integer >= 1 | `auto` | | +| | shots_per_randomization | | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | +| | strategy | | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | | experimental | | | | | | | | execution_path | | `gen3-turbo` *([see note](#experimental-option-note))* | None | | -| Option | Sub-option | Sub-sub-option | Choices | Default | Option | -|----------------------|--------------------------|-------------------------|-------------------------------------------------------------------------------------------|---------------------------|-------------------------| -| [default_shots](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | | Integer in the range[0, `backend.max_shots`] | `4096` | default_shots | -| [dynamical_decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | | dynamical_decoupling | -| | [enable](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#enable) | | `True`/`False` | `False` | | -| | [sequence_type](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#sequence_type) | | `XX`/`XpXm`/`XY4` | `XX` | | -| | [extra_slack_distribution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#extra_slack_distribution) | | `middle`/`edges` | `middle` | | -| | [scheduling_method](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#scheduling_method) | | `asap`/`alap` | `alap` | | -| | [skip_reset_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions#skip_reset_qubits) | | `True`/`False` | `False` | | -| [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | | -| | [log_level](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#log_level) | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | environment | -| | [callback](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#callback) | |Callable function that receives Job ID and Job result. |`None` | | -| | [job_tags](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#job_tags) | |List of tags |`None` | | -| | [private](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions#private) | |`True`/`False` |`False` | | -| [execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | | -| | [init_qubits](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2#init_qubits) | | `True`/`False` | `True` | execution | -| | [meas_type](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2#meas_type) | | `classified`/`kerneled`/`avg_kerneled` | `classified`| | -| | [rep_delay](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2#rep_delay) | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | -| [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | | -| [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | max_execution_time | -| | [noise_model](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#noise_model) | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | simulator | -| | [seed_simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#seed_simulator) | | integer | `None` | | -| | [coupling_map](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#coupling_map) | | List of directed two-qubit interactions | full connectivity | | -| | [basis_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#basis_gates) | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | -| [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | | -| | [enable_gates](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_gates) | | `True`/`False` | `False` | twirling | -| | [enable_measure](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#enable_measure) | | `True`/`False` | `True` | | -| | [num_randomizations](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#num_randomizations) | | `auto`/ integer >= 1 | `auto` | | -| | [shots_per_randomization](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#shots_per_randomization) | | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | -| | [strategy](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions#strategy) | | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | -| experimental | | | | | | -| | execution_path | | `gen3-turbo` *([see note](#experimental-option-note))* | None | | - +| Option | Sub-option | Choices | Default | Option | +|---------------------------------------------------------------------------------------------------------|--------------------------|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| [default_shots](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer in the range[0, `backend.max_shots`] | `4096` | default_shots | +| [dynamical_decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | dynamical_decoupling | +| | enable | `True`/`False` | `False` | | +| | sequence_type | `XX`/`XpXm`/`XY4` | `XX` | | +| | extra_slack_distribution | `middle`/`edges` | `middle` | | +| | scheduling_method | `asap`/`alap` | `alap` | | +| | skip_reset_qubits | `True`/`False` | `False` | | +| [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | +| | log_level | `DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` | `WARNING` | environment | +| | callback | Callable function that receives Job ID and Job result. | `None` | | +| | job_tags | List of tags | `None` | | +| | private | `True`/`False` | `False` | | +| [execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | +| | init_qubits | `True`/`False` | `True` | execution | +| | meas_type | `classified`/`kerneled`/`avg_kerneled` | `classified` | | +| | rep_delay | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`. | | +| [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | | +| [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | max_execution_time | +| | noise_model | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | simulator | +| | seed_simulator | integer | `None` | | +| | coupling_map | List of directed two-qubit interactions | full connectivity | | +| | basis_gates | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | +| [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | +| | enable_gates | `True`/`False` | `False` | twirling | +| | enable_measure | `True`/`False` | `True` | | +| | num_randomizations | `auto`/ integer >= 1 | `auto` | | +| | shots_per_randomization | `auto`/ Integer no larger than `backend.max_shots`. | `auto` | | +| | strategy | `active`
`active-circuit`
`active-accum`
`all` | `active-accum` | | +| experimental | | | | | +| | execution_path | `gen3-turbo` *([see note](#experimental-option-note))* | None | | From 940806d0babb7abccc960fd2304c5c2eb4b8a3e6 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Date: Wed, 29 Jan 2025 14:14:38 -0600 Subject: [PATCH 10/17] Apply suggestions from code review Co-authored-by: abbycross --- docs/guides/runtime-options-overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 7dfd7e24c3..9564838635 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -36,7 +36,7 @@ Options can be defined before a primitive is constructed and passed to the primi - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - [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. - - [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](https://docs.quantum.ibm.com/guides/local-testing-mode) only. + - [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](/guides/local-testing-mode) only. - [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. From d694ad878cdf71c06998f525f1cf02ebde8da652 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Date: Wed, 29 Jan 2025 14:15:04 -0600 Subject: [PATCH 11/17] Update docs/guides/runtime-options-overview.mdx --- docs/guides/runtime-options-overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 9564838635..7af2b19f90 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -44,7 +44,7 @@ Options can be defined before a primitive is constructed and passed to the primi - [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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](https://docs.quantum.ibm.com/guides/local-testing-mode) only. + - [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](/guides/local-testing-mode) only. - [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. From 6a8d6931e2b367aa257c7a40241d892cdb1686f7 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Thu, 30 Jan 2025 10:44:31 -0600 Subject: [PATCH 12/17] broken links --- docs/guides/runtime-options-overview.mdx | 62 ++++++++++++------------ 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 0424033df8..f12d661142 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -32,20 +32,20 @@ Options can be defined before a primitive is constructed and passed to the primi - - [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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. - - [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](/guides/local-testing-mode) only. - - [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. + - [Dynamical decoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. + - [Environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. + - [Execution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. + - [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. + - [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](/guides/local-testing-mode) only. + - [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. - - [Dynamical decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - - [Environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - - [Execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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](/guides/local-testing-mode) only. - - [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. + - [Dynamical decoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. + - [Environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. + - [Execution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. + - [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](/guides/local-testing-mode) only. + - [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. @@ -63,24 +63,24 @@ Scroll to see the full table. | Option | Sub-option | Sub-sub-option | Choices | Default | Option | |----------------------|--------------------------|-------------------------|-------------------------------------------------------------------------------------------|---------------------------|----------------------| -| [default_shots](../api/qiskit-ibm-runtime/options-estimator-options) | | | Integer in the range[0, `backend.max_shots`]| None | default_shots | -| [default_precision](../api/qiskit-ibm-runtime/options-estimator-options) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | -| [dynamical_decoupling](../api/qiskit-ibm-runtime/options-dynamical-decoupling-options) | | | | | dynamical_decoupling | +| [default_shots](/api/qiskit-ibm-runtime/options-estimator-options) | | | Integer in the range[0, `backend.max_shots`]| None | default_shots | +| [default_precision](/api/qiskit-ibm-runtime/options-estimator-options) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | +| [dynamical_decoupling](/api/qiskit-ibm-runtime/options-dynamical-decoupling-options) | | | | | dynamical_decoupling | | | enable | | `True`/`False` | `False` | | | | extra_slack_distribution | | `middle`/`edges` | `middle` | | | | scheduling_method | | `asap`/`alap` | `alap` | | | | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | | | skip_reset_qubits | | `True`/`False` | `False` | | -| [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | environment | +| [environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | environment | | | callback | |Callable function that receives Job ID and Job result. |`None` | | | | job_tags | |List of tags |`None` | | | | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | | | private | |`True`/`False` |`False` | | -| [execution](../api/qiskit-ibm-runtime/options-execution-options-v2) | | | | | execution | +| [execution](/api/qiskit-ibm-runtime/options-execution-options-v2) | | | | | execution | | | init_qubits | | `True`/`False` | `True` | | | | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | -| [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | -| [resilience](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | +| [max_execution_time](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | +| [resilience](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | | | [layer_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#layer_noise_learning) | | | | | | | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | @@ -98,14 +98,14 @@ Scroll to see the full table. | | | extrapolated_noise_factors | list of floats | `[0, *noise_factors]`| | | | | extrapolator | one or more of `exponential`
`linear`
`double_exponential`
`polynomial_degree_(1 <= k <= 7)`
`fallback` | (`exponential`, `linear`) | | | | | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | -| [resilience_level](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | `0`/`1`/`2` | `1` | resilience_level | -| [seed_estimator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | integer | `None` | seed_estimator | -| [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | simulator | +| [resilience_level](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | `0`/`1`/`2` | `1` | resilience_level | +| [seed_estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | integer | `None` | seed_estimator | +| [simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | simulator | | | basis_gates | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | | | coupling_map | | List of directed two-qubit interactions | full connectivity | | | | noise_model | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | | | | seed_simulator | | integer | `None` | | -| [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | twirling | +| [twirling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | twirling | | | enable_gates | | `True`/`False` | `False` | | | | enable_measure | | `True`/`False` | `True` | | | | num_randomizations | | `auto`/ integer >= 1 | `auto` | | @@ -118,29 +118,29 @@ Scroll to see the full table. | Option | Sub-option | Choices | Default | Option | |---------------------------------------------------------------------------------------------------------|--------------------------|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------------------| -| [default_shots](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer in the range[0, `backend.max_shots`] | `4096` | default_shots | -| [dynamical_decoupling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | dynamical_decoupling | +| [default_shots](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer in the range[0, `backend.max_shots`] | `4096` | default_shots | +| [dynamical_decoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | dynamical_decoupling | | | enable | `True`/`False` | `False` | | | | sequence_type | `XX`/`XpXm`/`XY4` | `XX` | | | | extra_slack_distribution | `middle`/`edges` | `middle` | | | | scheduling_method | `asap`/`alap` | `alap` | | | | skip_reset_qubits | `True`/`False` | `False` | | -| [environment](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | +| [environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | | | log_level | `DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` | `WARNING` | environment | | | callback | Callable function that receives Job ID and Job result. | `None` | | | | job_tags | List of tags | `None` | | | | private | `True`/`False` | `False` | | -| [execution](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | +| [execution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | | | init_qubits | `True`/`False` | `True` | execution | | | meas_type | `classified`/`kerneled`/`avg_kerneled` | `classified` | | | | rep_delay | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`. | | -| [max_execution_time](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | | -| [simulator](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | max_execution_time | +| [max_execution_time](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | | +| [simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | max_execution_time | | | noise_model | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | simulator | | | seed_simulator | integer | `None` | | | | coupling_map | List of directed two-qubit interactions | full connectivity | | | | basis_gates | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | -| [twirling](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | +| [twirling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | | | enable_gates | `True`/`False` | `False` | twirling | | | enable_measure | `True`/`False` | `True` | | | | num_randomizations | `auto`/ integer >= 1 | `auto` | | @@ -251,8 +251,8 @@ Due to differences in the device compilation process, certain runtime features c ## Next steps - - Find more details about the `EstimatorV2` methods in the [Estimator API reference](../api/qiskit-ibm-runtime/estimator-v2). - - Find more details about the `SamplerV2` methods in the [Sampler API reference](../api/qiskit-ibm-runtime/sampler-v2). + - Find more details about the `EstimatorV2` methods in the [Estimator API reference](/api/qiskit-ibm-runtime/estimator-v2). + - Find more details about the `SamplerV2` methods in the [Sampler API reference](/api/qiskit-ibm-runtime/sampler-v2). - Find details about how to configure [error suppression](configure-error-suppression) and [error mitigation](configure-error-mitigation). - Learn how to [specify options](specify-runtime-options). From fcc97e5b6fb4729ef109dde17a5eff5651830d29 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Thu, 30 Jan 2025 16:07:40 -0600 Subject: [PATCH 13/17] fix weird links --- docs/guides/runtime-options-overview.mdx | 58 ++++++++++++------------ 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index f12d661142..b65505e758 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -32,20 +32,20 @@ Options can be defined before a primitive is constructed and passed to the primi - - [Dynamical decoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - - [Environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - - [Execution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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. - - [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](/guides/local-testing-mode) only. - - [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. + - [Dynamical decoupling](/api/qiskit-ibm-runtime/options-dynamical-decoupling-options): Options for dynamical decoupling. + - [Environment](/api/qiskit-ibm-runtime/options-environment-options): Execution environment options, such as the logging level to set and job tags to add. + - [Execution](/api/qiskit-ibm-runtime/options-execution-options-v2): Primitive execution options, including whether to initialize qubits and the repetition delay. + - [Resilience](/api/qiskit-ibm-runtime/options-resiliance-options-v2): Advanced options for configuring error mitigation methods such as measurement error mitigation, ZNE, and PEC. + - [Simulator](/api/qiskit-ibm-runtime/options-simulator-options): Simulator options, such as the basis gates, simulator seed, and coupling map. Applies to [local testing mode](/guides/local-testing-mode) only. + - [Twirling](/api/qiskit-ibm-runtime/options-twirling-options): Twirling options, such as whether to apply two-qubit gate twirling and the number of shots to run for each random sample. - - [Dynamical decoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions): Options for dynamical decoupling. - - [Environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions): Execution environment options, such as the logging level to set and job tags to add. - - [Execution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [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](/guides/local-testing-mode) only. - - [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. + - [Dynamical decoupling](/api/qiskit-ibm-runtime/options-dynamical-decoupling-options): Options for dynamical decoupling. + - [Environment](/api/qiskit-ibm-runtime/options-environment-options): Execution environment options, such as the logging level to set and job tags to add. + - [Execution](/api/qiskit-ibm-runtime/options-execution-options-v2): Primitive execution options, including whether to initialize qubits and the repetition delay. + - [Simulator](/api/qiskit-ibm-runtime/options-simulator-options): Simulator options, such as the basis gates, simulator seed, and coupling map. Applies to [local testing mode](/guides/local-testing-mode) only. + - [Twirling](/api/qiskit-ibm-runtime/options-twirling-options): Twirling options, such as whether to apply two-qubit gate twirling and the number of shots to run for each random sample. @@ -63,15 +63,15 @@ Scroll to see the full table. | Option | Sub-option | Sub-sub-option | Choices | Default | Option | |----------------------|--------------------------|-------------------------|-------------------------------------------------------------------------------------------|---------------------------|----------------------| -| [default_shots](/api/qiskit-ibm-runtime/options-estimator-options) | | | Integer in the range[0, `backend.max_shots`]| None | default_shots | -| [default_precision](/api/qiskit-ibm-runtime/options-estimator-options) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | +| [default_shots](/api/qiskit-ibm-runtime/options-estimator-options#default_shots) | | | Integer in the range[0, `backend.max_shots`]| None | default_shots | +| [default_precision](/api/qiskit-ibm-runtime/options-estimator-options#default_precision) | | | float > 0 | `0.015625 (1 / sqrt(4096))` | default_precision | | [dynamical_decoupling](/api/qiskit-ibm-runtime/options-dynamical-decoupling-options) | | | | | dynamical_decoupling | | | enable | | `True`/`False` | `False` | | | | extra_slack_distribution | | `middle`/`edges` | `middle` | | | | scheduling_method | | `asap`/`alap` | `alap` | | | | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | | | skip_reset_qubits | | `True`/`False` | `False` | | -| [environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | environment | +| [environment](/api/qiskit-ibm-runtime/qiskit_ibm_options-environment-options) | | | | | environment | | | callback | |Callable function that receives Job ID and Job result. |`None` | | | | job_tags | |List of tags |`None` | | | | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | @@ -79,9 +79,9 @@ Scroll to see the full table. | [execution](/api/qiskit-ibm-runtime/options-execution-options-v2) | | | | | execution | | | init_qubits | | `True`/`False` | `True` | | | | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | -| [max_execution_time](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | -| [resilience](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2) | | | | | resilience | -| | [layer_noise_learning](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2#layer_noise_learning) | | | | | +| [max_execution_time](/api/qiskit-ibm-runtime/options-estimator-options#max_estimation_time) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | +| [resilience](/api/qiskit-ibm-runtime/options-resilience-options-v2) | | | | | resilience | +| | [layer_noise_learning](/api/qiskit-ibm-runtime/options-resilience-options-v2#layer_noise_learning) | | | | | | | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | | | | num_randomizations | integer >= 1 | `32` | | @@ -94,18 +94,18 @@ Scroll to see the full table. | | [pec](/api/qiskit-ibm-runtime/options-pec-options) | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | | | zne_mitigation | `True`/`False` | `False` | | -| | [zne](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions) | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | +| | [zne](/api/qiskit-ibm-runtime/options-zne-options) | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | | | | extrapolated_noise_factors | list of floats | `[0, *noise_factors]`| | | | | extrapolator | one or more of `exponential`
`linear`
`double_exponential`
`polynomial_degree_(1 <= k <= 7)`
`fallback` | (`exponential`, `linear`) | | | | | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | -| [resilience_level](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | `0`/`1`/`2` | `1` | resilience_level | -| [seed_estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions) | | | integer | `None` | seed_estimator | -| [simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | | simulator | +| [resilience_level](/api/qiskit-ibm-runtime/options-estimator-options#resilience_level) | | | `0`/`1`/`2` | `1` | resilience_level | +| [seed_estimator](/api/qiskit-ibm-runtime/options-estimator-options#seed_estimator) | | | integer | `None` | seed_estimator | +| [simulator](/api/qiskit-ibm-runtime/options-simulator-options) | | | | | simulator | | | basis_gates | | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | | | coupling_map | | List of directed two-qubit interactions | full connectivity | | | | noise_model | | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | | | | seed_simulator | | integer | `None` | | -| [twirling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | twirling | +| [twirling](/api/qiskit-ibm-runtime/options-twirling-options) | | | | | twirling | | | enable_gates | | `True`/`False` | `False` | | | | enable_measure | | `True`/`False` | `True` | | | | num_randomizations | | `auto`/ integer >= 1 | `auto` | | @@ -118,29 +118,29 @@ Scroll to see the full table. | Option | Sub-option | Choices | Default | Option | |---------------------------------------------------------------------------------------------------------|--------------------------|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------------------| -| [default_shots](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer in the range[0, `backend.max_shots`] | `4096` | default_shots | -| [dynamical_decoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions) | | | | dynamical_decoupling | +| [default_shots](/api/qiskit-ibm-runtime/options-sampler-options#default_shots) | | Integer in the range[0, `backend.max_shots`] | `4096` | default_shots | +| [dynamical_decoupling](/api/qiskit-ibm-runtime/options-dynamical-decoupling-options) | | | | dynamical_decoupling | | | enable | `True`/`False` | `False` | | | | sequence_type | `XX`/`XpXm`/`XY4` | `XX` | | | | extra_slack_distribution | `middle`/`edges` | `middle` | | | | scheduling_method | `asap`/`alap` | `alap` | | | | skip_reset_qubits | `True`/`False` | `False` | | -| [environment](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) | | | | | +| [environment](/api/qiskit-ibm-runtime/options-environment-options) | | | | | | | log_level | `DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` | `WARNING` | environment | | | callback | Callable function that receives Job ID and Job result. | `None` | | | | job_tags | List of tags | `None` | | | | private | `True`/`False` | `False` | | -| [execution](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2) | | | | | +| [execution](/api/qiskit-ibm-runtime/options-execution-options-v2) | | | | | | | init_qubits | `True`/`False` | `True` | execution | | | meas_type | `classified`/`kerneled`/`avg_kerneled` | `classified` | | | | rep_delay | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`. | | -| [max_execution_time](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions) | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | | -| [simulator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions) | | | | max_execution_time | +| [max_execution_time](/api/qiskit-ibm-runtime/options-sampler-options#max_execution_time) | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | | +| [simulator](/api/qiskit-ibm-runtime/options-simulator-options) | | | | max_execution_time | | | noise_model | [Qiskit Aer NoiseModel](build-noise-models), or its representation | `None` | simulator | | | seed_simulator | integer | `None` | | | | coupling_map | List of directed two-qubit interactions | full connectivity | | | | basis_gates | List of basis gate names to unroll to | The set of all basis gates supported by [Qiskit Aer simulator](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html) | | -| [twirling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions) | | | | | +| [twirling](/api/qiskit-ibm-runtime/options-twirling-options) | | | | | | | enable_gates | `True`/`False` | `False` | twirling | | | enable_measure | `True`/`False` | `True` | | | | num_randomizations | `auto`/ integer >= 1 | `auto` | | From d58516e601e7c18e37516c653555be9b7d181041 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Thu, 30 Jan 2025 16:11:57 -0600 Subject: [PATCH 14/17] wonky links --- docs/guides/runtime-options-overview.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index b65505e758..c42f6264bf 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -35,7 +35,7 @@ Options can be defined before a primitive is constructed and passed to the primi - [Dynamical decoupling](/api/qiskit-ibm-runtime/options-dynamical-decoupling-options): Options for dynamical decoupling. - [Environment](/api/qiskit-ibm-runtime/options-environment-options): Execution environment options, such as the logging level to set and job tags to add. - [Execution](/api/qiskit-ibm-runtime/options-execution-options-v2): Primitive execution options, including whether to initialize qubits and the repetition delay. - - [Resilience](/api/qiskit-ibm-runtime/options-resiliance-options-v2): Advanced options for configuring error mitigation methods such as measurement error mitigation, ZNE, and PEC. + - [Resilience](/api/qiskit-ibm-runtime//options-resilience-options-v2): Advanced options for configuring error mitigation methods such as measurement error mitigation, ZNE, and PEC. - [Simulator](/api/qiskit-ibm-runtime/options-simulator-options): Simulator options, such as the basis gates, simulator seed, and coupling map. Applies to [local testing mode](/guides/local-testing-mode) only. - [Twirling](/api/qiskit-ibm-runtime/options-twirling-options): Twirling options, such as whether to apply two-qubit gate twirling and the number of shots to run for each random sample. @@ -71,7 +71,7 @@ Scroll to see the full table. | | scheduling_method | | `asap`/`alap` | `alap` | | | | sequence_type | | `XX`/`XpXm`/`XY4` | `XX` | | | | skip_reset_qubits | | `True`/`False` | `False` | | -| [environment](/api/qiskit-ibm-runtime/qiskit_ibm_options-environment-options) | | | | | environment | +| [environment](/api/qiskit-ibm-runtime/options-environment-options) | | | | | environment | | | callback | |Callable function that receives Job ID and Job result. |`None` | | | | job_tags | |List of tags |`None` | | | | log_level | |`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL` |`WARNING` | | @@ -79,7 +79,7 @@ Scroll to see the full table. | [execution](/api/qiskit-ibm-runtime/options-execution-options-v2) | | | | | execution | | | init_qubits | | `True`/`False` | `True` | | | | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | -| [max_execution_time](/api/qiskit-ibm-runtime/options-estimator-options#max_estimation_time) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | +| [max_execution_time](/api/qiskit-ibm-runtime/options-estimator-options#max_execution_time) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | | [resilience](/api/qiskit-ibm-runtime/options-resilience-options-v2) | | | | | resilience | | | [layer_noise_learning](/api/qiskit-ibm-runtime/options-resilience-options-v2#layer_noise_learning) | | | | | | | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | From 23219560b7c910fb48572042b60cd5af45f034f8 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Date: Fri, 31 Jan 2025 10:58:07 -0600 Subject: [PATCH 15/17] Update docs/guides/runtime-options-overview.mdx Co-authored-by: Jessie Yu --- docs/guides/runtime-options-overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index c42f6264bf..6c8c605373 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -81,7 +81,7 @@ Scroll to see the full table. | | rep_delay | | Value in the range supplied by `backend.rep_delay_range`. | Given by `backend.default_rep_delay`.| | | [max_execution_time](/api/qiskit-ibm-runtime/options-estimator-options#max_execution_time) | | | Integer number of seconds in the range [1, 10800] | `10800` (3 hours) | max_execution_time | | [resilience](/api/qiskit-ibm-runtime/options-resilience-options-v2) | | | | | resilience | -| | [layer_noise_learning](/api/qiskit-ibm-runtime/options-resilience-options-v2#layer_noise_learning) | | | | | +| | [layer_noise_learning](/api/qiskit-ibm-runtime/options-layer-noise-learning-options) | | | | | | | | layer_pair_depths | list[int] of 2-10 values in the range [0, 200] | `(0, 1, 2, 4, 16, 32)` | | | | | max_layers_to_learn | `None`/ integer >= 1 | `4` | | | | | num_randomizations | integer >= 1 | `32` | | From c2124035e655df91075560c4384b4926ca918dd4 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Fri, 31 Jan 2025 11:03:22 -0600 Subject: [PATCH 16/17] move zne --- docs/guides/runtime-options-overview.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 6c8c605373..55bcbbd6f3 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -94,7 +94,8 @@ Scroll to see the full table. | | [pec](/api/qiskit-ibm-runtime/options-pec-options) | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | | | zne_mitigation | `True`/`False` | `False` | | -| | [zne](/api/qiskit-ibm-runtime/options-zne-options) | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea ` | `gate_folding` | | +| | [zne](/api/qiskit-ibm-runtime/options-zne-options) | | | | | +| | | amplifier | `gate_folding`, `gate_folding_front`, `gate_folding_back, pea` | `gate_folding` | | | | | extrapolated_noise_factors | list of floats | `[0, *noise_factors]`| | | | | extrapolator | one or more of `exponential`
`linear`
`double_exponential`
`polynomial_degree_(1 <= k <= 7)`
`fallback` | (`exponential`, `linear`) | | | | | noise_factors | list of floats; each float >= 1 | `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise. | | From 2edafd78314b85b02d19d984d888c28cb0b8ab01 Mon Sep 17 00:00:00 2001 From: Rebecca Dimock Date: Fri, 31 Jan 2025 11:19:09 -0600 Subject: [PATCH 17/17] move pec options --- docs/guides/runtime-options-overview.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/guides/runtime-options-overview.mdx b/docs/guides/runtime-options-overview.mdx index 55bcbbd6f3..446969c63b 100644 --- a/docs/guides/runtime-options-overview.mdx +++ b/docs/guides/runtime-options-overview.mdx @@ -91,7 +91,8 @@ Scroll to see the full table. | | [measure_noise_learning](/api/qiskit-ibm-runtime/options-measure-noise-learning-options) | num_randomizations | integer >= 1 | `32` | | | | | shots_per_randomization | integer | 'auto' | | | | pec_mitigation | | `True`/`False` | `False` | | -| | [pec](/api/qiskit-ibm-runtime/options-pec-options) | max_overhead | `None`/ integer >1 | `100` | | +| | [pec](/api/qiskit-ibm-runtime/options-pec-options) | | | | | +| | | max_overhead | `None`/ integer >1 | `100` | | | | | noise_gain | `auto`/ float in the range `[0, 1]` | `auto` | | | | zne_mitigation | `True`/`False` | `False` | | | | [zne](/api/qiskit-ibm-runtime/options-zne-options) | | | | |