Skip to content

Commit 2f1225a

Browse files
committed
Update docstring
1 parent b62fcbe commit 2f1225a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

pylops_mpi/utils/_mpi.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,14 @@ def mpi_allgather(base_comm: MPI.Comm,
2020
recv_buf: Optional[NDArray] = None,
2121
engine: str = "numpy",
2222
) -> List[NDArray]:
23-
"""MPI_Allallgather/allallgather
23+
"""MPI_Allgather/allgather
2424
25-
Dispatch allgather routine based on type of input and availability of
26-
CUDA-Aware MPI
25+
Dispatch the appropriate allgather routine based on buffer sizes and
26+
CUDA-aware MPI availability.
27+
28+
If all ranks provide buffers of equal size, the standard `Allgather`
29+
collective is used. Otherwise, `Allgatherv` is invoked to handle
30+
variable-sized buffers.
2731
2832
Parameters
2933
----------

0 commit comments

Comments
 (0)