Skip to content

Commit

Permalink
update rocBLAS docs for changes to ROCm documentation (#2021)
Browse files Browse the repository at this point in the history
* update documentation for changes to ROCm documentation

* improve instructions for specific architecture
  • Loading branch information
amcamd authored Aug 25, 2023
1 parent 328f824 commit 3356c80
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 21 deletions.
26 changes: 8 additions & 18 deletions docs/Linux_Install_Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,8 @@ Installation and Building for Linux
Prerequisites
-------------

- A ROCm enabled platform. More information in `ROCm Documentation <https://docs.amd.com/>`_. To build ROCm from the source, follow the previous link and navigate to How to install ROCm. This page will provide steps to install ROCm for specific operating systems. After following these steps to download the installer amdgpu-install, use the below command to install ROCm.

::

sudo amdgpu-install --usecase=rocm

- rocBLAS is supported on the same Linux versions that are supported by ROCm
- A ROCm enabled platform. `ROCm Documentation <https://docs.amd.com/>`_ has more information on
supported GPUs, Linux distributions, and Windows SKU. It also has information on how to install ROCm.


----------------------------
Expand Down Expand Up @@ -45,9 +40,8 @@ The rocblas.h header file must be included in the user code to make calls
into rocBLAS, and the rocBLAS shared library will become link-time and run-time
dependent for the user application.

Once installed, find rocblas.h and rocblas_module.f90 in the /opt/rocm/include
directory. Only use these two installed files when needed in user code.
Find other rocBLAS files in /opt/rocm/include/internal, However, do not include these files directly.
The header files rocblas.h and rocblas_module.f90 are installed in /opt/rocm/include/rocblas.
The library file librocblas.so is installed in /opt/rocm/lib.


-------------------------------
Expand All @@ -56,19 +50,15 @@ Building and Installing rocBLAS

For most users, building from source is not necessary, as rocBLAS can be used after installing the prebuilt
packages as described above. If desired, users can use following instructions to build rocBLAS from source.
Note the change in the --usecase command argument below to install the base ROCm developer stack in-order to build rocBLAS from the source.

::

sudo amdgpu-install --usecase=rocmdev


Requirements
^^^^^^^^^^^^

As a rule, 64GB of system memory is required for a full rocBLAS build. This value can be lower if
rocBLAS is built with a different Tensile logic target (see the --logic command for ./install.sh). This value
may also increase in the future as more functions are added to rocBLAS and dependencies such as Tensile grow.
As a rule, 64GB of system memory is required for a full rocBLAS fat binary build. This value can be lower if
rocBLAS is built for specific architectures using the -a option to install.sh. More information is available
from ./install.sh --help.



Download rocBLAS
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use of Tensile

The rocBLAS library internally uses
`Tensile <https://github.com/ROCmSoftwarePlatform/Tensile>`__, which
supplies the high-performance implementation of xGEMM. It requires no separate installation as it is installed as part of the rocBLAS package.
If building rocBLAS library CMake downloads Tensile during library configuration and automatically
supplies the high-performance implementation of GEMM. It requires no separate installation as it is installed as part of the rocBLAS package.
rocBLAS uses CMake for build automation, and CMake downloads Tensile during library configuration and automatically
configures it as part of the build, so no further action is required by the
user to set it up. No external facing API for Tensile is provided.
2 changes: 1 addition & 1 deletion rmake.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def parse_args():
experimental_opts = parser.add_argument_group('Experimental Build Options')

general_opts.add_argument('-a', '--architecture', dest='gpu_architecture', required=False, default="all",
help='Set GPU architectures, e.g. all, auto, "gfx900;gfx906:xnack-", gfx1030, gfx1101 (optional, default: all)')
help='Set GPU architectures, e.g. all, auto, "gfx900;gfx906:xnack-", gfx1030 (optional, default: all, recommended: auto, builds for architecture detected on the build machine)')

experimental_opts.add_argument( '--address-sanitizer', dest='address_sanitizer', required=False, default=False, action='store_true',
help='Build with address sanitizer enabled. (optional, default: False')
Expand Down

0 comments on commit 3356c80

Please sign in to comment.