Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions docs/api/qiskit-ibm-runtime/dev/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -608,6 +608,11 @@
"url": "/docs/api/qiskit-ibm-runtime/dev/options-layer-noise-learning-options",
"untranslatable": true
},
{
"title": "LegacySimulatorOptions",
"url": "/docs/api/qiskit-ibm-runtime/dev/options-legacy-simulator-options",
"untranslatable": true
},
{
"title": "MeasureNoiseLearningOptions",
"url": "/docs/api/qiskit-ibm-runtime/dev/options-measure-noise-learning-options",
Expand Down Expand Up @@ -638,11 +643,6 @@
"url": "/docs/api/qiskit-ibm-runtime/dev/options-sampler-options",
"untranslatable": true
},
{
"title": "SimulatorOptions",
"url": "/docs/api/qiskit-ibm-runtime/dev/options-simulator-options",
"untranslatable": true
},
{
"title": "TwirlingOptions",
"url": "/docs/api/qiskit-ibm-runtime/dev/options-twirling-options",
Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit-ibm-runtime/dev/options-estimator-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions
* **\_VERSION** (*int*)
* **max\_execution\_time** (*UnsetType | int*)
* **environment** ([*EnvironmentOptions*](options-environment-options "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*)
* **simulator** ([*SimulatorOptions*](options-simulator-options "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*)
* **simulator** ([*LegacySimulatorOptions*](options-legacy-simulator-options "qiskit_ibm_runtime.options.simulator_options.LegacySimulatorOptions") *| Dict*)
* **default\_precision** (*UnsetType | float*)
* **default\_shots** (*UnsetType | int | None*)
* **resilience\_level** (*UnsetType | int*)
Expand Down Expand Up @@ -125,7 +125,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions

### simulator

<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.simulator" attributeTypeHint="SimulatorOptions | Dict" attributeTypeHintHref="options-simulator-options" attributeValue="FieldInfo(annotation=NoneType, required=False, default_factory=SimulatorOptions)" />
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.simulator" attributeTypeHint="LegacySimulatorOptions | Dict" attributeTypeHintHref="options-legacy-simulator-options" attributeValue="FieldInfo(annotation=NoneType, required=False, default_factory=LegacySimulatorOptions)" />

### twirling

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: SimulatorOptions (dev version)
description: API reference for qiskit_ibm_runtime.options.SimulatorOptions in the dev version of qiskit-ibm-runtime
title: LegacySimulatorOptions (dev version)
description: API reference for qiskit_ibm_runtime.options.LegacySimulatorOptions in the dev version of qiskit-ibm-runtime
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.options.SimulatorOptions
python_api_name: qiskit_ibm_runtime.options.LegacySimulatorOptions
---

# SimulatorOptions
# LegacySimulatorOptions

<Class id="qiskit_ibm_runtime.options.SimulatorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L30-L110" signature="SimulatorOptions(noise_model=Unset, seed_simulator=Unset, coupling_map=Unset, basis_gates=Unset)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.LegacySimulatorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L30-L110" signature="LegacySimulatorOptions(noise_model=Unset, seed_simulator=Unset, coupling_map=Unset, basis_gates=Unset)" modifiers="class">
Bases: `object`

Simulator options.
Expand All @@ -26,7 +26,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions

### basis\_gates

<Attribute id="qiskit_ibm_runtime.options.SimulatorOptions.basis_gates" attributeTypeHint="UnsetType | list[str]" attributeValue="Unset">
<Attribute id="qiskit_ibm_runtime.options.LegacySimulatorOptions.basis_gates" attributeTypeHint="UnsetType | list[str]" attributeValue="Unset">
List of basis gate names to unroll to.

For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set.
Expand All @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions

### coupling\_map

<Attribute id="qiskit_ibm_runtime.options.SimulatorOptions.coupling_map" attributeTypeHint="UnsetType | list[list[int]] | CouplingMap" attributeTypeHintHref="https://quantum.cloud.ibm.com/docs/api/qiskit/qiskit.transpiler.CouplingMap" attributeValue="Unset">
<Attribute id="qiskit_ibm_runtime.options.LegacySimulatorOptions.coupling_map" attributeTypeHint="UnsetType | list[list[int]] | CouplingMap" attributeTypeHintHref="https://quantum.cloud.ibm.com/docs/api/qiskit/qiskit.transpiler.CouplingMap" attributeValue="Unset">
Directed coupling map to target in mapping.

If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interaction, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]`.
Expand All @@ -46,7 +46,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions

### noise\_model

<Attribute id="qiskit_ibm_runtime.options.SimulatorOptions.noise_model" attributeTypeHint="UnsetType | dict | NoiseModel | None" attributeValue="Unset">
<Attribute id="qiskit_ibm_runtime.options.LegacySimulatorOptions.noise_model" attributeTypeHint="UnsetType | dict | NoiseModel | None" attributeValue="Unset">
Noise model for the simulator.

This option is only supported in local testing mode.
Expand All @@ -56,7 +56,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions

### seed\_simulator

<Attribute id="qiskit_ibm_runtime.options.SimulatorOptions.seed_simulator" attributeTypeHint="UnsetType | int" attributeValue="Unset">
<Attribute id="qiskit_ibm_runtime.options.LegacySimulatorOptions.seed_simulator" attributeTypeHint="UnsetType | int" attributeValue="Unset">
Random seed to control sampling.

Default: `None`.
Expand All @@ -66,7 +66,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions

### set\_backend

<Function id="qiskit_ibm_runtime.options.SimulatorOptions.set_backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L88-L110" signature="set_backend(backend)">
<Function id="qiskit_ibm_runtime.options.LegacySimulatorOptions.set_backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L88-L110" signature="set_backend(backend)">
Set backend for simulation.

This method changes noise\_model, coupling\_map, basis\_gates according to given backend.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options_models.ExecutorOptions

# qiskit\_ibm\_runtime.options\_models.ExecutorOptions

<Class id="qiskit_ibm_runtime.options_models.ExecutorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options_models/executor.py#L22-L32" signature="ExecutorOptions" modifiers="pydantic model">
<Class id="qiskit_ibm_runtime.options_models.ExecutorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options_models/executor.py#L23-L40" signature="ExecutorOptions" modifiers="pydantic model">
Bases: `BaseOptionsModel`

Options for the executor.
Expand Down Expand Up @@ -38,6 +38,14 @@ python_api_name: qiskit_ibm_runtime.options_models.ExecutorOptions
Experimental options that are passed to the executor.
</Attribute>

### simulator

<Attribute id="qiskit_ibm_runtime.options_models.ExecutorOptions.simulator" attributeTypeHint="SimulatorOptions" attributeValue="SimulatorOptions(angle_decimals=5, noise_model=None, seed_simulator=None, warn_absent=True)" modifiers="field">
Simulator options.

These options are used when an executor is initialized with a backend that is a simulator, and they are ignored otherwise.
</Attribute>

### update

<Function id="qiskit_ibm_runtime.options_models.ExecutorOptions.update" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options_models/base.py#L46-L54" signature="update(**kwargs)">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions
* **\_VERSION** (*int*)
* **max\_execution\_time** (*UnsetType | int*)
* **environment** ([*EnvironmentOptions*](options-environment-options "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*)
* **simulator** ([*SimulatorOptions*](options-simulator-options "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*)
* **simulator** ([*LegacySimulatorOptions*](options-legacy-simulator-options "qiskit_ibm_runtime.options.simulator_options.LegacySimulatorOptions") *| Dict*)
* **max\_layers\_to\_learn** (*UnsetType | int | None*)
* **shots\_per\_randomization** (*UnsetType | int*)
* **num\_randomizations** (*UnsetType | int*)
Expand Down Expand Up @@ -88,7 +88,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions

### simulator

<Attribute id="qiskit_ibm_runtime.options.NoiseLearnerOptions.simulator" attributeTypeHint="SimulatorOptions | Dict" attributeTypeHintHref="options-simulator-options" attributeValue="FieldInfo(annotation=NoneType, required=False, default_factory=SimulatorOptions)" />
<Attribute id="qiskit_ibm_runtime.options.NoiseLearnerOptions.simulator" attributeTypeHint="LegacySimulatorOptions | Dict" attributeTypeHintHref="options-legacy-simulator-options" attributeValue="FieldInfo(annotation=NoneType, required=False, default_factory=LegacySimulatorOptions)" />

### twirling\_strategy

Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit-ibm-runtime/dev/options-sampler-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions
* **\_VERSION** (*int*)
* **max\_execution\_time** (*UnsetType | int*)
* **environment** ([*EnvironmentOptions*](options-environment-options "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*)
* **simulator** ([*SimulatorOptions*](options-simulator-options "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*)
* **simulator** ([*LegacySimulatorOptions*](options-legacy-simulator-options "qiskit_ibm_runtime.options.simulator_options.LegacySimulatorOptions") *| Dict*)
* **default\_shots** (*UnsetType | int*)
* **dynamical\_decoupling** ([*DynamicalDecouplingOptions*](options-dynamical-decoupling-options "qiskit_ibm_runtime.options.dynamical_decoupling_options.DynamicalDecouplingOptions") *| Dict*)
* **execution** ([*SamplerExecutionOptionsV2*](options-sampler-execution-options-v2 "qiskit_ibm_runtime.options.sampler_execution_options.SamplerExecutionOptionsV2") *| Dict*)
Expand Down Expand Up @@ -65,7 +65,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions

### simulator

<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.simulator" attributeTypeHint="SimulatorOptions | Dict" attributeTypeHintHref="options-simulator-options" attributeValue="FieldInfo(annotation=NoneType, required=False, default_factory=SimulatorOptions)" />
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.simulator" attributeTypeHint="LegacySimulatorOptions | Dict" attributeTypeHintHref="options-legacy-simulator-options" attributeValue="FieldInfo(annotation=NoneType, required=False, default_factory=LegacySimulatorOptions)" />

### twirling

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/dev/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ Refer to [`qiskit_ibm_runtime.options.SamplerOptions`](/docs/api/qiskit-ibm-runt
| [`ExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/dev/options-execution-options-v2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") | Execution options for V2 primitives. |
| [`SamplerExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/dev/options-sampler-execution-options-v2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") | Extends [`ExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/dev/options-execution-options-v2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. |
| [`EnvironmentOptions`](/docs/api/qiskit-ibm-runtime/dev/options-environment-options "qiskit_ibm_runtime.options.EnvironmentOptions") | Options related to the execution environment. |
| [`SimulatorOptions`](/docs/api/qiskit-ibm-runtime/dev/options-simulator-options "qiskit_ibm_runtime.options.SimulatorOptions") | Simulator options. |
| [`LegacySimulatorOptions`](/docs/api/qiskit-ibm-runtime/dev/options-legacy-simulator-options "qiskit_ibm_runtime.options.LegacySimulatorOptions") | Simulator options. |

Loading
Loading