Skip to content

Commit 3ac66e1

Browse files
committed
Update README about features
1 parent eae4af5 commit 3ac66e1

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# intel-mkl-src
22

3-
|crate | crate.io | description |
4-
|:-----|:---------|:------------|
5-
|intel-mkl-src| [![Crate](http://meritbadge.herokuapp.com/intel-mkl-src)](https://crates.io/crates/intel-mkl-src)| Source crate for Intel-MKL |
6-
|intel-mkl-sys| [![Crate](http://meritbadge.herokuapp.com/intel-mkl-sys)](https://crates.io/crates/intel-mkl-sys)| FFI for Intel-MKL [vector math][VM], and [statistical functions][VSL] |
7-
|intel-mkl-tool| [![Crate](http://meritbadge.herokuapp.com/intel-mkl-tool)](https://crates.io/crates/intel-mkl-tool)| CLI utility for redistributing Intel-MKL |
3+
|crate | crate.io | description |
4+
|:-------------|:---------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------|
5+
|intel-mkl-src | [![Crate](http://meritbadge.herokuapp.com/intel-mkl-src)](https://crates.io/crates/intel-mkl-src) | Source crate for Intel-MKL |
6+
|intel-mkl-sys | [![Crate](http://meritbadge.herokuapp.com/intel-mkl-sys)](https://crates.io/crates/intel-mkl-sys) | FFI for Intel-MKL [vector math][VM], and [statistical functions][VSL] |
7+
|intel-mkl-tool| [![Crate](http://meritbadge.herokuapp.com/intel-mkl-tool)](https://crates.io/crates/intel-mkl-tool)| CLI utility for redistributing Intel-MKL |
88

99
Redistribution of Intel MKL as a crate. Tested on Linux, macOS, and Windows (since 0.4.0)
1010

@@ -13,6 +13,12 @@ Redistribution of Intel MKL as a crate. Tested on Linux, macOS, and Windows (sin
1313

1414
## Supported features
1515

16+
- `mkl-*-*-*` features specify which MKL to be linked
17+
- `static` means MKL will be linked statically, and `dynamic` means MKL will be linked dynamically
18+
- `lp64` means 32-bit integer interface, `ilp64` means 64-bit integer interface
19+
- `iomp` means MKL uses Intel OpenMP, `seq` means sequential execution, e.g. no parallelization
20+
- default is `mkl-static-ilp64-seq`, and you must choose one of them.
21+
1622
| feature name | Linux | macOS | Windows |
1723
|:-----------------------|:------------------:|:------------------:|:------------------:|
1824
| mkl-static-lp64-iomp | :heavy_check_mark: | - | - |
@@ -24,6 +30,8 @@ Redistribution of Intel MKL as a crate. Tested on Linux, macOS, and Windows (sin
2430
| mkl-dynamic-ilp64-iomp | :heavy_check_mark: | :heavy_check_mark: | - |
2531
| mkl-dynamic-ilp64-seq | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
2632

33+
- `download` feature enables downloading MKL archive managed by this project from AWS S3 (default ON)
34+
2735
## Usage
2836

2937
This crate is a `*-src` crate. This downloads and link Intel MKL, but does not introduce any symbols.
@@ -51,7 +59,7 @@ This crate seeks system MKL libraries, e.g. installed by [apt], [yum], or offici
5159
- `/opt/intel/mkl` for Linux
5260
- `C:/Program Files (x86)/IntelSWTools/compilers_and_libraries/windows` for Windows
5361
54-
If not found any MKL library, this crate will download archive from AWS S3 `rust-intel-mkl` bucket.
62+
If not found any MKL library and `download` feature is ON, this crate will download archive from AWS S3 `rust-intel-mkl` bucket.
5563
5664
[apt]: https://software.intel.com/content/www/us/en/develop/articles/installing-intel-free-libs-and-python-apt-repo.html
5765
[yum]: https://software.intel.com/content/www/us/en/develop/articles/installing-intel-free-libs-and-python-yum-repo.html

0 commit comments

Comments
 (0)