Skip to content

Commit

Permalink
add link to new guide
Browse files Browse the repository at this point in the history
  • Loading branch information
david-cortes committed Mar 28, 2023
1 parent e3463e4 commit 22762c1
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ The new version is faster, multi-threaded, and has some new functionality, but i

* Python:

**Note:** requires a C compiler configured for Python. See [this guide](https://github.com/david-cortes/installing-optimized-libraries) for instructions.

```
pip install cmfrec
```
Expand Down Expand Up @@ -153,6 +155,8 @@ pip install cmfrec

* R:

**Note:** This package greatly benefits from extra optimizations that aren't enabled by default for R packages. See [this guide](https://github.com/david-cortes/installing-optimized-libraries) for instructions on how to enable them.

```r
install.packages("cmfrec")
```
Expand Down Expand Up @@ -187,7 +191,7 @@ Be aware that the snippet above includes option `-DUSE_MARCH_NATIVE=1`, which wi

## Performance tips

This package relies heavily on BLAS and LAPACK functions for calculations. It's recommended to use with MKL, OpenBLAS, or BLIS. Additionally, if using it from R, the package will benefit from enabling optimizations which are not CRAN-compliant (see below).
This package relies heavily on BLAS and LAPACK functions for calculations. It's recommended to use with MKL, OpenBLAS, or BLIS. Additionally, if using it from R, the package will benefit from enabling optimizations which are not CRAN-compliant (see [this guide](https://github.com/david-cortes/installing-optimized-libraries) for detailed instructions).

Different backends for BLAS can make a large difference in speed - for example, on an AMD Ryzen 2700, MKL2021 makes models take 4x longer to fit than MKL2020, and using OpenBLAS-pthreads takes around 1.3x longer to fit models compared to OpenBLAS-openmp.

Expand Down

0 comments on commit 22762c1

Please sign in to comment.