Skip to content

docs: document axis and keepdims for Tensor.sum and Tensor.mean #83

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
Terminay merged 1 commit into from
Oct 26, 2026
Merged

docs: document axis and keepdims for Tensor.sum and Tensor.mean #83

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
18 changes: 16 additions & 2 deletions docs/api-reference/tensor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,24 @@ Returns a new Tensor: `ln(x)` element-wise (natural logarithm).
Note: `log(0)` returns `-inf`, `log(negative)` returns `nan`.

### `sum(axis=None, keepdims=False)`
Returns a new Tensor with the sum of all elements (full reduction, not per-axis).
Returns a new Tensor with the sum of the elements, reduced over all elements or over the given axis.

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `axis` | int, tuple of int, or None | `None` | Axis or axes to reduce. Negative axes are allowed. `None` reduces over all elements and returns a scalar (0-d) Tensor |
| `keepdims` | bool | `False` | If `True`, the reduced axes are kept with size 1 so the result broadcasts against the input |

For an input of shape `(2, 3)`: `.sum()` has shape `()`, `.sum(axis=0)` has shape `(3,)`, `.sum(axis=1, keepdims=True)` has shape `(2, 1)`.

### `mean(axis=None, keepdims=False)`
Returns a new Tensor with the mean of all elements (full reduction, not per-axis).
Returns a new Tensor with the mean of the elements, reduced over all elements or over the given axis.

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `axis` | int, tuple of int, or None | `None` | Axis or axes to reduce. Negative axes are allowed. `None` reduces over all elements and returns a scalar (0-d) Tensor |
| `keepdims` | bool | `False` | If `True`, the reduced axes are kept with size 1 so the result broadcasts against the input |

For an input of shape `(2, 3)`: `.mean()` has shape `()`, `.mean(axis=0)` has shape `(3,)`, `.mean(axis=1, keepdims=True)` has shape `(2, 1)`.

### `matmul(other)`
Matrix multiplication equivalent to `self @ other`.
Expand Down