add manual NumPy patching to `mkl_fft` by ndgrigorian · Pull Request #224 · IntelPython/mkl_fft

ndgrigorian · 2025-09-10T07:29:27Z

this PR proposes implementing manual patching for NumPy a la mkl_umath to mkl_fft

this patching is specifically designed with NEP-36 in mind

Copilot

Pull request overview

This PR introduces manual NumPy patching functionality to mkl_fft, following NEP-36 fair play guidelines. It allows users to dynamically replace NumPy's FFT functions with mkl_fft's optimized implementations at runtime, similar to the approach used in mkl_umath.

Changes:

Added _patch_numpy.py module with patching/restoration functions and a context manager
Added test file test_patch.py to verify basic patch/restore functionality
Exported new public API functions: patch_numpy_fft(), restore_numpy_fft(), is_patched(), and mkl_fft context manager

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.

File	Description
mkl_fft/_patch_numpy.py	Implements the patching mechanism using thread-local storage to track state, provides functions to patch/restore numpy.fft functions, and includes a context manager for temporary patching
mkl_fft/tests/test_patch.py	Basic test verifying patch and restore functionality by checking module names
mkl_fft/init.py	Exports the new patching API functions and context manager class

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mkl_fft/__init__.py

mkl_fft/_patch_numpy.py

mkl_fft/tests/test_patch.py

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mkl_fft/_patch_numpy.py

mkl_fft/tests/test_patch.py

mkl_fft/_patch_numpy.py

jharlow-intel · 2026-03-02T14:57:34Z

@ndgrigorian ping here, bot has some good points about idempotency of the patch function and some test cases

ndgrigorian · 2026-03-03T00:04:06Z

@ndgrigorian ping here, bot has some good points about idempotency of the patch function and some test cases

yep, I agree, and same goes for in umath

ndgrigorian · 2026-03-03T10:05:28Z

@antonwolfy @jharlow-intel
I've updated this PR with a reimplementation of patching. We use a singleton class now, with locks, to prevent races, and we have an explicit counter for patches as well as thread-local patch counter. The double bookkeeping prevents edge cases where one thread never calls patch, but calls unpatch, or calls unpatch twice. Just an extra guardrail.

This whole thing is a little hacky, so I added a note saying to prefer the context manager in general.

mkl_fft/_patch_numpy.py

jharlow-intel

Left a few comments on non-important stuff but this PR looks good to me

antonwolfy

LGTM! The only comment from me is that it'd be great to update the changelog.

ndgrigorian · 2026-03-04T01:16:18Z

@jharlow-intel @antonwolfy
added to changelog and pulled out dead contextdecorator code in the patch object (I initially almost made the patch the context decorator and made it parent to mkl_fft manager, but decided against it)

should be ready

* improve thread-safety of patching * gate repeated patch calls there still exist problematic edge cases (race condition where one thread restores while another is using patched functions)

leftover from idea to use GlobalPatch as parent to mkl_fft context manager

also use from mkl_fft import interfaces to avoid redundant mkl_fft module in namespace

antonwolfy

LGTM! Thank you @ndgrigorian

ndgrigorian changed the title ~~add manual patching to mkl_fft~~ add manual NumPy patching to mkl_fft Sep 10, 2025

ndgrigorian force-pushed the add-mkl-fft-patching branch 3 times, most recently from b2ebfdc to d22ae8e Compare September 10, 2025 16:17

ndgrigorian force-pushed the add-mkl-fft-patching branch from c8fe204 to 559373e Compare September 22, 2025 19:14

ndgrigorian force-pushed the add-mkl-fft-patching branch from 559373e to e4c64d4 Compare October 9, 2025 18:32

ndgrigorian marked this pull request as ready for review February 20, 2026 06:35

ndgrigorian requested a review from antonwolfy as a code owner February 20, 2026 06:35

Copilot AI review requested due to automatic review settings February 20, 2026 06:35

ndgrigorian requested review from jharlow-intel and xaleryb as code owners February 20, 2026 06:35

Copilot started reviewing on behalf of ndgrigorian February 20, 2026 06:36 View session

ndgrigorian force-pushed the add-mkl-fft-patching branch from 4eb05ce to b5a4b19 Compare February 20, 2026 06:39

Copilot AI reviewed Feb 20, 2026

View reviewed changes

ndgrigorian force-pushed the add-mkl-fft-patching branch 5 times, most recently from 51ba5d3 to 83496b2 Compare February 20, 2026 09:09

ndgrigorian requested a review from Copilot February 27, 2026 10:21

Copilot started reviewing on behalf of ndgrigorian February 27, 2026 10:21 View session

Copilot AI reviewed Feb 27, 2026

View reviewed changes

mkl_fft/_patch_numpy.py Outdated Show resolved Hide resolved

mkl_fft/tests/test_patch.py Show resolved Hide resolved

mkl_fft/_patch_numpy.py Show resolved Hide resolved

mkl_fft/_patch_numpy.py Outdated Show resolved Hide resolved

antonwolfy added this to the 2.2.0 release milestone Mar 3, 2026

jharlow-intel reviewed Mar 3, 2026

View reviewed changes

mkl_fft/_patch_numpy.py Outdated Show resolved Hide resolved

jharlow-intel reviewed Mar 3, 2026

View reviewed changes

mkl_fft/_patch_numpy.py Show resolved Hide resolved

jharlow-intel approved these changes Mar 3, 2026

View reviewed changes

antonwolfy approved these changes Mar 3, 2026

View reviewed changes

ndgrigorian requested review from antonwolfy and jharlow-intel March 4, 2026 01:15

ndgrigorian force-pushed the add-mkl-fft-patching branch from f1604dd to ac6eca8 Compare March 4, 2026 01:31

ndgrigorian added 8 commits March 4, 2026 13:22

add manual patching to mkl_fft

42485a7

add test for NumPy patching function

db76eb2

fix patching test

efbd93b

address feedback about patching

23edc89

* improve thread-safety of patching * gate repeated patch calls there still exist problematic edge cases (race condition where one thread restores while another is using patched functions)

use thread-local storage for bookkeeping patch calls per thread

14d3705

drop ContextDecorator as a parent to GlobalPatch

f9ec9cd

leftover from idea to use GlobalPatch as parent to mkl_fft context manager

add patching to changelog

25a8f49

remove unnecessary shebangs

9771697

ndgrigorian force-pushed the add-mkl-fft-patching branch from acb0658 to c5931a9 Compare March 4, 2026 21:27

add test for reentrant behavior with mkl_fft context manager

a162685

also use from mkl_fft import interfaces to avoid redundant mkl_fft module in namespace

ndgrigorian force-pushed the add-mkl-fft-patching branch from c5931a9 to a162685 Compare March 4, 2026 21:30

antonwolfy approved these changes Mar 4, 2026

View reviewed changes

ndgrigorian merged commit e18fcc9 into master Mar 4, 2026
100 of 109 checks passed

ndgrigorian deleted the add-mkl-fft-patching branch March 4, 2026 22:10

Conversation

ndgrigorian commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jharlow-intel commented Mar 2, 2026

Uh oh!

ndgrigorian commented Mar 3, 2026

Uh oh!

ndgrigorian commented Mar 3, 2026

Uh oh!

Uh oh!

Uh oh!

jharlow-intel left a comment

Choose a reason for hiding this comment

Uh oh!

antonwolfy left a comment

Choose a reason for hiding this comment

Uh oh!

ndgrigorian commented Mar 4, 2026

Uh oh!

antonwolfy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ndgrigorian commented Sep 10, 2025 •

edited

Loading