Merge pull request #162 from mrava87/doc-benchmark

tharittk · web-flow · commit d1ae9b181fd4 · 2025-07-29T20:03:41.000+07:00
doc: added benchmark to doc
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -118,9 +118,11 @@ Utils
     local_split
 
 
-.. currentmodule:: pylops_mpi.utils.dottest
+.. currentmodule:: pylops_mpi.utils
 
 .. autosummary::
    :toctree: generated/
 
-    dottest
+    dottest
+    benchmark
+    mark
diff --git a/docs/source/benchmarking.rst b/docs/source/benchmarking.rst
@@ -1,7 +1,8 @@
 .. _benchmarkutility:
 
-Benchmark Utility in PyLops-MPI
-===============================
+Benchmarking
+============
+
 PyLops-MPI users can convenienly benchmark the performance of their code with a simple decorator.
 :py:func:`pylops_mpi.utils.benchmark` and :py:func:`pylops_mpi.utils.mark` support various
 function calling patterns that may arise when benchmarking distributed code.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -76,6 +76,7 @@ class and implementing the ``_matvec`` and ``_rmatvec``.
     self
     installation.rst
     gpu.rst
+    benchmarking.rst
 
 .. toctree::
    :maxdepth: 2
diff --git a/pylops_mpi/utils/__init__.py b/pylops_mpi/utils/__init__.py
@@ -1,4 +1,5 @@
 # isort: skip_file
 
+from .benchmark import *
 from .dottest import *
 from .deps import *
diff --git a/pylops_mpi/utils/benchmark.py b/pylops_mpi/utils/benchmark.py
@@ -1,3 +1,7 @@
+__all__ = ["benchmark",
+           "mark",
+           ]
+
 import functools
 import logging
 import os
