You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/elements/oneCCL/source/spec/collective_operations.rst
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,13 @@ If the arguments provided to a communication operation call do not comply to the
44
44
Allgatherv
45
45
**********
46
46
47
-
Allgatherv is a collective communication operation that collects data from all the ranks within a communicator into a single buffer. Different ranks may contribute segments of different sizes. The resulting data in the output buffer must be the same for each rank.
47
+
Allgatherv is a collective communication operation that collects data from all
48
+
the ranks within a communicator into a single buffer. Different ranks may
49
+
contribute segments of different sizes. The resulting data in the output buffer
50
+
must be the same for each rank.
51
+
52
+
Allgatherv is in place when ``send_buf == recv_buf + rank_offset``, where
53
+
``rank_offset = sum (recv_counts[i])``, for all ``i < rank``.
48
54
49
55
.. code:: cpp
50
56
@@ -100,7 +106,11 @@ return ``event``
100
106
Allreduce
101
107
*********
102
108
103
-
Allreduce is a collective communication operation that performs the global reduction operation on values from all ranks of communicator and distributes the result back to all ranks.
109
+
Allreduce is a collective communication operation that performs the global
110
+
reduction operation on values from all ranks of communicator and distributes
111
+
the result back to all ranks.
112
+
113
+
Allreduce is in-place when ``send_buf == recv_buf``.
104
114
105
115
.. code:: cpp
106
116
@@ -291,8 +301,11 @@ return ``event``
291
301
Reduce
292
302
******
293
303
294
-
Reduce is a collective communication operation that performs the global reduction operation
295
-
on values from all ranks of the communicator and returns the result to the root rank.
304
+
Reduce is a collective communication operation that performs the global
305
+
reduction operation on values from all ranks of the communicator and returns
306
+
the result to the root rank.
307
+
308
+
Reduce is in-place when ``send_buf == recv_buf``.
296
309
297
310
.. code:: cpp
298
311
@@ -350,8 +363,11 @@ return ``event``
350
363
ReduceScatter
351
364
**************
352
365
353
-
Reduce-scatter is a collective communication operation that performs the global reduction operation
354
-
on values from all ranks of the communicator and scatters the result in blocks back to all ranks.
366
+
Reduce-scatter is a collective communication operation that performs the global
367
+
reduction operation on values from all ranks of the communicator and scatters
368
+
the result in blocks back to all ranks.
369
+
370
+
ReduceScatter is in-place when ``recv_buf == send_buf + rank * recv_count``
0 commit comments