Skip to content

Commit

Permalink
Update NoiseLearner docs (#2135)
Browse files Browse the repository at this point in the history
  • Loading branch information
kt474 authored Feb 10, 2025
1 parent 7de903f commit ff306ce
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions qiskit_ibm_runtime/noise_learner/noise_learner.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,15 @@
class NoiseLearner:
"""Class for executing noise learning experiments.
.. note::
Currently, the :class:`.NoiseLearner` is released an experimental feature.
As such, it is subject to change without notification and its stability is not
guaranteed.
The noise learner class allows characterizing the noise processes affecting the gates in one or more
circuits of interest, based on the Pauli-Lindblad noise model described in [1].
The :meth:`~run` method allows runnig a noise learner job for a list of circuits. After the job is
The :meth:`~run` method allows running a noise learner job for a list of circuits. After the job is
submitted, the gates are collected into independent layers, and subsequently the resulting layers are
are characterized individually.
characterized individually.
The way in which the gates are collected into layers depends on the twirling ``strategy`` specified
in the given ``options`` (see :class:`NoiseLearnerOptions` for more details). Note that all
in the given ``options`` (see :class:`.NoiseLearnerOptions` for more details). Note that all
strategies obey barriers. For example, if you have three ISA entangling layers of interest,
consider putting them into one circuit separated by barriers acting on the qubits you wish to
twirl, and select ``strategy="active-circuit"``.
Expand Down

0 comments on commit ff306ce

Please sign in to comment.