Skip to content

doc: added benchmark to doc #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,11 @@ Utils
local_split


.. currentmodule:: pylops_mpi.utils.dottest
.. currentmodule:: pylops_mpi.utils

.. autosummary::
:toctree: generated/

dottest
dottest
benchmark
mark
5 changes: 3 additions & 2 deletions docs/source/benchmarking.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ class and implementing the ``_matvec`` and ``_rmatvec``.
self
installation.rst
gpu.rst
benchmarking.rst

.. toctree::
:maxdepth: 2
Expand Down
1 change: 1 addition & 0 deletions pylops_mpi/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# isort: skip_file

from .benchmark import *
from .dottest import *
from .deps import *
4 changes: 4 additions & 0 deletions pylops_mpi/utils/benchmark.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
__all__ = ["benchmark",
"mark",
]

import functools
import logging
import os
Expand Down
Loading