Document PEA as an experimental option (#1728)

* add pea as experimental * release note
Qiskit · Jun 5, 2024 · 986361a · 986361a
1 parent 972e7e4
commit 986361a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git 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
@@ -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.