AI/rocm-systems
2
0
Forkuj 0
Kod Zgłoszenia Oczekujące zmiany Actions Packages Projekty Wydania Wiki Aktywność

SWDEV-464475 - Add linting and spellcheck

Przeglądaj źródła 
- Markdown fixes
- Fix spellcheck
- Clean up
- Supress etoc warning
- Remove folder before clone if it's exist
- Change liniting.yml to use develop
- Trailing white space fix

Change-Id: Ib3bb2cdd0abebeb21071b5d2e2d3b57fe41666e0
This commit is contained in:
Istvan Kiss
2024-05-28 18:42:08 +02:00
zatwierdzone przez Istvan Kiss
rodzic 87ee9b28a4
commit bd624d0938
24 zmienionych plików z 986 dodań i 712 usunięć
Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files
docs/install/build.rst
+18 -18
Wyświetl plik
@@ -8,16 +8,16 @@ Prerequisites
HIP code can be developed either on AMD ROCm platform using HIP-Clang compiler, or a CUDA platform with ``nvcc`` installed.
Before building and running HIP, make sure drivers and prebuilt packages are installed properly on the platform.
You also need to install Python 3, which includes the ``CppHeaderParser`` package.
You also need to install Python 3, which includes the ``CppHeaderParser`` package.
Install Python 3 using the following command:
.. code:: shell
.. code-block:: shell
apt-get install python3
Check and install ``CppHeaderParser`` package using the command:
.. code:: shell
.. code-block:: shell
pip3 install CppHeaderParser
@@ -29,7 +29,7 @@ Building the HIP runtime
Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for ROCm 6.1, use:
.. code:: shell
.. code-block:: shell
export ROCM_BRANCH=rocm-6.1.x
@@ -49,7 +49,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
``hipother`` provides files required to support the HIP back-end implementation on some non-AMD platforms,
like NVIDIA.
.. code:: shell
.. code-block:: shell
git clone -b "$ROCM_BRANCH" https://github.com/ROCm/clr.git
git clone -b "$ROCM_BRANCH" https://github.com/ROCm/hip.git
@@ -66,7 +66,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
#. Set the environment variables.
.. code:: shell
.. code-block:: shell
export CLR_DIR="$(readlink -f clr)"
export HIP_DIR="$(readlink -f hip)"
@@ -74,7 +74,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
#. Build HIP.
.. code:: shell
.. code-block:: shell
cd "$CLR_DIR"
mkdir -p build; cd build
@@ -116,7 +116,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
Usage:
.. code:: shell
.. code-block:: shell
`hip_prof_gen.py [-v] <input HIP API .h file> <patched srcs path> <previous output> [<output>]`
@@ -131,7 +131,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
Example usage:
.. code:: shell
.. code-block:: shell
hip_prof_gen.py -v -p -t --priv <hip>/include/hip/hip_runtime_api.h \
<hipamd>/src <hipamd>/include/hip/amd_detail/hip_prof_str.h \
@@ -142,7 +142,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
#. Get the HIP source code.
.. code:: shell
.. code-block:: shell
git clone -b "$ROCM_BRANCH" https://github.com/ROCm/clr.git
git clone -b "$ROCM_BRANCH" https://github.com/ROCm/hip.git
@@ -150,7 +150,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
#. Set the environment variables.
.. code:: shell
.. code-block:: shell
export CLR_DIR="$(readlink -f clr)"
export HIP_DIR="$(readlink -f hip)"
@@ -158,7 +158,7 @@ Set the repository branch using the variable: ``ROCM_BRANCH``. For example, for
#. Build HIP.
.. code:: shell
.. code-block:: shell
cd "$CLR_DIR"
mkdir -p build; cd build
@@ -180,18 +180,18 @@ Build HIP tests
* Get HIP tests source code.
.. code:: shell
.. code-block:: shell
git clone -b "$ROCM_BRANCH" https://github.com/ROCm/hip-tests.git
* Build HIP tests from source.
.. code:: shell
.. code-block:: shell
export HIPTESTS_DIR="$(readlink -f hip-tests)"
cd "$HIPTESTS_DIR"
mkdir -p build; cd build
cmake ../catch -DHIP_PLATFORM=amd -DHIP_PATH=$CLR_DIR/build/install # or any path where HIP is installed; for example: ``/opt/rocm``
cmake ../catch -DHIP_PLATFORM=amd -DHIP_PATH=$CLR_DIR/build/install # or any path where HIP is installed; for example: ``/opt/rocm``
make build_tests
ctest # run tests
@@ -199,14 +199,14 @@ Build HIP tests
To run any single catch test, use this example:
.. code:: shell
.. code-block:: shell
cd $HIPTESTS_DIR/build/catch_tests/unit/texture
./TextureTest
* Build a HIP Catch2 standalone test.
.. code:: shell
.. code-block:: shell
cd "$HIPTESTS_DIR"
hipcc $HIPTESTS_DIR/catch/unit/memory/hipPointerGetAttributes.cc \
@@ -227,5 +227,5 @@ Build HIP tests
Run HIP
=================================================
After installation and building HIP, you can compile your application and run.
After installation and building HIP, you can compile your application and run.
A simple example is `square sample <https://github.com/ROCm/hip-tests/tree/develop/samples/0_Intro/square>`_.
docs/install/install.rst
+4 -4
Wyświetl plik
@@ -2,7 +2,7 @@
Install HIP
*******************************************
HIP can be installed on AMD (ROCm with HIP-Clang) and NVIDIA (CUDA with nvcc) platforms.
HIP can be installed on AMD (ROCm with HIP-Clang) and NVIDIA (CUDA with NVCC) platforms.
Note: The version definition for the HIP runtime is different from CUDA. On an AMD platform, the
``hipRuntimeGerVersion`` function returns the HIP runtime version; on an NVIDIA platform, this function
@@ -48,7 +48,7 @@ Installation
#. Install the NVIDIA driver.
.. code:: shell
.. code-block:: shell
sudo apt-get install ubuntu-drivers-common && sudo ubuntu-drivers autoinstall
sudo reboot
@@ -59,7 +59,7 @@ Installation
#. Install the ``hip-runtime-nvidia`` and ``hip-dev`` packages. This installs the CUDA SDK and HIP
porting layer.
.. code:: shell
.. code-block:: shell
apt-get install hip-runtime-nvidia hip-dev
@@ -74,6 +74,6 @@ Verify your installation
Run ``hipconfig`` in your installation path.
.. code:: shell
.. code-block:: shell
/opt/rocm/bin/hipconfig --full