64 lines
3.0 KiB
Plaintext
64 lines
3.0 KiB
Plaintext
---
|
||
title: SamplerOptions
|
||
description: API reference for qiskit_ibm_runtime.options.SamplerOptions
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit_ibm_runtime.options.SamplerOptions
|
||
---
|
||
|
||
# SamplerOptions
|
||
|
||
<Class id="qiskit_ibm_runtime.options.SamplerOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.22/qiskit_ibm_runtime/options/sampler_options.py#L26-L48" signature="SamplerOptions(*args, **kwargs)" modifiers="class">
|
||
Options for V2 Sampler.
|
||
|
||
**Parameters**
|
||
|
||
* **default\_shots** – The default number of shots to use if none are specified in the PUBs or in the run method. Default: 4096.
|
||
* **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options.
|
||
* **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options.
|
||
* **experimental** – Experimental options.
|
||
|
||
## Attributes
|
||
|
||
### default\_shots
|
||
|
||
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.default_shots" attributeTypeHint="UnsetType | int" attributeValue="Unset" />
|
||
|
||
### dynamical\_decoupling
|
||
|
||
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.dynamical_decoupling" attributeTypeHint="DynamicalDecouplingOptions | Dict" attributeValue="FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)" />
|
||
|
||
### environment
|
||
|
||
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.environment" attributeTypeHint="EnvironmentOptions | Dict" attributeValue="FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)" />
|
||
|
||
### execution
|
||
|
||
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.execution" attributeTypeHint="ExecutionOptionsV2 | Dict" attributeValue="FieldInfo(annotation=Union[ExecutionOptionsV2, Dict], required=False, default_factory=ExecutionOptionsV2)" />
|
||
|
||
### experimental
|
||
|
||
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.experimental" attributeTypeHint="UnsetType | dict" attributeValue="Unset" />
|
||
|
||
### max\_execution\_time
|
||
|
||
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.max_execution_time" attributeTypeHint="UnsetType | int" attributeValue="Unset" />
|
||
|
||
### simulator
|
||
|
||
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.simulator" attributeTypeHint="SimulatorOptions | Dict" attributeValue="FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)" />
|
||
|
||
## Methods
|
||
|
||
### update
|
||
|
||
<Function id="qiskit_ibm_runtime.options.SamplerOptions.update" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.22/qiskit_ibm_runtime/options/options.py#L106-L111" signature="update(**kwargs)">
|
||
Update the options.
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
</Class>
|
||
|