Skip to content

Commit 54f305c

Browse files
authored
Merge pull request #1454 from daineAMD/62docs
Small cleanup of install docs (#2613)
2 parents acdce9e + c3b49b9 commit 54f305c

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/install/Linux_Install_Guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,14 @@ For Centos, use:
9696
yum info rocm-libs
9797

9898
The ROCm version has major, minor, and patch fields, possibly followed by a build specific identifier. For example, ROCm version could be 4.0.0.40000-23; this corresponds to major = 4, minor = 0, patch = 0, build identifier 40000-23.
99-
There are GitHub branches at the rocBLAS site with names rocm-major.minor.x where major and minor are the same as in the ROCm version. For ROCm version 4.0.0.40000-23, you must use the following to download rocBLAS:
99+
There are GitHub branches at the rocBLAS site with names rocm-major.minor.x where major and minor are the same as in the ROCm version. To download rocBLAS, you can use the following command:
100100

101101
::
102102

103103
git clone -b release/rocm-rel-x.y https://github.com/ROCm/rocBLAS.git
104104
cd rocBLAS
105105

106-
Replace x.y in the above command with the version of ROCm installed on your machine. For example, if you have ROCm 5.0 installed, then replace release/rocm-rel-x.y with release/rocm-rel-5.0.
106+
Replace x.y in the above command with the version of ROCm installed on your machine. For example, if you have ROCm 6.2 installed, then replace release/rocm-rel-x.y with release/rocm-rel-6.2.
107107

108108

109109
Below are steps to build using ``install.sh`` script. The user can build either:
@@ -122,7 +122,7 @@ CMake has a minimum version requirement listed in the file ``install.sh``. See `
122122

123123
Dependencies are listed in the script ``install.sh``. Passing the ``-d`` flag to ``install.sh`` installs the dependencies.
124124

125-
However, for the test and benchmark clients' host reference BLAS, it is recommended that you manually download and install AMD's ILP64 version of AOCL-BLAS 4.1 or 4.0 from https://www.amd.com/en/developer/aocl.html.
125+
However, for the test and benchmark clients' host reference BLAS, it is recommended that you manually download and install AMD's ILP64 version of AOCL-BLAS 4.2 gcc from https://www.amd.com/en/developer/aocl.html.
126126
If you download and install the full AOCL packages into their default locations, or only download the BLIS archive files and extract into the build directory deps subfolder, then this reference BLAS should be found
127127
by the clients ``CMakeLists.txt``. Note, if you only use the ``install.sh -d`` dependency script based BLIS download and install, you may experience ``rocblas-test`` stress test failures due to 32-bit integer overflow on the host unless you exclude the stress tests via command line argument ``--gtest_filter=-*stress*``.
128128

docs/install/Windows_Install_Guide.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ dependencies for your application.
5656
or can be located elsewhere if setting the environment variable ``ROCBLAS_TENSILE_LIBPATH`` to the
5757
non-standard location. The contents are read at execution time much like additional DLL files.
5858

59-
Once installed, find ``rocblas.h`` in the HIP SDK ``\\include\\rocblas``
59+
Once installed, find ``rocblas.h`` in the HIP SDK ``\include\rocblas``
6060
directory. Only use these two installed files when needed in user code.
61-
Find other rocBLAS included files in HIP SDK ``\\include\\rocblas\\internal``, however,
61+
Find other rocBLAS included files in HIP SDK ``\include\rocblas\internal``, however,
6262
do not include these files directly into source code.
6363

6464
===============================
@@ -82,9 +82,9 @@ may also increase in the future as more functions are added to rocBLAS and depen
8282
Download rocBLAS
8383
----------------
8484

85-
The rocBLAS source code, which is the same as for the ROCm linux distributions, is available at the `rocBLAS github page <https://github.com/ROCmSoftwarePlatform/rocBLAS>`_.
85+
The rocBLAS source code, which is the same as for the ROCm linux distributions, is available at the `rocBLAS github page <https://github.com/ROCm/rocBLAS>`_.
8686
The version of the ROCm HIP SDK may be shown in the path of default installation, but
87-
you can run the HIP SDK compiler to report the verison from the bin/ folder with:
87+
you can run the HIP SDK compiler to report the verison from the ``bin\`` folder with:
8888

8989
::
9090

@@ -97,11 +97,11 @@ For example for you can use the following to download rocBLAS:
9797

9898
::
9999

100-
git clone -b release/rocm-rel-x.y https://github.com/ROCmSoftwarePlatform/rocBLAS.git
100+
git clone -b release/rocm-rel-x.y https://github.com/ROCm/rocBLAS.git
101101
cd rocBLAS
102102

103103
Replace x.y in the above command with the version of HIP SDK installed on your machine. For example, if you have HIP 5.5 installed, then use ``-b release/rocm-rel-5.5``
104-
You can can add the SDK tools to your path with an entry like:
104+
You can add the SDK tools to your path with an entry like:
105105

106106
::
107107

@@ -125,19 +125,19 @@ Library Dependencies
125125

126126
Dependencies installed by the python script rdeps.py are listed in the rdeps.xml configuration file. The -d flag passed to rmake.py installs dependencies the same as if
127127
running ``rdeps.py`` directly.
128-
Currently ``rdeps.py`` uses ``vcpkg`` and ``pip`` to install the build dependencies, with ``vcpkg`` being cloned into environment variable ``VCPKG_PATH`` or defaults into ``C:\\github\\vckpg``.
128+
Currently ``rdeps.py`` uses ``vcpkg`` and ``pip`` to install the build dependencies, with ``vcpkg`` being cloned into environment variable ``VCPKG_PATH`` or defaults into ``C:\github\vckpg``.
129129
``pip`` will install into your current python3 environment.
130130

131131
The minimum version requirement for CMake is listed in the top level ``CMakeLists.txt`` file. CMake installed with Visual Studio 2022 meets this requirement.
132132
The ``vcpkg`` version tag is specified at the top of the ``rdeps.py`` file.
133133

134134
However, for the test and benchmark clients' host reference BLAS, it is recommended that you manually download and install AMD's ILP64 version of AOCL-BLAS 4.2 from https://www.amd.com/en/developer/aocl.html.
135-
If you download and run the full Windows AOCL installer into the default locations ( `C:\Program Files\AMD\AOCL-Windows\` ) then the AOCL reference BLAS (amd-blis) should be found
135+
If you download and run the full Windows AOCL installer into the default locations ( ``C:\Program Files\AMD\AOCL-Windows\`` ) then the AOCL reference BLAS (amd-blis) should be found
136136
by the clients CMakeLists.txt.
137137

138138
.. note::
139139
If instead of the AOCL reference library you use OpenBLAS with vcpkg from rdeps.py you may experience `rocblas-test` stress test failures due to 32-bit integer overflow
140-
on the host reference code unless you exclude the ILP64 stress tests via command line argument `--gtest_filter=-*I64*`.
140+
on the host reference code unless you exclude the ILP64 stress tests via command line argument `--gtest_filter=-*stress*`.
141141

142142

143143
Build Library dependencies + Library
@@ -242,7 +242,7 @@ Build Clients without Library
242242
The rocBLAS clients can be built on their own using ``rmake.py`` with a pre-existing rocBLAS library.
243243

244244
Note that the version of the rocBLAS clients being built should match the version of the installed rocBLAS.
245-
You can determine the version of the installed rocBLAS in the HIP SDK directory from the file ``include\\rocblas\\internal\\rocblas-version.h``.
245+
You can determine the version of the installed rocBLAS in the HIP SDK directory from the file ``include\rocblas\internal\rocblas-version.h``.
246246
Find the version of rocBLAS being built if you have grep (e.g. in a git bash) with command ``grep "VERSION_STRING" CMakeLists.txt`` in the rocBLAS directory where you are building the clients.
247247

248248
.. tabularcolumns::

0 commit comments

Comments
 (0)