Skip to content

Commit c2c4072

Browse files
committed
Resolves gh-1634
Corrects docstrings in `_accumulation.py` by adding documentation for `out` keyword to `cumulative_*` functions
1 parent 93ce113 commit c2c4072

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

dpctl/tensor/_accumulation.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,11 @@ def cumulative_sum(
261261
boolean indicating whether to include the initial value (i.e., the
262262
additive identity, zero) as the first value along the provided axis
263263
in the output. Default: `False`.
264+
out (Optional[usm_ndarray]):
265+
the array into which the result is written.
266+
The data type of `out` must match the expected shape and the
267+
expected data type of the result or (if provided) `dtype`.
268+
If `None` then a new array is returned. Default: `None`.
264269
265270
Returns:
266271
usm_ndarray:
@@ -335,6 +340,11 @@ def cumulative_prod(
335340
boolean indicating whether to include the initial value (i.e., the
336341
additive identity, zero) as the first value along the provided
337342
axis in the output. Default: `False`.
343+
out (Optional[usm_ndarray]):
344+
the array into which the result is written.
345+
The data type of `out` must match the expected shape and the
346+
expected data type of the result or (if provided) `dtype`.
347+
If `None` then a new array is returned. Default: `None`.
338348
339349
Returns:
340350
usm_ndarray:
@@ -410,6 +420,11 @@ def cumulative_logsumexp(
410420
boolean indicating whether to include the initial value (i.e., the
411421
additive identity, zero) as the first value along the provided axis
412422
in the output. Default: `False`.
423+
out (Optional[usm_ndarray]):
424+
the array into which the result is written.
425+
The data type of `out` must match the expected shape and the
426+
expected data type of the result or (if provided) `dtype`.
427+
If `None` then a new array is returned. Default: `None`.
413428
414429
Returns:
415430
usm_ndarray:

0 commit comments

Comments
 (0)