Skip to content

Commit 2f8a63f

Browse files
committed
Update docstring
1 parent d8e9630 commit 2f8a63f

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

pylops_mpi/utils/_mpi.py

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

0 commit comments

Comments
 (0)