pytorch/cmake/Modules
Shruti Ramesh f1f3c8b0fa Adding PyTorch + DNNL + AMD BLIS path (#54953)
Summary:
These changes provide the user with an additional option to choose the DNNL+BLIS path for PyTorch.

This assumes BLIS is already downloaded or built from source and the necessary library file is available at the location: $BLIS_HOME/lib/libblis.so and include files are available at: $BLIS_HOME/include/blis/blis.h and $BLIS_HOME/include/blis/cblas.h

Export the below variables to build PyTorch with MKLDNN+BLIS and proceed with the regular installation procedure as below:
$export BLIS_HOME=path-to-BLIS
$export PATH=$BLIS_HOME/include/blis:$PATH LD_LIBRARY_PATH=$BLIS_HOME/lib:$LD_LIBRARY_PATH
$export BLAS=BLIS USE_MKLDNN_CBLAS=ON WITH_BLAS=blis
$python setup.py install

CPU only Dockerfile to build PyTorch with AMD BLIS is available at : docker/cpu-blis/Dockerfile
Example command line to build using the Dockerfile:
sudo DOCKER_BUILDKIT=1 docker build . -t docker-image-repo-name
Example command line to run the built docker container:
sudo docker run --name container-name -it docker-image-repo-name

Fixes #{issue number}

Pull Request resolved: https://github.com/pytorch/pytorch/pull/54953

Reviewed By: glaringlee

Differential Revision: D27466799

Pulled By: malfet

fbshipit-source-id: e03bae9561be3a67429df3b1be95a79005c63050
2021-03-31 10:40:25 -07:00
..
FindARM.cmake Make PyTorch partially cross-compilable for Apple M1 (#49701) 2020-12-22 09:33:12 -08:00
FindAtlas.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindAVX.cmake AVX2 with GCC9 fix. (#18991) 2019-04-07 08:27:00 -07:00
FindBenchmark.cmake cmake: stop including files from the install directory 2017-09-01 23:33:14 -07:00
FindBLAS.cmake Adding PyTorch + DNNL + AMD BLIS path (#54953) 2021-03-31 10:40:25 -07:00
FindBLIS.cmake Adding PyTorch + DNNL + AMD BLIS path (#54953) 2021-03-31 10:40:25 -07:00
FindCUB.cmake Convert all tabs to spaces, add CI. (#18959) 2019-04-09 08:12:26 -07:00
FindFFmpeg.cmake Fix compilation error when buildng with FFMPEG (#27589) 2020-02-13 11:23:48 -08:00
FindGloo.cmake [c10d] NCCL Process Group implementation (#8182) 2018-06-08 10:33:27 -07:00
FindHiredis.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindLAPACK.cmake Fix LAPACK functionality detection from static OpenBLAS (#46710) 2020-10-26 08:34:28 -07:00
FindLevelDB.cmake Initial building with deps 2016-12-13 09:29:01 -05:00
FindLMDB.cmake Added Ninja generator support on Windows 2017-07-26 00:32:20 -07:00
FindMAGMA.cmake Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
FindMatlabMex.cmake Initial building with deps 2016-12-13 09:29:01 -05:00
FindMKL.cmake find mkl installed by nuget (#34031) 2020-03-03 07:44:20 -08:00
FindMKLDNN.cmake Enables build with oneDNN (MKL-DNN) on AArch64 (#50400) 2021-01-13 08:41:44 -08:00
FindNCCL.cmake Fix NCCL version check when nccl.h in non-standard location. (#40982) 2020-07-17 13:54:17 -07:00
FindNuma.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindNumPy.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindOpenBLAS.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindOpenMP.cmake Allow linking against vcomp on Windows (#54132) 2021-03-19 14:36:07 -07:00
Findpybind11.cmake Convert all tabs to spaces, add CI. (#18959) 2019-04-09 08:12:26 -07:00
FindRocksDB.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindSnappy.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindvecLib.cmake Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
FindVSX.cmake Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
FindZMQ.cmake Forbid trailing whitespace (#53406) 2021-03-05 17:22:55 -08:00
README.md Update the cmake build configuration for AppleClang compiler (#15820) 2019-02-04 08:53:47 -08:00

This folder contains various custom cmake modules for finding libraries and packages. Details about some of them are listed below.

FindOpenMP.cmake

This is modified from the file included in CMake 3.13 release, with the following changes:

  • Replace VERSION_GREATER_EQUAL with NOT ... VERSION_LESS as VERSION_GREATER_EQUAL is not supported in CMake 3.5 (our min supported version).

  • Update the separate_arguments commands to not use NATIVE_COMMAND which is not supported in CMake 3.5 (our min supported version).

  • Make it respect the QUIET flag so that, when it is set, try_compile failures are not reported.

  • For AppleClang compilers, use -Xpreprocessor instead of -Xclang as the later is not documented.

  • For AppleClang compilers, an extra flag option is tried, which is -Xpreprocessor -openmp -I${DIR_OF_omp_h}, where ${DIR_OF_omp_h} is a obtained using find_path on omp.h with brew's default include directory as a hint. Without this, the compiler will complain about missing headers as they are not natively included in Apple's LLVM.

  • For non-GNU compilers, whenever we try a candidate OpenMP flag, first try it with directly linking MKL's libomp if it has one. Otherwise, we may end up linking two libomps and end up with this nasty error:

    OMP: Error #15: Initializing libomp.dylib, but found libiomp5.dylib already
    initialized.
    
    OMP: Hint This means that multiple copies of the OpenMP runtime have been
    linked into the program. That is dangerous, since it can degrade performance
    or cause incorrect results. The best thing to do is to ensure that only a
    single OpenMP runtime is linked into the process, e.g. by avoiding static
    linking of the OpenMP runtime in any library. As an unsafe, unsupported,
    undocumented workaround you can set the environment variable
    KMP_DUPLICATE_LIB_OK=TRUE to allow the program to continue to execute, but
    that may cause crashes or silently produce incorrect results. For more
    information, please see http://openmp.llvm.org/
    

    See NOTE [ Linking both MKL and OpenMP ] for details.