49 lines
1.8 KiB
Plaintext
49 lines
1.8 KiB
Plaintext
---
|
|
title: PecOptions (v0.34)
|
|
description: API reference for qiskit_ibm_runtime.options.PecOptions in qiskit-ibm-runtime v0.34
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit_ibm_runtime.options.PecOptions
|
|
---
|
|
|
|
# PecOptions
|
|
|
|
<Class id="qiskit_ibm_runtime.options.PecOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.34/qiskit_ibm_runtime/options/pec_options.py#L20-L46" signature="PecOptions(max_overhead=Unset, noise_gain=Unset)" modifiers="class">
|
|
Bases: `object`
|
|
|
|
Probabalistic error cancellation mitigation options. This is only used by V2 Estimator.
|
|
|
|
## Attributes
|
|
|
|
**Parameters**
|
|
|
|
* **max\_overhead** (*UnsetType | float | None*)
|
|
* **noise\_gain** (*UnsetType | float | Literal\['auto']*)
|
|
|
|
### max\_overhead
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.PecOptions.max_overhead" attributeTypeHint="UnsetType | float | None" attributeValue="Unset">
|
|
The maximum circuit sampling overhead allowed, or `None` for no maximum.
|
|
|
|
Default: 100.
|
|
</Attribute>
|
|
|
|
### noise\_gain
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.PecOptions.noise_gain" attributeTypeHint="UnsetType | float | Literal['auto']" attributeValue="Unset">
|
|
The amount by which to scale the noise, where:
|
|
|
|
* A value of 0 corresponds to removing the full learned noise.
|
|
* A value of 1 corresponds to no removal of the learned noise.
|
|
* A value between 0 and 1 corresponds to partially removing the learned noise.
|
|
* A value greater than one corresponds to amplifying the learned noise.
|
|
|
|
If “auto”, the value in the range `[0, 1]` will be chosen automatically for each input PUB based on the learned noise strength, `max_overhead`, and the depth of the PUB.
|
|
|
|
Default: “auto”.
|
|
</Attribute>
|
|
|
|
## Methods
|
|
</Class>
|
|
|