We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 747aaed commit fca09efCopy full SHA for fca09ef
1 file changed
mkl_umath/src/_patch_numpy.pyx
@@ -328,7 +328,23 @@ def restore():
328
329
330
def is_patched():
331
- """Return True if NumPy umath loops have been patched by mkl_umath."""
+ """
332
+ Return True if NumPy umath loops have been patched by mkl_umath.
333
+
334
+ Examples
335
+ --------
336
+ >>> import mkl_umath
337
+ >>> mkl_umath.is_patched()
338
+ # False
339
340
+ >>> mkl_umath.patch_numpy_umath() # Enable mkl_umath in Numpy
341
342
+ # True
343
344
+ >>> mkl_umath.restore_numpy_umath() # Disable mkl_umath in Numpy
345
346
347
348
return _patch.is_patched()
349
350
0 commit comments