Skip to content

Add a note for description of axis in accumulation functions #1631

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.

Sign up for GitHub

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
Apr 3, 2024
Merged

Add a note for description of axis in accumulation functions #1631

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions dpctl/tensor/_accumulation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,9 @@ def cumulative_sum(
axis (Optional[int, Tuple[int, ...]]):
axis along which cumulative sum must be computed.
If `None`, the sum is computed over the entire array.
If `x` is a one-dimensional array, providing an `axis` is optional;
however, if `x` has more than one dimension, providing an `axis`
is required.
Default: `None`.
dtype (Optional[dtype]):
data type of the returned array. If `None`, the default data
Expand Down Expand Up @@ -342,6 +345,9 @@ def cumulative_prod(
axis (Optional[int, Tuple[int, ...]]):
axis along which cumulative product must be computed.
If `None`, the product is computed over the entire array.
If `x` is a one-dimensional array, providing an `axis` is optional;
however, if `x` has more than one dimension, providing an `axis`
is required.
Default: `None`.
dtype (Optional[dtype]):
data type of the returned array. If `None`, the default data
Expand Down Expand Up @@ -414,6 +420,9 @@ def cumulative_logsumexp(
axis (Optional[int, Tuple[int, ...]]):
axis along which cumulative logsumexp must be computed.
If `None`, the logsumexp is computed over the entire array.
If `x` is a one-dimensional array, providing an `axis` is optional;
however, if `x` has more than one dimension, providing an `axis`
is required.
Default: `None`.
dtype (Optional[dtype]):
data type of the returned array. If `None`, the default data
Expand Down