From 986361a677a68eb9ef687afca771a750b3855f30 Mon Sep 17 00:00:00 2001 From: Jessie Yu Date: Tue, 4 Jun 2024 20:48:56 -0400 Subject: [PATCH] Document PEA as an experimental option (#1728) * add pea as experimental * release note --- qiskit_ibm_runtime/options/estimator_options.py | 7 ++++++- release-notes/unreleased/1728.feat.rst | 1 + 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 release-notes/unreleased/1728.feat.rst diff --git a/qiskit_ibm_runtime/options/estimator_options.py b/qiskit_ibm_runtime/options/estimator_options.py index 2a8c67522..8eb9291d5 100644 --- a/qiskit_ibm_runtime/options/estimator_options.py +++ b/qiskit_ibm_runtime/options/estimator_options.py @@ -102,7 +102,12 @@ class EstimatorOptions(OptionsV2): twirling: Pauli twirling options. See :class:`TwirlingOptions` for all available options. - experimental: Experimental options. + experimental: Experimental options. These options are subject to change without notification, and + stability is not guaranteed. Currently, the available options are: + + * Probabilistic Error Amplification (PEA). To enable PEA, set:: + + estimator_options.experimental = {"resilience": {"zne": {"amplifier": "pea"}}} """ # Sadly we cannot use pydantic's built in validation because it won't work on Unset. diff --git a/release-notes/unreleased/1728.feat.rst b/release-notes/unreleased/1728.feat.rst new file mode 100644 index 000000000..291e3580d --- /dev/null +++ b/release-notes/unreleased/1728.feat.rst @@ -0,0 +1 @@ +You can now use the experimental option in :class:`qiskit_ibm_runtime.options.EstimatorOptions` to enable Probabilistic Error Amplification (PEA) error mitigation method for your estimator jobs. \ No newline at end of file