Skip to content

Commit f6e8f70

Browse files
committed
use oneMKL instead OneMKL
1 parent 7b64b0a commit f6e8f70

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
## `mkl_fft` -- a NumPy-based Python interface to Intel® oneAPI Math Kernel Library (OneMKL) FFT functionality
21
[![Conda package](https://github.com/IntelPython/mkl_fft/actions/workflows/conda-package.yml/badge.svg)](https://github.com/IntelPython/mkl_fft/actions/workflows/conda-package.yml)
32
[![Editable build using pip and pre-release NumPy](https://github.com/IntelPython/mkl_fft/actions/workflows/build_pip.yaml/badge.svg)](https://github.com/IntelPython/mkl_fft/actions/workflows/build_pip.yaml)
43
[![Conda package with conda-forge channel only](https://github.com/IntelPython/mkl_fft/actions/workflows/conda-package-cf.yml/badge.svg)](https://github.com/IntelPython/mkl_fft/actions/workflows/conda-package-cf.yml)
54
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/IntelPython/mkl_fft/badge)](https://securityscorecards.dev/viewer/?uri=github.com/IntelPython/mkl_fft)
65

6+
## `mkl_fft` -- a NumPy-based Python interface to Intel® oneAPI Math Kernel Library (oneMKL) Fourier Transform Functions
7+
78
# Introduction
8-
`mkl_fft` started as a part of Intel® Distribution for Python* optimizations to NumPy, and is now being released
9-
as a stand-alone package. It offers a thin layered interface for the Intel® oneAPI Math Kernel Library (OneMKL) FFT functionality that allows efficient access to native FFT optimizations from a range of NumPy and SciPy functions. As a result, its performance is close to the performance of native C/Intel® OneMKL. The optimizations are provided for real and complex data types in both single and double precisions for in-place and out-of-place modes of operation. For analyzing the performance use [FFT benchmarks](https://github.com/intelpython/fft_benchmark).
9+
`mkl_fft` started as a part of [Intel® Distribution for Python*](https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html) optimizations to NumPy, and is now being released as a stand-alone package. It offers a thin layered pythonic interface for the [Intel® oneAPI Math Kernel Library (oneMKL) Fourier Transform Functions](https://www.intel.com/content/www/us/en/docs/onemkl/developer-reference-c/2025-2/fourier-transform-functions.html) that allows efficient access to computing a discrete Fourier transform through the fast Fourier transform (FFT) algorithm. As a result, its performance is close to the performance of native C/Intel® oneMKL. The optimizations are provided for real and complex data types in both single and double precisions for in-place and out-of-place modes of operation. For analyzing the performance use [FFT benchmarks](https://github.com/intelpython/fft_benchmark).
1010

11-
Thanks to Intel® OneMKL’s flexibility in its supports for arbitrarily strided input and output arrays both one-dimensional and multi-dimensional Fast Fourier Transforms along distinct axes can be performed directly, without the need to copy the input into a contiguous array first. Furthermore, input strides can be arbitrary, including negative or zero, as long as strides remain an integer multiple of array’s item size, otherwise a copy will be made.
11+
Thanks to Intel® oneMKL’s flexibility in its supports for arbitrarily strided input and output arrays both one-dimensional and multi-dimensional FFTs along distinct axes can be performed directly, without the need to copy the input into a contiguous array first. Furthermore, input strides can be arbitrary, including negative or zero, as long as strides remain an integer multiple of array’s item size, otherwise a copy will be made.
1212

1313
More details can be found in ["Accelerating Scientific Python with Intel Optimizations"](https://proceedings.scipy.org/articles/shinma-7f4c6e7-00f) from Proceedings of the 16th Python in Science Conference (SciPy 2017).
1414

@@ -26,8 +26,6 @@ or from conda-forge channel:
2626
conda install -c conda-forge mkl_fft
2727
```
2828

29-
---
30-
3129
To install `mkl_fft` PyPI package please use following command:
3230

3331
```
@@ -40,7 +38,7 @@ If command above installs NumPy package from the PyPI, please use following comm
4038
python -m pip install --index-url https://software.repos.intel.com/python/pypi --extra-index-url https://pypi.org/simple mkl_fft numpy==<numpy_version>
4139
```
4240

43-
Where `<numpy_version>` should be the latest version from https://software.repos.intel.com/python/conda/
41+
where `<numpy_version>` should be the latest version from https://software.repos.intel.com/python/conda/.
4442

4543
---
4644
# How to use?
@@ -85,10 +83,10 @@ numpy.allclose(mkl_res, np_res)
8583
---
8684
# Building from source
8785

88-
To build `mkl_fft` from sources on Linux with Intel® OneMKL:
86+
To build `mkl_fft` from sources on Linux with Intel® oneMKL:
8987
- create a virtual environment: `python3 -m venv fft_env`
9088
- activate the environment: `source fft_env/bin/activate`
91-
- install a recent version of OneMKL, if necessary
89+
- install a recent version of oneMKL, if necessary
9290
- execute `source /path_to_oneapi/mkl/latest/env/vars.sh`
9391
- `git clone https://github.com/IntelPython/mkl_fft.git mkl_fft`
9492
- `cd mkl_fft`

mkl_fft/interfaces/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ print(f"Time with scipy.fft default backend: {t1:.1f} seconds")
101101
with scipy.fft.set_backend(mkl_backend, only=True):
102102
t2 = timeit.timeit(lambda: scipy.signal.fftconvolve(a, b), number=10)
103103

104-
print(f"Time with OneMKL FFT backend installed: {t2:.1f} seconds")
104+
print(f"Time with oneMKL FFT backend installed: {t2:.1f} seconds")
105105
# Time with MKL FFT backend installed: 9.1 seconds
106106
```
107107

0 commit comments

Comments
 (0)