Skip to content

Commit 2de077f

Browse files
Fix 'mode' and 'method' options list for convolve in docs
1 parent 5e5f852 commit 2de077f

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

dpnp/dpnp_iface_statistics.py

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -397,29 +397,23 @@ def convolve(a, v, mode="full", method="auto"):
397397
Second 1-D array. The length of `v` must be less than or equal to
398398
the length of `a`.
399399
mode : {'full', 'valid', 'same'}, optional
400-
'full':
401-
By default, mode is 'full'. This returns the convolution
400+
- 'full': By default, mode is 'full'. This returns the convolution
402401
at each point of overlap, with an output shape of (N+M-1,). At
403402
the end-points of the convolution, the signals do not overlap
404403
completely, and boundary effects may be seen.
405-
'same':
406-
Mode 'same' returns output of length ``max(M, N)``. Boundary
404+
- 'same': Mode 'same' returns output of length ``max(M, N)``. Boundary
407405
effects are still visible.
408-
'valid':
409-
Mode 'valid' returns output of length
406+
- 'valid': Mode 'valid' returns output of length
410407
``max(M, N) - min(M, N) + 1``. The convolution product is only given
411408
for points where the signals overlap completely. Values outside
412409
the signal boundary have no effect.
413410
414411
Default: ``'full'``.
415412
method : {'auto', 'direct', 'fft'}, optional
416-
'direct':
417-
The convolution is determined directly from sums.
418-
'fft':
419-
The Fourier Transform is used to perform the calculations.
413+
- 'direct': The convolution is determined directly from sums.
414+
- 'fft': The Fourier Transform is used to perform the calculations.
420415
This method is faster for long sequences but can have accuracy issues.
421-
'auto':
422-
Automatically chooses direct or Fourier method based on
416+
- 'auto': Automatically chooses direct or Fourier method based on
423417
an estimate of which is faster.
424418
425419
Note: Use of the FFT convolution on input containing NAN or INF

0 commit comments

Comments
 (0)