docs

SamFerracin · Aug 12, 2024 · 59e5b71 · 59e5b71
1 parent 0e5a2e8
commit 59e5b71
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
@@ -9,6 +9,7 @@ qiskit-ibm-runtime API reference
 
    runtime_service
    noise_learner
+   noise_learner_result
    options
    transpiler
    qiskit_ibm_runtime.transpiler.passes.scheduling

diff --git a/docs/apidocs/noise_learner_result.rst b/docs/apidocs/noise_learner_result.rst
@@ -0,0 +1,4 @@
+.. automodule:: qiskit_ibm_runtime.utils.noise_learner_result
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/qiskit_ibm_runtime/noise_learner/__init__.py b/qiskit_ibm_runtime/noise_learner/__init__.py
@@ -20,9 +20,6 @@
 The tools to characterize the noise processes affecting the gates in noisy
 quantum circuits.
 
-Classes
-=======
-
 .. autosummary::
    :toctree: ../stubs/
 

diff --git a/qiskit_ibm_runtime/utils/noise_learner_result.py b/qiskit_ibm_runtime/utils/noise_learner_result.py
@@ -10,7 +10,17 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-"""NoiseLearner result class"""
+"""
+==================================================================================
+NoiseLearner result classes (:mod:`qiskit_ibm_runtime.utils.noise_learner_result`)
+==================================================================================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   PauliLindbladError
+   LayerError
+"""
 
 from __future__ import annotations