Skip to content

Commit 909e943

Browse files
authored
Update README.md for BLAS forwarding
1 parent e5e4631 commit 909e943

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
This provides a Julia interface to some of the
44
[macOS Accelerate framework](https://developer.apple.com/documentation/accelerate). At
5-
the moment, the package consists mostly of an interface to the
6-
[array-oriented functions](https://developer.apple.com/library/mac/documentation/Performance/Conceptual/vecLib/index.html#//apple_ref/doc/uid/TP30000414-357225),
7-
which provide a vectorised form of many common mathematical functions, however the package does provide access to several other vectorized operations and more are being added on a regular basis. In
8-
general, the performance is significantly better than using standard libm
9-
functions, though there does appear to be some reduced accuracy.
5+
the moment, this package provides:
6+
1. Access to Accelerate BLAS and LAPACK using the [libblastrampoline](https://github.com/JuliaLinearAlgebra/libblastrampoline) framework,
7+
2. An interface to the [array-oriented functions](https://developer.apple.com/library/mac/documentation/Performance/Conceptual/vecLib/index.html#//apple_ref/doc/uid/TP30000414-357225),
8+
which provide a vectorised form for many common mathematical functions
9+
10+
The performance is significantly better than using standard libm functions in some cases, though there does appear to be some reduced accuracy.
1011

1112
## OS Requirements
1213

13-
MacOS 13.3 is required in order to run AppleAccelerate.jl. On older MacOS versions, your mileage may vary.
14+
MacOS 13.3 is required in order to run AppleAccelerate.jl, especially for the libblastrampoline forwarding. On older MacOS versions, your mileage may vary.
1415

1516
## Supported Functions
1617

@@ -37,6 +38,17 @@ Some additional functions that are also available:
3738

3839
## Example
3940

41+
To use the Accelerate BLAS and LAPACK, simply load the library:
42+
```julia
43+
julia> peakflops(4096)
44+
3.6024175318268243e11
45+
46+
julia> using AppleAccelerate
47+
48+
julia> peakflops(4096)
49+
5.832806459434183e11
50+
```
51+
4052
To avoid naming conflicts with Base, methods are not exported and so need to
4153
be accessed via the namespace:
4254
```julia

0 commit comments

Comments
 (0)