changing markdown to rst format (#259)
* changing markdown extension to rst extension * updating callback services * updating all services, ssamples and installtion * Fix build * More fixes * more fixes * minor fixes * more fixes * merging changes for SWDEV-510794 from pr 227
This commit is contained in:
Bhardwaj, Gopesh
GitHub
@@ -1,80 +0,0 @@
|
||||
---
|
||||
myst:
|
||||
html_meta:
|
||||
"description": "ROCprofiler-SDK is a tooling infrastructure for profiling general-purpose GPU compute applications running on the ROCm software."
|
||||
"keywords": "Installing ROCprofiler-SDK, Install ROCprofiler-SDK, Build ROCprofiler-SDK"
|
||||
---
|
||||
|
||||
# ROCprofiler-SDK installation
|
||||
|
||||
This document provides information required to install ROCprofiler-SDK from source.
|
||||
|
||||
## Supported systems
|
||||
|
||||
ROCprofiler-SDK is supported only on Linux. The following distributions are tested:
|
||||
|
||||
- Ubuntu 20.04
|
||||
- Ubuntu 22.04
|
||||
- OpenSUSE 15.4
|
||||
- RedHat 8.8
|
||||
|
||||
ROCprofiler-SDK might operate as expected on other [Linux distributions](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html#supported-operating-systems), but has not been tested.
|
||||
|
||||
### Identifying the operating system
|
||||
|
||||
To identify the Linux distribution and version, see the `/etc/os-release` and `/usr/lib/os-release` files:
|
||||
|
||||
```shell
|
||||
$ cat /etc/os-release
|
||||
NAME="Ubuntu"
|
||||
VERSION="20.04.4 LTS (Focal Fossa)"
|
||||
ID=ubuntu
|
||||
...
|
||||
VERSION_ID="20.04"
|
||||
...
|
||||
```
|
||||
|
||||
The relevant fields are `ID` and the `VERSION_ID`.
|
||||
|
||||
## Build requirements
|
||||
|
||||
Install [CMake](https://cmake.org/) version 3.21 (or later).
|
||||
|
||||
:::{note}
|
||||
If the `CMake` installed on the system is too old, you can install a new version using various methods. One of the easiest options is to use PyPi (Python’s pip).
|
||||
:::
|
||||
|
||||
```bash
|
||||
pip install --user 'cmake==3.22.0'
|
||||
export PATH=${HOME}/.local/bin:${PATH}
|
||||
```
|
||||
|
||||
## Building ROCprofiler-SDK
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ROCm/rocprofiler-sdk.git rocprofiler-sdk-source
|
||||
cmake \
|
||||
-B rocprofiler-sdk-build \
|
||||
-D ROCPROFILER_BUILD_TESTS=ON \
|
||||
-D ROCPROFILER_BUILD_SAMPLES=ON \
|
||||
-D CMAKE_INSTALL_PREFIX=/opt/rocm \
|
||||
rocprofiler-sdk-source
|
||||
|
||||
cmake --build rocprofiler-sdk-build --target all --parallel 8
|
||||
```
|
||||
|
||||
## Installing ROCprofiler-SDK
|
||||
|
||||
To install ROCprofiler-SDK from the `rocprofiler-sdk-build` directory, run:
|
||||
|
||||
```bash
|
||||
cmake --build rocprofiler-sdk-build --target install
|
||||
```
|
||||
|
||||
## Testing ROCprofiler-SDK
|
||||
|
||||
To run the built tests, `cd` into the `rocprofiler-sdk-build` directory and run:
|
||||
|
||||
```bash
|
||||
ctest --output-on-failure -O ctest.all.log
|
||||
```
|
||||
@@ -0,0 +1,98 @@
|
||||
.. ---
|
||||
.. myst:
|
||||
.. html_meta:
|
||||
.. "description": "ROCprofiler-SDK is a tooling infrastructure for profiling general-purpose GPU compute applications running on the ROCm software."
|
||||
.. "keywords": "Installing ROCprofiler-SDK, Install ROCprofiler-SDK, Build ROCprofiler-SDK"
|
||||
.. ---
|
||||
|
||||
ROCprofiler-SDK installation
|
||||
============================
|
||||
|
||||
This document provides information required to install ROCprofiler-SDK from source.
|
||||
|
||||
Supported systems
|
||||
-----------------
|
||||
|
||||
ROCprofiler-SDK is supported only on Linux. The following distributions are tested:
|
||||
|
||||
- Ubuntu 20.04
|
||||
- Ubuntu 22.04
|
||||
- OpenSUSE 15.4
|
||||
- RedHat 8.8
|
||||
|
||||
ROCprofiler-SDK might operate as expected on other `Linux distributions <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html#supported-operating-systems>`_, but has not been tested.
|
||||
|
||||
Identifying the operating system
|
||||
--------------------------------
|
||||
|
||||
To identify the Linux distribution and version, see the ``/etc/os-release`` and ``/usr/lib/os-release`` files:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ cat /etc/os-release
|
||||
NAME="Ubuntu"
|
||||
VERSION="20.04.4 LTS (Focal Fossa)"
|
||||
ID=ubuntu
|
||||
...
|
||||
VERSION_ID="20.04"
|
||||
...
|
||||
|
||||
The relevant fields are ``ID`` and the ``VERSION_ID``.
|
||||
|
||||
Build requirements
|
||||
------------------
|
||||
|
||||
Install CMake
|
||||
==============
|
||||
|
||||
Install `CMake <https://cmake.org/>`_ version 3.21 (or later).
|
||||
|
||||
.. note::
|
||||
If the ``CMake`` installed on the system is too old, you can install a new version using various methods. One of the easiest options is to use PyPi (Python's pip).
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
/usr/local/bin/python -m pip install --user 'cmake==3.22.0'
|
||||
export PATH=${HOME}/.local/bin:${PATH}
|
||||
|
||||
|
||||
Building ROCprofiler-SDK
|
||||
------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/ROCm/rocprofiler-sdk.git rocprofiler-sdk-source
|
||||
cmake \
|
||||
-B rocprofiler-sdk-build \
|
||||
-D ROCPROFILER_BUILD_TESTS=ON \
|
||||
-D ROCPROFILER_BUILD_SAMPLES=ON \
|
||||
-D CMAKE_INSTALL_PREFIX=/opt/rocm \
|
||||
rocprofiler-sdk-source
|
||||
|
||||
cmake --build rocprofiler-sdk-build --target all --parallel 8
|
||||
|
||||
Installing ROCprofiler-SDK
|
||||
--------------------------
|
||||
|
||||
To install ROCprofiler-SDK from the ``rocprofiler-sdk-build`` directory, run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cmake --build rocprofiler-sdk-build --target install
|
||||
|
||||
Testing ROCprofiler-SDK
|
||||
-----------------------
|
||||
|
||||
To run the built tests, ``cd`` into the ``rocprofiler-sdk-build`` directory and run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
ctest --output-on-failure -O ctest.all.log
|
||||
|
||||
|
||||
.. note::
|
||||
Running a few of these tests require you to install `pandas <https://pandas.pydata.org/>`_ and `pytest <https://docs.pytest.org/en/stable/>`_ first.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
/usr/local/bin/python -m pip install -r requirements.txt
|
||||
مرجع در شماره جدید
Block a user