143 lines
7.8 KiB
Plaintext
143 lines
7.8 KiB
Plaintext
---
|
|
title: EstimatorOptions (v0.33)
|
|
description: API reference for qiskit_ibm_runtime.options.EstimatorOptions in qiskit-ibm-runtime v0.33
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit_ibm_runtime.options.EstimatorOptions
|
|
---
|
|
|
|
# EstimatorOptions
|
|
|
|
<Class id="qiskit_ibm_runtime.options.EstimatorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.33/qiskit_ibm_runtime/options/estimator_options.py#L34-L112" signature="EstimatorOptions(_VERSION=2, max_execution_time=Unset, environment=<factory>, simulator=<factory>, default_precision=Unset, default_shots=Unset, resilience_level=Unset, seed_estimator=Unset, dynamical_decoupling=<factory>, resilience=<factory>, execution=<factory>, twirling=<factory>, experimental=Unset)" modifiers="class">
|
|
Bases: `OptionsV2`
|
|
|
|
Options for V2 Estimator.
|
|
|
|
## Attributes
|
|
|
|
**Parameters**
|
|
|
|
* **\_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*)
|
|
* **default\_precision** (*UnsetType | float*)
|
|
* **default\_shots** (*UnsetType | int | None*)
|
|
* **resilience\_level** (*UnsetType | int*)
|
|
* **seed\_estimator** (*UnsetType | int*)
|
|
* **dynamical\_decoupling** ([*DynamicalDecouplingOptions*](options-dynamical-decoupling-options "qiskit_ibm_runtime.options.dynamical_decoupling_options.DynamicalDecouplingOptions") *| Dict*)
|
|
* **resilience** ([*ResilienceOptionsV2*](options-resilience-options-v2 "qiskit_ibm_runtime.options.resilience_options.ResilienceOptionsV2") *| Dict*)
|
|
* **execution** ([*ExecutionOptionsV2*](options-execution-options-v2 "qiskit_ibm_runtime.options.execution_options.ExecutionOptionsV2") *| Dict*)
|
|
* **twirling** ([*TwirlingOptions*](options-twirling-options "qiskit_ibm_runtime.options.twirling_options.TwirlingOptions") *| Dict*)
|
|
* **experimental** (*UnsetType | dict*)
|
|
|
|
### default\_precision
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.default_precision" attributeTypeHint="UnsetType | float" attributeValue="Unset">
|
|
The default precision to use for any PUB or `run()` call that does not specify one. Each Estimator PUB can specify its own precision. If the `run()` method is given a precision, then that value is used for all PUBs in the `run()` call that do not specify their own.
|
|
|
|
Default: 0.015625 (1 / sqrt(4096)).
|
|
</Attribute>
|
|
|
|
### default\_shots
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.default_shots" attributeTypeHint="UnsetType | int | None" attributeValue="Unset">
|
|
The total number of shots to use per circuit per configuration.
|
|
|
|
<Admonition title="Note" type="note">
|
|
If set, this value overrides [`default_precision`](#qiskit_ibm_runtime.options.EstimatorOptions.default_precision "qiskit_ibm_runtime.options.EstimatorOptions.default_precision").
|
|
</Admonition>
|
|
|
|
A configuration is a combination of a specific parameter value binding set and a physical measurement basis. A physical measurement basis groups together some collection of qubit-wise commuting observables for some specific circuit/parameter value set to create a single measurement with basis rotations that is inserted into hardware executions.
|
|
|
|
If twirling is enabled, the value of this option will be divided over circuit randomizations, with a smaller number of shots per randomization. See the [`twirling`](#qiskit_ibm_runtime.options.EstimatorOptions.twirling "qiskit_ibm_runtime.options.EstimatorOptions.twirling") options.
|
|
|
|
Default: `None`.
|
|
</Attribute>
|
|
|
|
### dynamical\_decoupling
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.dynamical_decoupling" attributeTypeHint="DynamicalDecouplingOptions | Dict" attributeValue="FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)">
|
|
Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](options-dynamical-decoupling-options "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options.
|
|
</Attribute>
|
|
|
|
### environment
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.environment" attributeTypeHint="EnvironmentOptions | Dict" attributeValue="FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)" />
|
|
|
|
### execution
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.execution" attributeTypeHint="ExecutionOptionsV2 | Dict" attributeValue="FieldInfo(annotation=Union[ExecutionOptionsV2, Dict], required=False, default_factory=ExecutionOptionsV2)">
|
|
Execution time options. See [`ExecutionOptionsV2`](options-execution-options-v2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options.
|
|
</Attribute>
|
|
|
|
### experimental
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.experimental" attributeTypeHint="UnsetType | dict" attributeValue="Unset">
|
|
Experimental options. These options are subject to change without notification, and stability is not guaranteed.
|
|
</Attribute>
|
|
|
|
### max\_execution\_time
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.max_execution_time" attributeTypeHint="UnsetType | int" attributeValue="Unset" />
|
|
|
|
### resilience
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.resilience" attributeTypeHint="ResilienceOptionsV2 | Dict" attributeValue="FieldInfo(annotation=Union[ResilienceOptionsV2, Dict], required=False, default_factory=ResilienceOptionsV2)">
|
|
Advanced resilience options to fine-tune the resilience strategy. See [`ResilienceOptionsV2`](options-resilience-options-v2 "qiskit_ibm_runtime.options.ResilienceOptionsV2") for all available options.
|
|
</Attribute>
|
|
|
|
### resilience\_level
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.resilience_level" attributeTypeHint="UnsetType | int" attributeValue="Unset">
|
|
How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times.
|
|
|
|
* 0: No mitigation.
|
|
|
|
* 1: Minimal mitigation costs. Mitigate error associated with readout errors.
|
|
|
|
* **2: Medium mitigation costs. Typically reduces bias in estimators but**
|
|
|
|
is not guaranteed to be zero bias.
|
|
|
|
Refer to the [Configure error mitigation for Qiskit Runtime](/guides/configure-error-mitigation) guide for more information about the error mitigation methods used at each level.
|
|
|
|
Default: 1.
|
|
</Attribute>
|
|
|
|
### seed\_estimator
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.seed_estimator" attributeTypeHint="UnsetType | int" attributeValue="Unset">
|
|
Seed used to control sampling.
|
|
|
|
Default: `None`.
|
|
</Attribute>
|
|
|
|
### simulator
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.simulator" attributeTypeHint="SimulatorOptions | Dict" attributeValue="FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)" />
|
|
|
|
### twirling
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.twirling" attributeTypeHint="TwirlingOptions | Dict" attributeValue="FieldInfo(annotation=Union[TwirlingOptions, Dict], required=False, default_factory=TwirlingOptions)">
|
|
Pauli twirling options. See [`TwirlingOptions`](options-twirling-options "qiskit_ibm_runtime.options.TwirlingOptions") for all available options.
|
|
</Attribute>
|
|
|
|
## Methods
|
|
|
|
### update
|
|
|
|
<Function id="qiskit_ibm_runtime.options.EstimatorOptions.update" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.33/qiskit_ibm_runtime/options/options.py#L146-L155" signature="update(**kwargs)">
|
|
Update the options.
|
|
|
|
**Parameters**
|
|
|
|
**kwargs** (*Any*)
|
|
|
|
**Return type**
|
|
|
|
None
|
|
</Function>
|
|
</Class>
|
|
|