Skip to content

Commit 77aa65e

Browse files
committed
Updates tensordot and vecdot docstrings to reflect changes
1 parent a482d79 commit 77aa65e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

dpctl/tensor/_linear_algebra_functions.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,9 @@ def tensordot(x1, x2, axes=2):
9090
to `x2`. Both sequences must have equal length, and each axis
9191
`x1_axes[i]` for `x1` must have the same size as the respective
9292
axis `x2_axes[i]` for `x2`. Each sequence must consist of unique
93-
non-negative integers that specify valid axes for each respective
94-
array.
93+
integers that specify valid axes for each respective array.
94+
For example, if `x1` has rank `N`, a valid axis must reside on the
95+
half-open interval `[-N, N)`.
9596
Returns:
9697
usm_ndarray:
9798
an array containing the tensor contraction whose shape consists of
@@ -310,12 +311,11 @@ def vecdot(x1, x2, axis=-1):
310311
axis. Input arrays should be of numeric type.
311312
axis (Optional[int]):
312313
axis over which to compute the dot product. The axis must
313-
be an integer on the interval `[-N, N)`, where `N` is the
314-
array rank of input arrays after broadcasting rules are
315-
applied. If specified as a negative integer, the axis along
316-
which dot product is performed is counted backward from
317-
the last axes (that is `-1` refers to the last axis). By
318-
default, dot product is computed over the last axis.
314+
be an integer on the interval `[-N, -1]`, where `N` is
315+
``min(x1.ndim, x2.ndim)``. The axis along which dot product
316+
is performed is counted backward from the last axes
317+
(that is, `-1` refers to the last axis). By default,
318+
dot product is computed over the last axis.
319319
Default: `-1`.
320320
321321
Returns:

0 commit comments

Comments
 (0)