From fe809c39f9b3696a45531734e85edd9ff5eb93ff Mon Sep 17 00:00:00 2001 From: Zhang Xianyi Date: Sat, 23 Jun 2012 08:22:53 +0800 Subject: [PATCH] Update the docs for 0.2.0 --- Makefile.rule | 2 +- README => README.md | 80 ++++++++++++++++++++++++++++++----------------------- 2 files changed, 47 insertions(+), 35 deletions(-) rename README => README.md (64%) diff --git a/Makefile.rule b/Makefile.rule index 56cd635..2992737 100644 --- a/Makefile.rule +++ b/Makefile.rule @@ -3,7 +3,7 @@ # # This library's version -VERSION = 0.1.1 +VERSION = 0.2.0 # If you set the suffix, the library name will be libopenblas_$(LIBNAMESUFFIX).a # and libopenblas_$(LIBNAMESUFFIX).so. Meanwhile, the soname in shared library diff --git a/README b/README.md similarity index 64% rename from README rename to README.md index b3f1baa..000bc41 100644 --- a/README +++ b/README.md @@ -1,34 +1,41 @@ -OpenBLAS Readme +# OpenBLAS -1.Introduction -OpenBLAS is an optimized BLAS library based on GotoBLAS2 1.13 BSD version. OpenBLAS is an open source project supported by Lab of Parallel Software and Computational Science, ISCAS.(http://www.rdcps.ac.cn) -Please read the documents on OpenBLAS wiki pages(http://github.com/xianyi/OpenBLAS/wiki). +## Introduction +OpenBLAS is an optimized BLAS library based on GotoBLAS2 1.13 BSD version. OpenBLAS is an open source project supported by Lab of Parallel Software and Computational Science, ISCAS . -2.Intallation +Please read the documents on OpenBLAS wiki pages. + +## Intallation Download from project homepage. http://xianyi.github.com/OpenBLAS/ Or, check out codes from git://github.com/xianyi/OpenBLAS.git -1)Normal compile - (a) type "make" to detect the CPU automatically. +### Normal compile + * type "make" to detect the CPU automatically. or - (b) type "make TARGET=xxx" to set target CPU, e.g. "make TARGET=NEHALEM". The full target list is in file TargetList.txt. + * type "make TARGET=xxx" to set target CPU, e.g. "make TARGET=NEHALEM". The full target list is in file TargetList.txt. -2)Cross compile +### Cross compile Please set CC and FC with the cross toolchains. Then, set HOSTCC with your host C compiler. At last, set TARGET explicitly. -examples: +Examples: + On X86 box, compile this library for loongson3a CPU. -make BINARY=64 CC=mips64el-unknown-linux-gnu-gcc FC=mips64el-unknown-linux-gnu-gfortran HOSTCC=gcc TARGET=LOONGSON3A -3)Debug version -make DEBUG=1 + make BINARY=64 CC=mips64el-unknown-linux-gnu-gcc FC=mips64el-unknown-linux-gnu-gfortran HOSTCC=gcc TARGET=LOONGSON3A + +### Debug version + + make DEBUG=1 + +### Intall to the directory (Optional) + +Example: + + make install PREFIX=your_installation_directory -4)Intall to the directory (Optional) -e.g. -make install PREFIX=your_installation_directory The default directory is /opt/OpenBLAS -3.Support CPU & OS +## Support CPU & OS Please read GotoBLAS_01Readme.txt Additional support CPU: @@ -39,45 +46,50 @@ MIPS64: ICT Loongson 3A ICT Loongson 3B (Experimental) -4.Usages +## Usages Link with libopenblas.a or -lopenblas for shared library. -4.1 Set the number of threads with environment variables. for example, -export OPENBLAS_NUM_THREADS=4 +### Set the number of threads with environment variables. + +Examples: + export OPENBLAS_NUM_THREADS=4 + or -export GOTO_NUM_THREADS=4 + + export GOTO_NUM_THREADS=4 + or -export OMP_NUM_THREADS=4 + + export OMP_NUM_THREADS=4 The priorities are OPENBLAS_NUM_THREADS > GOTO_NUM_THREADS > OMP_NUM_THREADS. If you compile this lib with USE_OPENMP=1, you should set OMP_NUM_THREADS environment variable. OpenBLAS ignores OPENBLAS_NUM_THREADS and GOTO_NUM_THREADS with USE_OPENMP=1. -4.2 Set the number of threads with calling functions. for example, -void goto_set_num_threads(int num_threads); -or -void openblas_set_num_threads(int num_threads); +### Set the number of threads with calling functions. + +Examples: + void goto_set_num_threads(int num_threads); + void openblas_set_num_threads(int num_threads); If you compile this lib with USE_OPENMP=1, you should use the above functions, too. -5.Report Bugs +## Report Bugs Please add a issue in https://github.com/xianyi/OpenBLAS/issues -6.To-Do List: -Optimization on ICT Loongson 3A CPU - -7.Contact +## Contact OpenBLAS users mailing list: http://list.rdcps.ac.cn/mailman/listinfo/openblas -8.ChangeLog +## ChangeLog Please see Changelog.txt to obtain the differences between GotoBLAS2 1.13 BSD version. -9.Troubleshooting +## Troubleshooting +* Please use gcc version 4.6 and above to compile Sandy Bridge AVX kernels on Linux/MingW/BSD. * Please use Clang version 3.1 and above to compile the library on Sandy Bridge microarchitecture. The Clang 3.0 will generate the wrong AVX binary code. * The number of CPUs/Cores should less than or equal to 256. * On Loongson 3A. make test would be failed because of pthread_create error. The error code is EAGAIN. However, it will be OK when you run the same testcase on shell. -10. Specification of Git Branches +## Specification of Git Branches We used the git branching model in this article (http://nvie.com/posts/a-successful-git-branching-model/). Now, there are 4 branches in github.com. * The master branch. This a main branch to reflect a production-ready state. -- 2.7.4