Skip to content

chore: update README for patch method #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndgrigorian merged 1 commit into from
May 27, 2026
Merged

chore: update README for patch method #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,31 @@ Where `<numpy_version>` should be the latest version from https://software.repos

---

# Patching Mechanisms

`mkl_umath` provides a convenient programmatic patch method to enable MKL-accelerated umath operations in NumPy.

## Programmatic Quickstart

```python
import mkl_umath
import numpy

mkl_umath.patch_numpy_umath()
print(mkl_umath.is_patched())
# run your accelerated numpy workloads here!
mkl_umath.restore_numpy_umath()
```

```python
import mkl_umath
import numpy
with mkl_umath.mkl_umath():
# run your accelerated workloads here!
pass
```
---

## Building

Intel(R) C compiler and Intel(R) OneAPI Math Kernel Library (OneMKL) are required to build `mkl_umath` from source.
Expand Down
Loading