Skip to main content
`Ctrl`+`K`
scipy.fft.

# set_backend

scipy.fft.set_backend(backend, coerce=False, only=False)

  Context manager to set the backend within a fixed scope.

  Upon entering the `with` statement, the given backend will be added to the list of available backends with the highest priority. Upon exit, the backend is reset to the state before entering the scope.

  Parameters:
    backend{object, ‘scipy’}

      The backend to use. Can either be a `str` containing the name of a known backend {‘scipy’} or an object that implements the uarray protocol.

    coerce bool, optional

      Whether to allow expensive conversions for the `x` parameter. e.g., copying a NumPy array to the GPU for a CuPy backend. Implies `only`.

    only bool, optional

      If only is `True` and this backend returns `NotImplemented`, then a BackendNotImplemented error will be raised immediately. Ignoring any lower priority backends.

  Returns:
    context uarray._SetBackendContext

      Context manager that sets the backend.

  Notes

  Array API Standard Support

  `set_backend` is not in-scope for support of Python Array API Standard compatible backends other than NumPy.

  See Support for the array API standard for more information.

  Examples

      >>> import scipy.fft as fft
      >>> with fft.set_backend('scipy', only=True):
      ...     fft.fft([1])  # Always calls the scipy implementation
      array([1.+0.j])