summaryrefslogtreecommitdiff
path: root/doc/source/user
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2020-06-11 13:49:34 -0600
committerGitHub <noreply@github.com>2020-06-11 13:49:34 -0600
commitf1206ddb24d35781328266b2b02fa27e6fbb9846 (patch)
treec8dbbaef0dfc43e23f5197ce379fa2aa1d0b984e /doc/source/user
parent19bc8bbe37044b9f23d80bb282758071d0d8bf15 (diff)
parent12c0b0eac8ba4216011634bcec53aad41d129e70 (diff)
downloadnumpy-f1206ddb24d35781328266b2b02fa27e6fbb9846.tar.gz
Merge pull request #16452 from mattip/accelerate-error
DOC,ENH: extend error message when Accelerate is detected
Diffstat (limited to 'doc/source/user')
-rw-r--r--doc/source/user/building.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/user/building.rst b/doc/source/user/building.rst
index 47a0a03c9..6a880b59e 100644
--- a/doc/source/user/building.rst
+++ b/doc/source/user/building.rst
@@ -6,6 +6,10 @@ Building from source
A general overview of building NumPy from source is given here, with detailed
instructions for specific platforms given separately.
+..
+ This page is referenced from numpy/numpy/__init__.py. Please keep its
+ location in sync with the link there.
+
Prerequisites
-------------
@@ -159,6 +163,14 @@ will prefer to use ATLAS, then OpenBLAS and as a last resort MKL.
If neither of these exists the build will fail (names are compared
lower case).
+.. deprecated:: 1.20
+ The native libraries on macOS, provided by Accelerate, are not fit for use
+ in NumPy since they have bugs that cause wrong output under easily reproducible
+ conditions. If the vendor fixes those bugs, the library could be reinstated,
+ but until then users compiling for themselves should use another linear
+ algebra library or use the built-in (but slower) default, see the next
+ section.
+
Disabling ATLAS and other accelerated libraries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~