Skip to main contentIBM Quantum Documentation
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

PecOptions

class PecOptions(max_overhead=Unset, noise_gain=Unset)

GitHub

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

Type: UnsetType | float | None

Default value: Unset

The maximum circuit sampling overhead allowed, or None for no maximum.

Default: 100.

noise_gain

Type: UnsetType | float | Literal['auto']

Default value: 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”.


Methods

Was this page helpful?
Report a bug or request content on GitHub.