Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ye-luo committed Mar 12, 2023
1 parent 2441f2a commit 2923efb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,14 @@ make -j 8
ENABLE_OFFLOAD ON/OFF(default). Enable OpenMP target offload for GPU acceleration.
ENABLE_CUDA ON/OFF(default). Enable CUDA code path for NVIDIA GPU acceleration.
Production quality for AFQMC and real-space performance portable implementation.
Use CMAKE_CUDA_ARCHITECTURES, default 70, to select the actual GPU architecture.
QMC_CUDA2HIP ON/OFF(default). Map all CUDA kernels and library calls to HIP and use ROCm libraries.
Set both ENABLE_CUDA and QMC_CUDA2HIP ON to target AMD GPUs.
Use CMAKE_HIP_ARCHITECTURES, default gfx906, to select the actual GPU architecture.
ENABLE_SYCL ON/OFF(default). Enable SYCL code path. Only support Intel GPUs and OneAPI compilers.
QMC_GPU_ARCHS Specify GPU architectures. For example, "gfx90a" targets AMD MI200 series GPUs.
"sm_80;sm_70" creates a single executable running on both NVIDIA A100 and V100 GPUs.
Mixing vendor "gfx90a;sm_70" is not supported. If not set, atempt to derive it
from CMAKE_CUDA_ARCHITECTURES or CMAKE_HIP_ARCHITECTURES if available and then
atempt to auto-detect existing GPUs.
```

Expand Down
11 changes: 7 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -290,11 +290,14 @@ the path to the source directory.
ENABLE_OFFLOAD ON/OFF(default). Enable OpenMP target offload for GPU acceleration.
ENABLE_CUDA ON/OFF(default). Enable CUDA code path for NVIDIA GPU acceleration.
Production quality for AFQMC and real-space performance portable implementation.
Use CMAKE_CUDA_ARCHITECTURES, default 70, to select the actual GPU architecture.
QMC_CUDA2HIP ON/OFF(default). Map all CUDA kernels and library calls to HIP and use ROCm libraries.
Set both ENABLE_CUDA and QMC_CUDA2HIP ON to target AMD GPUs.
Use CMAKE_HIP_ARCHITECTURES, default gfx906, to select the actual GPU architecture.
ENABLE_SYCL ON/OFF(default). Enable SYCL code path. Only support Intel GPUs and OneAPI compilers.
QMC_GPU_ARCHS Specify GPU architectures. For example, "gfx90a" targets AMD MI200 series GPUs.
"sm_80;sm_70" creates a single executable running on both NVIDIA A100 and V100 GPUs.
Mixing vendor "gfx90a;sm_70" is not supported. If not set, atempt to derive it
from CMAKE_CUDA_ARCHITECTURES or CMAKE_HIP_ARCHITECTURES if available and then
atempt to auto-detect existing GPUs.

- General build options

Expand Down Expand Up @@ -451,13 +454,13 @@ For example, using Clang 14 on Summit.

::
-D ENABLE_OFFLOAD=ON -D ENABLE_CUDA=ON -D CMAKE_CUDA_ARCHITECTURES=70
-D ENABLE_OFFLOAD=ON -D ENABLE_CUDA=ON -D QMC_GPU_ARCHS=sm_80

Similarly, HIP features can be enabled in conjunction with the offload code path to improve performance on AMD GPUs.

::

-D ENABLE_OFFLOAD=ON -D ENABLE_CUDA=ON -D QMC_CUDA2HIP=ON -DCMAKE_HIP_ARCHITECTURES=gfx906
-D ENABLE_OFFLOAD=ON -D ENABLE_CUDA=ON -D QMC_CUDA2HIP=ON -D QMC_GPU_ARCHS=gfx90a

Similarly, SYCL features can be enabled in conjunction with the offload code path to improve performance on Intel GPUs.

Expand Down

0 comments on commit 2923efb

Please sign in to comment.