Skip to content
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

CumSum spec revision #6966

Merged
merged 8 commits into from
Aug 20, 2021
Merged

CumSum spec revision #6966

Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
eb2e059
Update detailed description
mitruska Aug 6, 2021
cc40f1b
Update exclusive attribute description
mitruska Aug 6, 2021
b8cbf27
Update Inputs/Outpu description
mitruska Aug 6, 2021
67e80a5
Update types
mitruska Aug 6, 2021
3abb5c1
Merge remote-tracking branch 'upstream/master' into mitruska/cum_sum_…
mitruska Aug 16, 2021
f825b42
Update descriptions
mitruska Aug 16, 2021
f8c2e2e
Update data input rank info
mitruska Aug 16, 2021
b6eb44e
Merge remote-tracking branch 'upstream/master' into mitruska/cum_sum_…
mitruska Aug 16, 2021
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
14 changes: 8 additions & 6 deletions docs/ops/arithmetic/CumSum_3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@

**Short description**: *CumSum* performs cumulative summation of the input elements along the given axis.

**Detailed description**: By default, it will do the sum inclusively meaning the first element is copied as is. Through an "exclusive" attribute, this behavior can change to exclude the first element. It can also perform summation in the opposite direction of the axis. For that, set reverse attribute to `true`.
**Detailed description**: *CumSum* performs cumulative summation of the input elements along the `axis` specified by the second input. By default, the `j-th` output element is the inclusive sum of the first `j` elements in the given sequence, and the first element in the sequence is copied to the output as is.
In the `exclusive` mode the `j-th` output element is the sum of the first `j-1` elements and the first element in the output sequence is `0`.
To perform the summation in the opposite direction of the axis, set reverse attribute to `true`.

**Attributes**:

* *exclusive*

* **Description**: If the attribute is set to `true` then an exclusive sum in which the top element is not included is returned. In other terms, if set to `true`, the `j-th` output element would be the sum of the first `(j-1)` elements. Otherwise, it would be the sum of the first `j` elements.
* **Description**: If the attribute is set to `true`, then exclusive sums are returned, the `j-th` element is not included in the `j-th` sum. Otherwise, the inclusive sum of the first `j` elements for the `j-th` element is calculated.
* **Range of values**:
* `false` - include the top element
* `true` - do not include the top element
Expand All @@ -32,19 +34,19 @@

**Inputs**

* **1**: An tensor of type *T*. **Required.**
* **1**: A tensor of type *T* and arbitrary shape. **Required.**

* **2**: Scalar axis of type *T_AXIS*. Negative value means counting dimensions from the back. Default value is 0. **Optional.**
* **2**: Axis index along which the cumulative sum is performed. A scalar of type *T_AXIS*. Negative value means counting dimensions from the back. Default value is `0`. **Optional.**

**Outputs**

* **1**: Output tensor with cumulative sums of the input's elements. A tensor of type *T* of the same shape as 1st input.
* **1**: Output tensor with cumulative sums of the input elements. A tensor of type *T* of the same shape as the first input.

**Types**

* *T*: any numeric type.

* *T_AXIS*: any integer number.
* *T_AXIS*: `int64` or `int32`.

**Examples**

Expand Down