1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
.. _array_api_support_signal:
Array API Standard Support: ``signal``
======================================
This page explains some caveats of the `~scipy.signal` module and provides (currently
incomplete) tables about the
:ref:`CPU <array_api_support_signal_cpu>`,
:ref:`GPU <array_api_support_signal_gpu>` and
:ref:`JIT <array_api_support_signal_jit>` support.
.. _array_api_support_signal_caveats:
Caveats
-------
`JAX <https://docs.jax.dev/en/latest/jax.scipy.html>`__ and `CuPy
<https://docs.cupy.dev/en/stable/reference/scipy_signal.html>`__ provide alternative
implementations for some `~scipy.signal` functions. When such a function is called, a
decorator decides which implementation to use by inspecting the `xp` parameter.
Hence, there can be, especially during CI testing, discrepancies in behavior between
the default NumPy-based implementation and the JAX and CuPy backends. Skipping the
incompatible backends in unit tests, as described in the
:ref:`dev-arrayapi_adding_tests` section, is the currently recommended workaround.
The functions are decorated by the code in file
``scipy/signal/_support_alternative_backends.py``:
.. literalinclude:: ../../../../../scipy/signal/_support_alternative_backends.py
:lineno-match:
Note that a function will only be decorated if the environment variable
``SCIPY_ARRAY_API`` is set and its signature is listed in the file
``scipy/signal/_delegators.py``. E.g., for `~scipy.signal.firwin`, the signature
function looks like this:
.. literalinclude:: ../../../../../scipy/signal/_delegators.py
:pyobject: firwin_signature
:lineno-match:
.. _array_api_support_signal_cpu:
Support on CPU
--------------
.. array-api-support-per-function::
:module: signal
:backend_type: cpu
.. _array_api_support_signal_gpu:
Support on GPU
--------------
.. array-api-support-per-function::
:module: signal
:backend_type: gpu
.. _array_api_support_signal_jit:
Support with JIT
----------------
.. array-api-support-per-function::
:module: signal
:backend_type: jit
|
