Skip to content

Commit 0429693

Browse files
authored
Fix a typo in the spec (#184)
1 parent 03a2b41 commit 0429693

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

spec/API_specification/linear_algebra_functions.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The `matmul` function must implement the same semantics as the built-in `@` oper
3434

3535
- **x1**: _<array>_
3636

37-
- first input array. Should have a numeric data type. Must have at least one dimension. If `x1` is one-dimensional having shape `(M)` and `x2` has more than one dimension, `x1` must be promoted to a two-dimensional array by prepending `1` to its dimensions (i.e., must have shape `(1, M)`). After matrix multiplication, the prepended dimensions in the returned array must be removed. If `x1` has more than one dimension (including after vector-to-matrix promotion), `x1` must be compatible with `x2` (see {ref}`broadcasting`). If `x1` has shape `(..., M, K)`, the innermost two dimensions form matrices on which to perform matrix multiplication.
37+
- first input array. Should have a numeric data type. Must have at least one dimension. If `x1` is one-dimensional having shape `(M)` and `x2` has more than one dimension, `x1` must be promoted to a two-dimensional array by prepending `1` to its dimensions (i.e., must have shape `(1, M)`). After matrix multiplication, the prepended dimensions in the returned array must be removed. If `x1` has more than one dimension (including after vector-to-matrix promotion), `x1` must be compatible with `x2` (see {ref}`broadcasting`). If `x1` has shape `(..., M, K)`, the innermost two dimensions form matrices on which to perform matrix multiplication.
3838

3939
- **x2**: _<array>_
4040

@@ -58,7 +58,7 @@ The `matmul` function must implement the same semantics as the built-in `@` oper
5858

5959
- if either `x1` or `x2` is a zero-dimensional array.
6060
- if `x1` is a one-dimensional array having shape `(N)`, `x2` is a one-dimensional array having shape `(M)`, and `N != M`.
61-
- if `x1` is an array having shape `(..., M, K)`, `x2` is an array having shape `(..., L, N)`, and `K != L`.
61+
- if `x1` is an array having shape `(..., M, K)`, `x2` is an array having shape `(..., L, N)`, and `K != L`.
6262

6363
(function-tensordot)=
6464
### tensordot(x1, x2, /, *, axes=2)
@@ -78,13 +78,13 @@ Returns a tensor contraction of `x1` and `x2` over specific axes.
7878
- **axes**: _Union\[ int, Tuple\[ Sequence\[ int ], Sequence\[ int ] ] ]_
7979

8080
- number of axes (dimensions) to contract or explicit sequences of axes (dimensions) for `x1` and `x2`, respectively.
81-
81+
8282
If `axes` is an `int` equal to `N`, then contraction must be performed over the last `N` axes of `x1` and the first `N` axes of `x2` in order. The size of each corresponding axis (dimension) must match. Must be nonnegative.
8383

8484
- If `N` equals `0`, the result is the tensor (outer) product.
8585
- If `N` equals `1`, the result is the tensor dot product.
8686
- If `N` equals `2`, the result is the tensor double contraction (default).
87-
87+
8888
If `axes` is a tuple of two sequences `(x1_axes, x2_axes)`, the first sequence must apply to `x` and the second sequence to `x2`. Both sequences must have the same length. Each axis (dimension) `x1_axes[i]` for `x1` must have the same size as the respective axis (dimension) `x2_axes[i]` for `x2`. Each sequence must consist of unique (nonnegative) integers that specify valid axes for each respective array.
8989

9090
#### Returns
@@ -135,7 +135,7 @@ Computes the (vector) dot product of two arrays.
135135

136136
#### Returns
137137

138-
- **out**: _<array;>_
138+
- **out**: _<array>_
139139

140140
- if `x1` and `x2` are both one-dimensional arrays, a zero-dimensional containing the dot product; otherwise, a non-zero-dimensional array containing the dot products and having rank `N-1`, where `N` is the rank (number of dimensions) of the shape determined according to {ref}`broadcasting`. The returned array must have a data type determined by {ref}`type-promotion`.
141141

0 commit comments

Comments
 (0)